Struct CreateTranscriptionRequestArgs

pub struct CreateTranscriptionRequestArgs { /* private fields */ }

Builder for CreateTranscriptionRequest.

Implementations

impl CreateTranscriptionRequestArgs

pub fn file<VALUE: Into<AudioInput>>(&mut self, value: VALUE) -> &mut Self

The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

pub fn model<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.

pub fn prompt<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

An optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.

pub fn response_format<VALUE: Into<AudioResponseFormat>>( &mut self, value: VALUE, ) -> &mut Self

The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.

pub fn temperature<VALUE: Into<f32>>(&mut self, value: VALUE) -> &mut Self

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

pub fn language<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.

pub fn timestamp_granularities<VALUE: Into<Vec<TimestampGranularity>>>( &mut self, value: VALUE, ) -> &mut Self

The timestamp granularities to populate for this transcription. response_format must be set verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.

pub fn build(&self) -> Result<CreateTranscriptionRequest, OpenAIError>

Builds a new CreateTranscriptionRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateTranscriptionRequestArgs

fn clone(&self) -> CreateTranscriptionRequestArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTranscriptionRequestArgs

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

Formats the value using the given formatter.

impl Default for CreateTranscriptionRequestArgs

fn default() -> Self

Returns the “default value” for a type.