Module: OpenAI::Models::Live::DataChannelConfig::AllowedServerEvents

Extended by:

Internal::Type::Union

Defined in:

lib/openai/models/live/data_channel_config.rb,
sig/openai/models/live/data_channel_config.rbs

Overview

Server events that may be sent to the frontend data channel. Use 'all' to allow every server event; an empty array allows none. Omission preserves the existing allow-all behavior. Responses events use an object with type 'response.event' and a response_event selector.

See Also:

• OpenAI::Models::Live::DataChannelConfig#allowed_server_events

Constant Summary

ServerEventSelectorArray =

Returns:

• (OpenAI::Internal::Type::Converter)

OpenAI::Internal::Type::ArrayOf[-> { OpenAI::Live::ServerEventSelector }]

Class Method Summary

• .variants ⇒ Array(Symbol, :all, Array<OpenAI::Models::Live::ServerEventSelector>)

Instance Method Summary

• #self?.variants ⇒ ::Array[OpenAI::Models::Live::DataChannelConfig::allowed_server_events]

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, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(Symbol, :all, Array<OpenAI::Models::Live::ServerEventSelector>)

Returns:

• (Array(Symbol, :all, Array<OpenAI::Models::Live::ServerEventSelector>))

# File 'lib/openai/models/live/data_channel_config.rb', line 72

Instance Method Details

#self?.variants ⇒ ::Array[OpenAI::Models::Live::DataChannelConfig::allowed_server_events]

Returns:

• (::Array[OpenAI::Models::Live::DataChannelConfig::allowed_server_events])

# File 'sig/openai/models/live/data_channel_config.rbs', line 49

def self?.variants: -> ::Array[OpenAI::Models::Live::DataChannelConfig::allowed_server_events]