Class: ContextDev::Models::WebExtractResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ContextDev::Models::WebExtractResponse

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: CacheMetadata, KeyMetadata, Metadata

Instance Attribute Summary

• #cache_metadata ⇒ ContextDev::Models::WebExtractResponse::CacheMetadata

  Cache outcome for this response.

• #data ⇒ Hash{Symbol=>Object}

  Extracted data matching the request schema.

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

  Metadata about the API key used for the request.

• #metadata ⇒ ContextDev::Models::WebExtractResponse::Metadata
• #status ⇒ String

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

• #url ⇒ String

  The starting URL that was analyzed.

• #urls_analyzed ⇒ Array<String>

  List of URLs whose Markdown was used for extraction.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(cache_metadata:, data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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(cache_metadata:, data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see ContextDev::Models::WebExtractResponse for more details.

Parameters:

• cache_metadata (ContextDev::Models::WebExtractResponse::CacheMetadata) —

  Cache outcome for this response. Composite responses are hits only when every ca

• data (Hash{Symbol=>Object}) —

  Extracted data matching the request schema

• metadata (ContextDev::Models::WebExtractResponse::Metadata)
• status (String) —

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

• url (String) —

  The starting URL that was analyzed

• urls_analyzed (Array<String>) —

  List of URLs whose Markdown was used for extraction

• key_metadata (ContextDev::Models::WebExtractResponse::KeyMetadata) (defaults to: nil) —

  Metadata about the API key used for the request. Included in every response when

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

Instance Attribute Details

#cache_metadata ⇒ ContextDev::Models::WebExtractResponse::CacheMetadata

Cache outcome for this response. Composite responses are hits only when every cache-controlled fetch contributing to the output was a hit; age_ms is the oldest contributing hit.

Parameters:

• value (ContextDev::Models::WebExtractResponse::CacheMetadata)

Returns:

• (ContextDev::Models::WebExtractResponse::CacheMetadata)

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

required :cache_metadata, -> { ContextDev::Models::WebExtractResponse::CacheMetadata }

#data ⇒ Hash{Symbol=>Object}

Extracted data matching the request schema

Parameters:

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

Returns:

• (Hash{Symbol=>Object})

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

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:

• (ContextDev::Models::WebExtractResponse::KeyMetadata, nil)

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

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

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

Parameters:

• value (ContextDev::Models::WebExtractResponse::Metadata)

Returns:

• (ContextDev::Models::WebExtractResponse::Metadata)

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

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

#status ⇒ String

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

Parameters:

• value (String)

Returns:

• (String)

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

required :status, String

#url ⇒ String

The starting URL that was analyzed

Parameters:

• value (String)

Returns:

• (String)

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

required :url, String

#urls_analyzed ⇒ Array<String>

List of URLs whose Markdown was used for extraction

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {