Class: OpenAI::Models::Responses::ResponseFunctionWebSearch

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

Defined Under Namespace

Modules: Status

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, 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(id: , status: , type: :web_search_call) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseFunctionWebSearch for more details.

The results of a web search tool call. See the [web search guide](platform.openai.com/docs/guides/tools-web-search) for more information.

Parameters:

  • id (String) (defaults to: ) —

    The unique ID of the web search tool call.

  • status (Symbol, OpenAI::Models::Responses::ResponseFunctionWebSearch::Status) (defaults to: ) —

    The status of the web search tool call.

  • type (Symbol, :web_search_call) (defaults to: :web_search_call) —

    The type of the web search tool call. Always ‘web_search_call`.




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

Instance Attribute Details

#id ⇒ String

The unique ID of the web search tool call.

Returns:

  • (String) 


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

required :id, String

#status ⇒ Symbol, OpenAI::Models::Responses::ResponseFunctionWebSearch::Status

The status of the web search tool call.

Returns:



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

required :status, enum: -> { OpenAI::Responses::ResponseFunctionWebSearch::Status }

#type ⇒ Symbol, :web_search_call

The type of the web search tool call. Always ‘web_search_call`.

Returns:

  • (Symbol, :web_search_call) 


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

required :type, const: :web_search_call