Struct CreateSpeechRequest 

pub struct CreateSpeechRequest {
    pub input: String,
    pub model: SpeechModel,
    pub voice: Voice,
    pub instructions: Option<String>,
    pub response_format: Option<SpeechResponseFormat>,
    pub speed: Option<f32>,
    pub stream_format: Option<StreamFormat>,
}

Available on crate feature audio-types only.

Fields

input: String

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

model: SpeechModel

One of the available TTS models: tts-1, tts-1-hd or gpt-4o-mini-tts.

voice: Voice

The voice to use when generating the audio. Supported built-in voices are alloy, ash, ballad, coral, echo, fable, onyx, nova, sage, shimmer, verse, marin, and cedar. You may also provide a custom voice object with an id, for example { "id": "voice_1234" }. Previews of the voices are available in the Text to speech guide. Custom voices must be created from audio samples. Voices created from text prompts are supported only in Live.

instructions: Option<String>

Control the voice of your generated audio with additional instructions. Does not work with tts-1 or tts-1-hd.

response_format: Option<SpeechResponseFormat>

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

speed: Option<f32>

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

stream_format: Option<StreamFormat>

The format to stream the audio in. Supported formats are sse and audio. sse is not supported for tts-1 or tts-1-hd.

Trait Implementations

impl Clone for CreateSpeechRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSpeechRequest

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

Formats the value using the given formatter.

impl Default for CreateSpeechRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateSpeechRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateSpeechRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CreateSpeechRequest

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 CreateSpeechRequest