Struct async_openai::types::CreateTranscriptionRequest

pub struct CreateTranscriptionRequest {
    pub file: AudioInput,
    pub model: String,
    pub prompt: Option<String>,
    pub response_format: Option<AudioResponseFormat>,
    pub temperature: Option<f32>,
    pub language: Option<String>,
    pub timestamp_granularities: Option<Vec<TimestampGranularity>>,
}

Fields

file: AudioInput

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

model: String

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

prompt: Option<String>

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

response_format: Option<AudioResponseFormat>

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

temperature: Option<f32>

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.

language: Option<String>

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

timestamp_granularities: Option<Vec<TimestampGranularity>>

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.

Trait Implementations

impl Clone for CreateTranscriptionRequest

fn clone(&self) -> CreateTranscriptionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateTranscriptionRequest

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

Formats the value using the given formatter.

impl Default for CreateTranscriptionRequest

fn default() -> CreateTranscriptionRequest

Returns the “default value” for a type.

impl PartialEq for CreateTranscriptionRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<CreateTranscriptionRequest> for Form

type Error = OpenAIError

The type returned in the event of a conversion error.

fn try_from<'async_trait>( request: CreateTranscriptionRequest, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait,

Performs the conversion.

impl StructuralPartialEq for CreateTranscriptionRequest