RealtimeSessionTurnDetection

Struct RealtimeSessionTurnDetection 

Source
pub struct RealtimeSessionTurnDetection {
    pub type: String,
    pub eagerness: Option<String>,
    pub threshold: Option<f64>,
    pub prefix_padding_ms: Option<i32>,
    pub silence_duration_ms: Option<i32>,
    pub create_response: Option<bool>,
    pub interrupt_response: Option<bool>,
}
Expand description

Configuration for turn detection (VAD) in a Realtime session.

§Used By

  • RealtimeSession
  • RealtimeSessionCreateResponse
  • RealtimeSessionCreateRequest
  • RealtimeTranscriptionSessionCreateResponse
  • RealtimeTranscriptionSessionCreateRequest

Fields§

§type: String

Type of turn detection (server_vad or semantic_vad). Defaults to server_vad.

§eagerness: Option<String>

Eagerness for semantic_vad (low, medium, high, auto). Defaults to auto.

§threshold: Option<f64>

Activation threshold for server_vad (0.0 to 1.0). Defaults to 0.5.

§prefix_padding_ms: Option<i32>

Audio padding before VAD start for server_vad (ms). Defaults to 300ms.

§silence_duration_ms: Option<i32>

Silence duration to detect speech stop for server_vad (ms). Defaults to 500ms.

§create_response: Option<bool>

Whether to automatically create a response on VAD stop. Defaults to true.

§interrupt_response: Option<bool>

Whether to automatically interrupt ongoing response on VAD start. Defaults to true. Not applicable for transcription sessions.

Implementations§

Source§

impl RealtimeSessionTurnDetection

Source

pub fn former() -> RealtimeSessionTurnDetectionFormer<RealtimeSessionTurnDetectionFormerDefinition<(), RealtimeSessionTurnDetection, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations§

Source§

impl Clone for RealtimeSessionTurnDetection

Source§

fn clone(&self) -> RealtimeSessionTurnDetection

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RealtimeSessionTurnDetection

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RealtimeSessionTurnDetection

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for RealtimeSessionTurnDetection
where __End: FormingEnd<RealtimeSessionTurnDetectionFormerDefinitionTypes<__Context, __Formed>>,

Source§

type Definition = RealtimeSessionTurnDetectionFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity. Read more
Source§

type Types = RealtimeSessionTurnDetectionFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity. Read more
Source§

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for RealtimeSessionTurnDetection

Source§

type Types = RealtimeSessionTurnDetectionFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation. Read more
Source§

impl<Definition> EntityToFormer<Definition> for RealtimeSessionTurnDetection
where Definition: FormerDefinition<Storage = RealtimeSessionTurnDetectionFormerStorage>,

Source§

type Former = RealtimeSessionTurnDetectionFormer<Definition>

The type of the former (builder) used for constructing the entity. Read more
Source§

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic. Read more
Source§

impl EntityToStorage for RealtimeSessionTurnDetection

Source§

type Storage = RealtimeSessionTurnDetectionFormerStorage

The storage type used for forming the entity.
Source§

impl PartialEq for RealtimeSessionTurnDetection

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for RealtimeSessionTurnDetection

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RealtimeSessionTurnDetection

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneDyn for T
where T: Clone,

Source§

fn __clone_dyn(&self, _: DontCallMe) -> *mut ()

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<C, E> EntryToVal<C> for E
where C: Collection<Entry = E>,

Source§

type Val = <C as Collection>::Val

The type of values stored in the collection. This might be distinct from Entry in complex collections. For example, in a HashMap, while Entry might be a ( key, value ) tuple, Val might only be the value part.
Source§

fn entry_to_val(self) -> <E as EntryToVal<C>>::Val

Converts an entry into a value representation specific to the type of collection. This conversion is crucial for handling operations on entries, especially when they need to be treated or accessed as individual values, such as retrieving the value part from a key-value pair in a hash map.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<C, Val> ValToEntry<C> for Val
where C: CollectionValToEntry<Val>,

Source§

fn val_to_entry(self) -> <C as CollectionValToEntry<Val>>::Entry

Invokes the val_to_entry function of the CollectionValToEntry trait to convert the value to an entry.

Source§

type Entry = <C as CollectionValToEntry<Val>>::Entry

Represents the type of entry that corresponds to the value within the collection. Type Entry is defined by the Collection trait.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,