Class: OpenAI::Models::Realtime::ClientSecretCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/client_secret_create_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Session

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(expires_at:, session:, value:) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::ClientSecretCreateResponse for more details.

Response from creating a session and client secret for the Realtime API.

Parameters:




# File 'lib/openai/models/realtime/client_secret_create_response.rb', line 26

Instance Attribute Details

#expires_at ⇒ Integer

Expiration timestamp for the client secret, in seconds since epoch.

Returns:

  • (Integer) 


12
 
# File 'lib/openai/models/realtime/client_secret_create_response.rb', line 12

required :expires_at, Integer

#session ⇒ OpenAI::Models::Realtime::RealtimeSessionCreateResponse, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateResponse

The session configuration for either a realtime or transcription session.

Returns:



18
 
# File 'lib/openai/models/realtime/client_secret_create_response.rb', line 18

required :session, union: -> { OpenAI::Models::Realtime::ClientSecretCreateResponse::Session }

#value ⇒ String

The generated client secret value.

Returns:

  • (String) 


24
 
# File 'lib/openai/models/realtime/client_secret_create_response.rb', line 24

required :value, String