Class: ContextDev::Models::WebExtractResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/context_dev/models/web_extract_response.rb,
sig/context_dev/models/web_extract_response.rbs

Overview

See Also:

  • ContextDev::Resources::Web#extract

Defined Under Namespace

Classes: KeyMetadata, Metadata

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(max_crawl_depth:, num_blocked:, num_failed:, num_skipped:, num_succeeded:, num_urls:) ⇒ Object

Some parameter documentations has been truncated, see Metadata for more details.

Parameters:

  • max_crawl_depth (Integer)
  • num_blocked (Integer) —

    Number of crawled pages excluded because they were anti-bot challenges, error pa

  • num_failed (Integer)
  • num_skipped (Integer)
  • num_succeeded (Integer)
  • num_urls (Integer) 



# File 'lib/context_dev/models/web_extract_response.rb', line 43

Instance Attribute Details

#data ⇒ Hash{Symbol=>Object}

Extracted data matching the request schema

Parameters:

  • value (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}) 


11
 
# File 'lib/context_dev/models/web_extract_response.rb', line 11

required :data, ContextDev::Internal::Type::HashOf[ContextDev::Internal::Type::Unknown]

#key_metadata ⇒ ContextDev::Models::WebExtractResponse::KeyMetadata?

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.

Returns:



41
 
# File 'lib/context_dev/models/web_extract_response.rb', line 41

optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata }

#metadata ⇒ ContextDev::Models::WebExtractResponse::Metadata

Parameters:

Returns:



16
 
# File 'lib/context_dev/models/web_extract_response.rb', line 16

required :metadata, -> { ContextDev::Models::WebExtractResponse::Metadata }

#status ⇒ String

Status of the response, e.g., 'ok'

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/context_dev/models/web_extract_response.rb', line 22

required :status, String

#url ⇒ String

The starting URL that was analyzed

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/context_dev/models/web_extract_response.rb', line 28

required :url, String

#urls_analyzed ⇒ Array<String>

List of URLs whose Markdown was used for extraction

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


34
 
# File 'lib/context_dev/models/web_extract_response.rb', line 34

required :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/context_dev/models/web_extract_response.rbs', line 39

def to_hash: -> {