Class: OpenAI::Models::Responses::ResponseToolSearchCall

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

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

Parameters:

  • id (String) —

    The unique ID of the tool search call item.

  • arguments (Object) —

    Arguments used for the tool search call.

  • call_id (String, nil) —

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

  • execution (Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Execution) —

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

  • status (Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Status) —

    The status of the tool search call item that was recorded.

  • created_by (String) (defaults to: nil) —

    The identifier of the actor that created the item.

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

    The type of the item. Always tool_search_call.




# File 'lib/openai/models/responses/response_tool_search_call.rb', line 49

Instance Attribute Details

#arguments ⇒ Object

Arguments used for the tool search call.

Returns:

  • (Object) 


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

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

#call_id ⇒ String?

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

Returns:

  • (String, nil) 


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

required :call_id, String, nil?: true

#created_by ⇒ String?

The identifier of the actor that created the item.

Returns:

  • (String, nil) 


47
 
# File 'lib/openai/models/responses/response_tool_search_call.rb', line 47

optional :created_by, String

#execution ⇒ Symbol, OpenAI::Models::Responses::ResponseToolSearchCall::Execution

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

Returns:



29
 
# File 'lib/openai/models/responses/response_tool_search_call.rb', line 29

required :execution, enum: -> { OpenAI::Responses::ResponseToolSearchCall::Execution }

#id ⇒ String

The unique ID of the tool search call item.

Returns:

  • (String) 


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

required :id, String

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

The status of the tool search call item that was recorded.

Returns:



35
 
# File 'lib/openai/models/responses/response_tool_search_call.rb', line 35

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

#type ⇒ Symbol, :tool_search_call

The type of the item. Always tool_search_call.

Returns:

  • (Symbol, :tool_search_call) 


41
 
# File 'lib/openai/models/responses/response_tool_search_call.rb', line 41

required :type, const: :tool_search_call

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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