Class: ContextDev::Models::WebSearchResponse

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/context_dev/models/web_search_response.rb,
sig/context_dev/models/web_search_response.rbs

Overview

See Also:

• ContextDev::Resources::Web#search

Defined Under Namespace

Classes: KeyMetadata, Result

Instance Attribute Summary

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

  Metadata about the API key used for the request.

• #query ⇒ String

  Echo of the original query (useful when fanout was enabled).

• #results ⇒ Array<ContextDev::Models::WebSearchResponse::Result>

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ Object constructor
• #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 ⇒ Object

# File 'sig/context_dev/models/web_search_response.rbs', line 21

def initialize: (

Instance Attribute Details

#key_metadata ⇒ ContextDev::Models::WebSearchResponse::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::WebSearchResponse::KeyMetadata, nil)

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

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

#query ⇒ String

Echo of the original query (useful when fanout was enabled).

Parameters:

• value (String)

Returns:

• (String)

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

required :query, String

#results ⇒ Array<ContextDev::Models::WebSearchResponse::Result>

Parameters:

• value (::Array[ContextDev::Models::WebSearchResponse::Result])

Returns:

• (Array<ContextDev::Models::WebSearchResponse::Result>)

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

required :results,
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/context_dev/models/web_search_response.rb', line 130

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/context_dev/models/web_search_response.rbs', line 27

def to_hash: -> {