Class: OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput

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

Defined Under Namespace

Modules: Status

Instance Attribute 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:, status:, id: nil, output: nil, type: :apply_patch_call_output) ⇒ Object

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

The streamed output emitted by an apply patch tool call.

Parameters:

  • call_id (String) —

    The unique ID of the apply patch tool call generated by the model.

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

    The status of the apply patch tool call output. One of ‘completed` or `failed`.

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

    The unique ID of the apply patch tool call output. Populated when this item is r

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

    Optional human-readable log text from the apply patch tool (e.g., patch results

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

    The type of the item. Always ‘apply_patch_call_output`.




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

Instance Attribute Details

#call_id ⇒ String

The unique ID of the apply patch tool call generated by the model.

Returns:

  • (String) 


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

required :call_id, String

#id ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :id, String, nil?: true

#output ⇒ String?

Optional human-readable log text from the apply patch tool (e.g., patch results or errors).

Returns:

  • (String, nil) 


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

optional :output, String, nil?: true

#status ⇒ Symbol, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput::Status

The status of the apply patch tool call output. One of ‘completed` or `failed`.

Returns:



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

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

#type ⇒ Symbol, :apply_patch_call_output

The type of the item. Always ‘apply_patch_call_output`.

Returns:

  • (Symbol, :apply_patch_call_output) 


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

required :type, const: :apply_patch_call_output