Class: OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_apply_patch_tool_call_output.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(id:, call_id:, status:, created_by: nil, output: nil, type: :apply_patch_call_output) ⇒ Object

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

The output emitted by an apply patch tool call.

Parameters:

  • id (String) —

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

  • call_id (String) —

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

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

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

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

    The ID of the entity that created this tool call output.

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

    Optional textual output returned by the apply patch tool.

  • 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_apply_patch_tool_call_output.rb', line 44

Instance Attribute Details

#call_id ⇒ String

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

Returns:

  • (String) 


18
 
# File 'lib/openai/models/responses/response_apply_patch_tool_call_output.rb', line 18

required :call_id, String

#created_by ⇒ String?

The ID of the entity that created this tool call output.

Returns:

  • (String, nil) 


36
 
# File 'lib/openai/models/responses/response_apply_patch_tool_call_output.rb', line 36

optional :created_by, String

#id ⇒ String

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

Returns:

  • (String) 


12
 
# File 'lib/openai/models/responses/response_apply_patch_tool_call_output.rb', line 12

required :id, String

#output ⇒ String?

Optional textual output returned by the apply patch tool.

Returns:

  • (String, nil) 


42
 
# File 'lib/openai/models/responses/response_apply_patch_tool_call_output.rb', line 42

optional :output, String, nil?: true

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

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

Returns:



24
 
# File 'lib/openai/models/responses/response_apply_patch_tool_call_output.rb', line 24

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

#type ⇒ Symbol, :apply_patch_call_output

The type of the item. Always ‘apply_patch_call_output`.

Returns:

  • (Symbol, :apply_patch_call_output) 


30
 
# File 'lib/openai/models/responses/response_apply_patch_tool_call_output.rb', line 30

required :type, const: :apply_patch_call_output