Class: OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput

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

Defined Under Namespace

Modules: Output, 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(call_id:, output:, id: nil, status: nil, type: :function_call_output) ⇒ Object

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

The output of a function tool call.

Parameters:

  • The unique ID of the function tool call generated by the model.

  • Text, image, or file output of the function tool call.

  • (defaults to: nil)

    The unique ID of the function tool call output. Populated when this item is retu

  • (defaults to: nil)

    The status of the item. One of in_progress, completed, or incomplete. Popu

  • (defaults to: :function_call_output)

    The type of the function tool call output. Always function_call_output.




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

Instance Attribute Details

#call_id ⇒ String

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

Returns:



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

required :call_id, String

#id ⇒ String?

The unique ID of the function tool call output. Populated when this item is returned via API.

Returns:



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

optional :id, String, nil?: true

#output ⇒ String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>

Text, image, or file output of the function tool call.

Returns:



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

required :output, union: -> { OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output }

#status ⇒ Symbol, ...

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Returns:



336
337
338
 
# File 'lib/openai/models/responses/response_input_item.rb', line 336

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

#type ⇒ Symbol, :function_call_output

The type of the function tool call output. Always function_call_output.

Returns:



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

required :type, const: :function_call_output

Class Method Details

.variants ⇒ Array(String, Array<OpenAI::Models::Responses::ResponseInputTextContent, OpenAI::Models::Responses::ResponseInputImageContent, OpenAI::Models::Responses::ResponseInputFileContent>)

Returns:




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