Class: OpenAI::Models::Beta::AgentFunctionCallItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/agent_function_call_item.rb,
sig/openai/models/beta/agent_function_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:, arguments:, call_id:, name:, status:, turn_id:, type: :function_call) ⇒ Object

A function call produced by the agent.

Parameters:

  • id (String) —

    The ID of the function call item.

  • arguments (Object) —

    The arguments to pass to the function.

  • call_id (String) —

    The ID used to submit the function result.

  • name (String) —

    The name of the function to call.

  • status (Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus) —

    The status of the function call.

  • turn_id (String) —

    The ID of the turn that contains this item.

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

    The item type. Always function_call.




# File 'lib/openai/models/beta/agent_function_call_item.rb', line 49

Instance Attribute Details

#arguments ⇒ Object

The arguments to pass to the function.

Parameters:

  • value (top)

Returns:

  • (Object) 


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

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

#call_id ⇒ String

The ID used to submit the function result.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :call_id, String

#id ⇒ String

The ID of the function call item.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#name ⇒ String

The name of the function to call.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

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

The status of the function call.

Parameters:

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

Returns:



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

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

#turn_id ⇒ String

The ID of the turn that contains this item.

Parameters:

  • value (String)

Returns:

  • (String) 


41
 
# File 'lib/openai/models/beta/agent_function_call_item.rb', line 41

required :turn_id, String

#type ⇒ Symbol, :function_call

The item type. Always function_call.

Parameters:

  • value (:function_call)

Returns:

  • (Symbol, :function_call) 


47
 
# File 'lib/openai/models/beta/agent_function_call_item.rb', line 47

required :type, const: :function_call

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


40
 
# File 'sig/openai/models/beta/agent_function_call_item.rbs', line 40

def to_hash: -> {