Module: OpenAI::Models::Beta::BetaResponsesServerEvent

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/beta/beta_responses_server_event.rb

Overview

Server events emitted by the Responses WebSocket server.

Defined Under Namespace

Classes: BetaResponseAudioTranscriptWsDelta, BetaResponseAudioTranscriptWsDone, BetaResponseAudioWsDelta, BetaResponseAudioWsDone, BetaResponseCodeInterpreterCallCodeWsDelta, BetaResponseCodeInterpreterCallCodeWsDone, BetaResponseCodeInterpreterCallInWsProgress, BetaResponseCodeInterpreterCallWsCompleted, BetaResponseCodeInterpreterCallWsInterpreting, BetaResponseContentPartWsAdded, BetaResponseContentPartWsDone, BetaResponseCustomToolCallInputWsDelta, BetaResponseCustomToolCallInputWsDone, BetaResponseFileSearchCallInWsProgress, BetaResponseFileSearchCallWsCompleted, BetaResponseFileSearchCallWsSearching, BetaResponseFunctionCallArgumentsWsDelta, BetaResponseFunctionCallArgumentsWsDone, BetaResponseImageGenCallInWsProgress, BetaResponseImageGenCallPartialWsImage, BetaResponseImageGenCallWsCompleted, BetaResponseImageGenCallWsGenerating, BetaResponseInWsProgress, BetaResponseMcpCallArgumentsWsDelta, BetaResponseMcpCallArgumentsWsDone, BetaResponseMcpCallInWsProgress, BetaResponseMcpCallWsCompleted, BetaResponseMcpCallWsFailed, BetaResponseMcpListToolsInWsProgress, BetaResponseMcpListToolsWsCompleted, BetaResponseMcpListToolsWsFailed, BetaResponseOutputItemWsAdded, BetaResponseOutputItemWsDone, BetaResponseOutputTextAnnotationWsAdded, BetaResponseReasoningSummaryPartWsAdded, BetaResponseReasoningSummaryPartWsDone, BetaResponseReasoningSummaryTextWsDelta, BetaResponseReasoningSummaryTextWsDone, BetaResponseReasoningTextWsDelta, BetaResponseReasoningTextWsDone, BetaResponseRefusalWsDelta, BetaResponseRefusalWsDone, BetaResponseTextWsDelta, BetaResponseTextWsDone, BetaResponseWebSearchCallInWsProgress, BetaResponseWebSearchCallWsCompleted, BetaResponseWebSearchCallWsSearching, BetaResponseWsCompleted, BetaResponseWsCreated, BetaResponseWsError, BetaResponseWsFailed, BetaResponseWsIncomplete, BetaResponseWsQueued

Instance Method Summary

• #initialize(stream_id: nil) ⇒ Object

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

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants, 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

Instance Method Details

#initialize(stream_id: nil) ⇒ Object

Some parameter documentations has been truncated, see BetaResponseCustomToolCallInputWsDelta 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/beta/beta_responses_server_event.rb', line 231