Class: OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall

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

Defined Under Namespace

Modules: Execution, Status

Instance Attribute Summary collapse

Class Method 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(arguments:, id: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_call) ⇒ Object

Parameters:

  • arguments (Object) —

    The arguments supplied to the tool search call.

  • id (String, nil) (defaults to: nil) —

    The unique ID of this tool search call.

  • call_id (String, nil) (defaults to: nil) —

    The unique ID of the tool search call generated by the model.

  • execution (Symbol, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::Execution) (defaults to: nil) —

    Whether tool search was executed by the server or by the client.

  • status (Symbol, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::Status, nil) (defaults to: nil) —

    The status of the tool search call.

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

    The item type. Always tool_search_call.




# File 'lib/openai/models/responses/response_input_item.rb', line 496

Instance Attribute Details

#arguments ⇒ Object

The arguments supplied to the tool search call.

Parameters:

  • value (top)

Returns:

  • (Object) 


460
 
# File 'lib/openai/models/responses/response_input_item.rb', line 460

required :arguments, OpenAI::Internal::Type::Unknown

#call_id ⇒ String?

The unique ID of the tool search call generated by the model.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


478
 
# File 'lib/openai/models/responses/response_input_item.rb', line 478

optional :call_id, String, nil?: true

#execution ⇒ Symbol, ...

Whether tool search was executed by the server or by the client.

Returns:



484
 
# File 'lib/openai/models/responses/response_input_item.rb', line 484

optional :execution, enum: -> { OpenAI::Responses::ResponseInputItem::ToolSearchCall::Execution }

#id ⇒ String?

The unique ID of this tool search call.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


472
 
# File 'lib/openai/models/responses/response_input_item.rb', line 472

optional :id, String, nil?: true

#status ⇒ Symbol, ...

The status of the tool search call.

Parameters:

  • value (OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall::status, nil)

Returns:



490
491
492
493
494
 
# File 'lib/openai/models/responses/response_input_item.rb', line 490

optional :status,
enum: -> {
  OpenAI::Responses::ResponseInputItem::ToolSearchCall::Status
},
nil?: true

#type ⇒ Symbol, :tool_search_call

The item type. Always tool_search_call.

Parameters:

  • value (:tool_search_call)

Returns:

  • (Symbol, :tool_search_call) 


466
 
# File 'lib/openai/models/responses/response_input_item.rb', line 466

required :type, const: :tool_search_call

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/response_input_item.rb', line 518

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


320
 
# File 'sig/openai/models/responses/response_input_item.rbs', line 320

def to_hash: -> {