Class: OpenAI::Models::Beta::BetaResponseInjectFailedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_inject_failed_event.rb,
sig/openai/models/beta/beta_response_inject_failed_event.rbs

Defined Under Namespace

Classes: Error

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(error:, input:, response_id:, sequence_number:, stream_id: nil, type: :"response.inject.failed") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseInjectFailedEvent for more details.

Emitted when injected input could not be committed to a response. The event returns the uncommitted raw input so the client can retry it in another response when appropriate.

Parameters:




# File 'lib/openai/models/beta/beta_response_inject_failed_event.rb', line 44

Instance Attribute Details

#error ⇒ OpenAI::Models::Beta::BetaResponseInjectFailedEvent::Error

Information about why the input was not committed.

Parameters:

  • value (OpenAI::Beta::BetaResponseInjectFailedEvent::Error)

Returns:



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

required :error, -> { OpenAI::Beta::BetaResponseInjectFailedEvent::Error }

#input ⇒ Array<OpenAI::Models::Beta::BetaEasyInputMessage, OpenAI::Models::Beta::BetaResponseInputItem::Message, OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseInputItem::ComputerCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseInputItem::FunctionCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseInputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam, OpenAI::Models::Beta::BetaResponseInputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseCompactionItemParam, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseInputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ShellCall, OpenAI::Models::Beta::BetaResponseInputItem::ShellCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCall, OpenAI::Models::Beta::BetaResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Beta::BetaResponseInputItem::McpListTools, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseInputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseInputItem::McpCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseInputItem::CompactionTrigger, OpenAI::Models::Beta::BetaResponseInputItem::ItemReference, OpenAI::Models::Beta::BetaResponseInputItem::Program, OpenAI::Models::Beta::BetaResponseInputItem::ProgramOutput>

The raw input items that were not committed.

Parameters:

  • value (::Array[OpenAI::Models::Beta::beta_response_input_item])

Returns:



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

required :input, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseInputItem] }

#response_id ⇒ String

The ID of the response that rejected the input.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :response_id, String

#sequence_number ⇒ Integer

The sequence number for this event.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :sequence_number, Integer

#stream_id ⇒ String?

The multiplexed WebSocket stream that emitted the event. This field is present only when WebSocket multiplexing is enabled separately.

Parameters:

  • (String)

Returns:

  • (String, nil) 


42
 
# File 'lib/openai/models/beta/beta_response_inject_failed_event.rb', line 42

optional :stream_id, String

#type ⇒ Symbol, :"response.inject.failed"

The event discriminator. Always response.inject.failed.

Parameters:

  • value (:"response.inject.failed")

Returns:

  • (Symbol, :"response.inject.failed") 


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

required :type, const: :"response.inject.failed"

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {