Class: OpenAI::Models::Beta::AgentWebSearchCallItem

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

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

A web search call produced by the agent.

Parameters:




# File 'lib/openai/models/beta/agent_web_search_call_item.rb', line 37

Instance Attribute Details

#action ⇒ OpenAI::Models::Beta::WebSearchAction::Search, ...

An action performed by the web search tool.

Parameters:

  • value (OpenAI::Models::Beta::web_search_action, nil)

Returns:



17
 
# File 'lib/openai/models/beta/agent_web_search_call_item.rb', line 17

required :action, union: -> { OpenAI::Beta::WebSearchAction }, nil?: true

#id ⇒ String

The ID of the web search call.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/agent_web_search_call_item.rb', line 11

required :id, String

#status ⇒ Symbol, OpenAI::Models::Beta::AgentOutputItemStatus

The status of the web search call.

Parameters:

  • value (OpenAI::Models::Beta::agent_output_item_status)

Returns:



23
 
# File 'lib/openai/models/beta/agent_web_search_call_item.rb', line 23

required :status, enum: -> { OpenAI::Beta::AgentOutputItemStatus }

#turn_id ⇒ String

The ID of the turn that contains this item.

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/openai/models/beta/agent_web_search_call_item.rb', line 29

required :turn_id, String

#type ⇒ Symbol, :web_search_call

The item type. Always web_search_call.

Parameters:

  • value (:web_search_call)

Returns:

  • (Symbol, :web_search_call) 


35
 
# File 'lib/openai/models/beta/agent_web_search_call_item.rb', line 35

required :type, const: :web_search_call

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


32
 
# File 'sig/openai/models/beta/agent_web_search_call_item.rbs', line 32

def to_hash: -> {