Struct CreateSpeechRequestArgs

pub struct CreateSpeechRequestArgs { /* private fields */ }

Builder for CreateSpeechRequest.

Implementations

impl CreateSpeechRequestArgs

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

The text to generate audio for. The maximum length is 4096 characters.

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

One of the available TTS models: tts-1 or tts-1-hd

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

The voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer. Previews of the voices are available in the Text to speech guide.

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

The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.

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

The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.

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

Builds a new CreateSpeechRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for CreateSpeechRequestArgs

fn clone(&self) -> CreateSpeechRequestArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSpeechRequestArgs

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

Formats the value using the given formatter.

impl Default for CreateSpeechRequestArgs

fn default() -> Self

Returns the “default value” for a type.