Struct RealtimeTranscriptionSessionCreateRequest

pub struct RealtimeTranscriptionSessionCreateRequest {
    pub modalities: Option<Vec<RealtimeTranscriptionSessionCreateRequestModality>>,
    pub input_audio_format: Option<RealtimeTranscriptionSessionCreateRequestInputAudioFormat>,
    pub input_audio_transcription: Option<RealtimeTranscriptionSessionCreateRequestInputAudioTranscription>,
    pub turn_detection: Option<RealtimeTranscriptionSessionCreateRequestTurnDetection>,
    pub input_audio_noise_reduction: Option<RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction>,
    pub include: Option<Vec<String>>,
    pub client_secret: Option<RealtimeTranscriptionSessionCreateRequestClientSecret>,
}

Realtime transcription session object configuration.

Fields

modalities: Option<Vec<RealtimeTranscriptionSessionCreateRequestModality>>

The set of modalities the model can respond with. To disable audio, set this to [“text”].

input_audio_format: Option<RealtimeTranscriptionSessionCreateRequestInputAudioFormat>

The format of input audio. Options are pcm16, g711_ulaw, or g711_alaw. For pcm16, input audio must be 16-bit PCM at a 24kHz sample rate, single channel (mono), and little-endian byte order.

input_audio_transcription: Option<RealtimeTranscriptionSessionCreateRequestInputAudioTranscription>

Configuration for input audio transcription. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

turn_detection: Option<RealtimeTranscriptionSessionCreateRequestTurnDetection>

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.

input_audio_noise_reduction: Option<RealtimeTranscriptionSessionCreateRequestInputAudioNoiseReduction>

Configuration for input audio noise reduction. This can be set to null to turn off. Noise reduction filters audio added to the input audio buffer before it is sent to VAD and the model. Filtering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.

include: Option<Vec<String>>

The set of items to include in the transcription. Current available items are:

• item.input_audio_transcription.logprobs

client_secret: Option<RealtimeTranscriptionSessionCreateRequestClientSecret>

Configuration options for the generated client secret.

Implementations

impl RealtimeTranscriptionSessionCreateRequest

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

Create a builder for building RealtimeTranscriptionSessionCreateRequest. On the builder, call .modalities(...)(optional), .input_audio_format(...)(optional), .input_audio_transcription(...)(optional), .turn_detection(...)(optional), .input_audio_noise_reduction(...)(optional), .include(...)(optional), .client_secret(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeTranscriptionSessionCreateRequest.

Trait Implementations

impl Clone for RealtimeTranscriptionSessionCreateRequest

fn clone(&self) -> RealtimeTranscriptionSessionCreateRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeTranscriptionSessionCreateRequest

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

Formats the value using the given formatter.

impl Default for RealtimeTranscriptionSessionCreateRequest

fn default() -> RealtimeTranscriptionSessionCreateRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeTranscriptionSessionCreateRequest

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeTranscriptionSessionCreateRequest

fn eq(&self, other: &RealtimeTranscriptionSessionCreateRequest) -> 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 RealtimeTranscriptionSessionCreateRequest

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RealtimeTranscriptionSessionCreateRequest