Class: OpenAI::Models::Realtime::RealtimeSession::TurnDetection

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

Overview

See Also:

Defined Under Namespace

Modules: Eagerness, Type

Instance Attribute Summary collapse

Class Method 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(create_response: nil, eagerness: nil, idle_timeout_ms: nil, interrupt_response: nil, prefix_padding_ms: nil, silence_duration_ms: nil, threshold: nil, type: nil) ⇒ Object

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

Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to ‘null` to turn off, in which case the client must manually trigger model response. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech. Semantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with “uhhm”, the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.

Parameters:

  • create_response (Boolean) (defaults to: nil) —

    Whether or not to automatically generate a response when a VAD stop event occurs

  • eagerness (Symbol, OpenAI::Models::Realtime::RealtimeSession::TurnDetection::Eagerness) (defaults to: nil) —

    Used only for ‘semantic_vad` mode. The eagerness of the model to respond. `low`

  • idle_timeout_ms (Integer, nil) (defaults to: nil) —

    Optional idle timeout after which turn detection will auto-timeout when

  • interrupt_response (Boolean) (defaults to: nil) —

    Whether or not to automatically interrupt any ongoing response with output to th

  • prefix_padding_ms (Integer) (defaults to: nil) —

    Used only for ‘server_vad` mode. Amount of audio to include before the VAD detec

  • silence_duration_ms (Integer) (defaults to: nil) —

    Used only for ‘server_vad` mode. Duration of silence to detect speech stop (in m

  • threshold (Float) (defaults to: nil) —

    Used only for ‘server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this

  • type (Symbol, OpenAI::Models::Realtime::RealtimeSession::TurnDetection::Type) (defaults to: nil) —

    Type of turn detection.




# File 'lib/openai/models/realtime/realtime_session.rb', line 579

Instance Attribute Details

#create_response ⇒ Boolean?

Whether or not to automatically generate a response when a VAD stop event occurs.

Returns:



525
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 525

optional :create_response, OpenAI::Internal::Type::Boolean

#eagerness ⇒ Symbol, ...

Used only for ‘semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`.

Returns:



533
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 533

optional :eagerness, enum: -> { OpenAI::Realtime::RealtimeSession::TurnDetection::Eagerness }

#idle_timeout_ms ⇒ Integer?

Optional idle timeout after which turn detection will auto-timeout when no additional audio is received.

Returns:

  • (Integer, nil) 


540
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 540

optional :idle_timeout_ms, Integer, nil?: true

#interrupt_response ⇒ Boolean?

Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. ‘conversation` of `auto`) when a VAD start event occurs.

Returns:



548
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 548

optional :interrupt_response, OpenAI::Internal::Type::Boolean

#prefix_padding_ms ⇒ Integer?

Used only for ‘server_vad` mode. Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.

Returns:

  • (Integer, nil) 


555
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 555

optional :prefix_padding_ms, Integer

#silence_duration_ms ⇒ Integer?

Used only for ‘server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user.

Returns:

  • (Integer, nil) 


563
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 563

optional :silence_duration_ms, Integer

#threshold ⇒ Float?

Used only for ‘server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.

Returns:

  • (Float, nil) 


571
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 571

optional :threshold, Float

#type ⇒ Symbol, ...

Type of turn detection.

Returns:



577
 
# File 'lib/openai/models/realtime/realtime_session.rb', line 577

optional :type, enum: -> { OpenAI::Realtime::RealtimeSession::TurnDetection::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/realtime/realtime_session.rb', line 623