Struct RealtimeSessionInputAudioTranscription

pub struct RealtimeSessionInputAudioTranscription {
    pub model: Option<String>,
    pub language: Option<String>,
    pub prompt: Option<String>,
}

Configuration for input audio transcription, defaults to off and can be set to null to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through the /audio/transcriptions endpoint and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

Fields

model: Option<String>

The model to use for transcription, current options are gpt-4o-transcribe, gpt-4o-mini-transcribe, and whisper-1.

language: Option<String>

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

prompt: Option<String>

An optional text to guide the model’s style or continue a previous audio segment. For whisper-1, the prompt is a list of keywords. For gpt-4o-transcribe models, the prompt is a free text string, for example “expect words related to technology”.

Implementations

impl RealtimeSessionInputAudioTranscription

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

Create a builder for building RealtimeSessionInputAudioTranscription. On the builder, call .model(...)(optional), .language(...)(optional), .prompt(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeSessionInputAudioTranscription.

Trait Implementations

impl Clone for RealtimeSessionInputAudioTranscription

fn clone(&self) -> RealtimeSessionInputAudioTranscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeSessionInputAudioTranscription

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

Formats the value using the given formatter.

impl Default for RealtimeSessionInputAudioTranscription

fn default() -> RealtimeSessionInputAudioTranscription

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeSessionInputAudioTranscription

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeSessionInputAudioTranscription

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

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 RealtimeSessionInputAudioTranscription