Struct TranscriptionRequest

pub struct TranscriptionRequest { /* private fields */ }

request that provides transcription for given audio file parameter details at https://platform.openai.com/docs/api-reference/audio/create

Usage example

 use std::path::PathBuf;
 use openai_req::audio::{Iso639_1, TranscriptionRequest};
 use openai_req::FormRequest;

   let req = TranscriptionRequest::new(PathBuf::from("tests/Linus-linux.mp3"))
         .language(Iso639_1::En);
   let res = req.run(&client).await?;

Implementations

impl TranscriptionRequest

pub fn new(file: PathBuf) -> Self

Minimal constructor is enough to run a request, you can get a transcription by only providing file name. But quality will be significantly better if you at least specify source language

pub fn with_model(file: PathBuf, model: String) -> Self

pub fn file(self, file: PathBuf) -> Self

pub fn model(self, model: String) -> Self

pub fn prompt(self, prompt: String) -> Self

pub fn response_format(self, response_format: ResponseFormat) -> Self

pub fn temperature(self, temperature: f64) -> Self

pub fn language(self, language: Iso639_1) -> Self

Trait Implementations

impl Clone for TranscriptionRequest

fn clone(&self) -> TranscriptionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranscriptionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TranscriptionRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FormRequest<AudioResponse> for TranscriptionRequest

const ENDPOINT: &'static str = "/audio/transcriptions"

fn run<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 OpenAiClient, ) -> Pin<Box<dyn Future<Output = Result<AudioResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn get_response<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, client: &'life1 Client, final_url: String, key: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

impl Serialize for TranscriptionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.