Class: OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_function_web_search.rb,
sig/openai/models/responses/response_function_web_search.rbs

Defined Under Namespace

Classes: Source

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 ⇒ Object 



68
 
# File 'sig/openai/models/responses/response_function_web_search.rbs', line 68

def initialize: (

Instance Attribute Details

#queries ⇒ Array<String>?

The search queries.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


77
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 77

optional :queries, OpenAI::Internal::Type::ArrayOf[String]

#query ⇒ String?

Deprecated.

The search query.

Parameters:

  • (String)

Returns:

  • (String, nil) 


85
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 85

optional :query, String

#sources ⇒ Array<OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search::Source>?

The sources used in the search.

Returns:



91
92
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 91

optional :sources,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source] }

#type ⇒ Symbol, :search

The action type.

Parameters:

  • value (:search)

Returns:

  • (Symbol, :search) 


71
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 71

required :type, const: :search

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


75
 
# File 'sig/openai/models/responses/response_function_web_search.rbs', line 75

def to_hash: -> {