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

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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

Parameters:

  • queries —

    The search queries.

  • query —

    The search query.

  • sources —

    The sources used in the search.

  • type —

    The action type.



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

def initialize: (

Instance Attribute Details

#queries ⇒ ::Array[String]?

The search queries.

Returns:

  • (::Array[String], nil) 


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

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

#query ⇒ String?

The search query.

Returns:

  • (String, nil) 


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

optional :query, String

#sources ⇒ ::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source]?

The sources used in the search.

Returns:

  • (::Array[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source], nil) 


93
94
95
96
97
98
 
# File 'lib/openai/models/responses/response_function_web_search.rb', line 93

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

#type ⇒ :search

The action type.

Returns:

  • (:search) 


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

required :type, const: :search

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {