Struct RealtimeTranscriptionSessionCreateRequestTurnDetection

pub struct RealtimeTranscriptionSessionCreateRequestTurnDetection {
    pub type: Option<RealtimeTranscriptionSessionCreateRequestTurnDetectionType>,
    pub eagerness: Option<RealtimeTranscriptionSessionCreateRequestTurnDetectionEagerness>,
    pub threshold: Option<f64>,
    pub prefix_padding_ms: Option<u64>,
    pub silence_duration_ms: Option<u64>,
    pub create_response: Option<bool>,
    pub interrupt_response: Option<bool>,
}

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 conjuction 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.

Fields

type: Option<RealtimeTranscriptionSessionCreateRequestTurnDetectionType>

Type of turn detection.

eagerness: Option<RealtimeTranscriptionSessionCreateRequestTurnDetectionEagerness>

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.

threshold: Option<f64>

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.

prefix_padding_ms: Option<u64>

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

silence_duration_ms: Option<u64>

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.

create_response: Option<bool>

Whether or not to automatically generate a response when a VAD stop event occurs. Not available for transcription sessions.

interrupt_response: Option<bool>

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. Not available for transcription sessions.

Implementations

impl RealtimeTranscriptionSessionCreateRequestTurnDetection

pub fn builder() -> RealtimeTranscriptionSessionCreateRequestTurnDetectionBuilder<((), (), (), (), (), (), ())>

Create a builder for building RealtimeTranscriptionSessionCreateRequestTurnDetection. On the builder, call .r#type(...)(optional), .eagerness(...)(optional), .threshold(...)(optional), .prefix_padding_ms(...)(optional), .silence_duration_ms(...)(optional), .create_response(...)(optional), .interrupt_response(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeTranscriptionSessionCreateRequestTurnDetection.

Trait Implementations

impl Clone for RealtimeTranscriptionSessionCreateRequestTurnDetection

fn clone(&self) -> RealtimeTranscriptionSessionCreateRequestTurnDetection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RealtimeTranscriptionSessionCreateRequestTurnDetection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RealtimeTranscriptionSessionCreateRequestTurnDetection

fn default() -> RealtimeTranscriptionSessionCreateRequestTurnDetection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeTranscriptionSessionCreateRequestTurnDetection

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeTranscriptionSessionCreateRequestTurnDetection

fn eq( &self, other: &RealtimeTranscriptionSessionCreateRequestTurnDetection, ) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RealtimeTranscriptionSessionCreateRequestTurnDetection

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RealtimeTranscriptionSessionCreateRequestTurnDetection

impl StructuralPartialEq for RealtimeTranscriptionSessionCreateRequestTurnDetection