Struct CreateSpeechRequest

pub struct CreateSpeechRequest {
    pub model: String,
    pub input: String,
    pub instructions: Option<String>,
    pub voice: VoiceIdsShared,
    pub response_format: Option<CreateSpeechRequestResponseFormat>,
    pub speed: Option<f64>,
}

Fields

model: String

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

input: String

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

instructions: Option<String>

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

voice: VoiceIdsShared

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

response_format: Option<CreateSpeechRequestResponseFormat>

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

speed: Option<f64>

The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default. Does not work with gpt-4o-mini-tts.

Implementations

impl CreateSpeechRequest

pub fn builder() -> CreateSpeechRequestBuilder<((), (), (), (), (), ())>

Create a builder for building CreateSpeechRequest. On the builder, call .model(...), .input(...), .instructions(...)(optional), .voice(...), .response_format(...)(optional), .speed(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateSpeechRequest.

Trait Implementations

impl Clone for CreateSpeechRequest

fn clone(&self) -> CreateSpeechRequest

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<'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: &CreateSpeechRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

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