Module: OpenAI::Models::Responses::ResponsesServerEvent

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/responses/responses_server_event.rb,
sig/openai/models/responses/responses_server_event.rbs

Overview

Server events emitted by the Responses WebSocket server.

Defined Under Namespace

Classes: ResponseAudioTranscriptWsDelta, ResponseAudioTranscriptWsDone, ResponseAudioWsDelta, ResponseAudioWsDone, ResponseCodeInterpreterCallCodeWsDelta, ResponseCodeInterpreterCallCodeWsDone, ResponseCodeInterpreterCallInWsProgress, ResponseCodeInterpreterCallWsCompleted, ResponseCodeInterpreterCallWsInterpreting, ResponseContentPartWsAdded, ResponseContentPartWsDone, ResponseCustomToolCallInputWsDelta, ResponseCustomToolCallInputWsDone, ResponseFileSearchCallInWsProgress, ResponseFileSearchCallWsCompleted, ResponseFileSearchCallWsSearching, ResponseFunctionCallArgumentsWsDelta, ResponseFunctionCallArgumentsWsDone, ResponseImageGenCallInWsProgress, ResponseImageGenCallPartialWsImage, ResponseImageGenCallWsCompleted, ResponseImageGenCallWsGenerating, ResponseInWsProgress, ResponseMcpCallArgumentsWsDelta, ResponseMcpCallArgumentsWsDone, ResponseMcpCallInWsProgress, ResponseMcpCallWsCompleted, ResponseMcpCallWsFailed, ResponseMcpListToolsInWsProgress, ResponseMcpListToolsWsCompleted, ResponseMcpListToolsWsFailed, ResponseOutputItemWsAdded, ResponseOutputItemWsDone, ResponseOutputTextAnnotationWsAdded, ResponseReasoningSummaryPartWsAdded, ResponseReasoningSummaryPartWsDone, ResponseReasoningSummaryTextWsDelta, ResponseReasoningSummaryTextWsDone, ResponseReasoningTextWsDelta, ResponseReasoningTextWsDone, ResponseRefusalWsDelta, ResponseRefusalWsDone, ResponseTextWsDelta, ResponseTextWsDone, ResponseWebSearchCallInWsProgress, ResponseWebSearchCallWsCompleted, ResponseWebSearchCallWsSearching, ResponseWsCompleted, ResponseWsCreated, ResponseWsError, ResponseWsFailed, ResponseWsIncomplete, ResponseWsQueued

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseAudioTranscriptWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallCodeWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCodeInterpreterCallWsInterpreting, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseContentPartWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsCreated, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsError, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFileSearchCallWsSearching, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseFunctionCallArgumentsWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsIncomplete, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputItemWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryPartWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningSummaryTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseReasoningTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseRefusalWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseTextWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWebSearchCallWsSearching, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallWsGenerating, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseImageGenCallPartialWsImage, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallArgumentsWsDone, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpCallInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsCompleted, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsWsFailed, OpenAI::Models::Responses::ResponsesServerEvent::ResponseMcpListToolsInWsProgress, OpenAI::Models::Responses::ResponsesServerEvent::ResponseOutputTextAnnotationWsAdded, OpenAI::Models::Responses::ResponsesServerEvent::ResponseWsQueued, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDelta, OpenAI::Models::Responses::ResponsesServerEvent::ResponseCustomToolCallInputWsDone)

Returns:




# File 'lib/openai/models/responses/responses_server_event.rb', line 1169

Instance Method Details

#initialize(stream_id: nil) ⇒ Object

Some parameter documentations has been truncated, see ResponseCustomToolCallInputWsDelta for more details.

Event representing a delta (partial update) to the input of a custom tool call.

Parameters:

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

    The WebSocket lane that emitted this event. This field is present




# File 'lib/openai/models/responses/responses_server_event.rb', line 219

#self?.variants ⇒ ::Array[OpenAI::Models::Responses::responses_server_event]

Returns:

  • (::Array[OpenAI::Models::Responses::responses_server_event]) 


1795
 
# File 'sig/openai/models/responses/responses_server_event.rbs', line 1795

def self?.variants: -> ::Array[OpenAI::Models::Responses::responses_server_event]