CreateSpeechRequestArgs

async_openai::types::audio

Struct CreateSpeechRequestArgs

pub struct CreateSpeechRequestArgs { /* private fields */ }

Expand description

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, tts-1-hd or gpt-4o-mini-tts.

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

The voice to use when generating the audio. Supported voices are alloy, ash, coral, echo, fable, onyx, nova, sage, shimmer and verse. 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.

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

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

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 stream_format<VALUE: Into<StreamFormat>>( &mut self, value: VALUE, ) -> &mut Self

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

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 duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for CreateSpeechRequestArgs

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

Formats the value using the given formatter. Read more

impl Default for CreateSpeechRequestArgs

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for CreateSpeechRequestArgs

impl RefUnwindSafe for CreateSpeechRequestArgs

impl Send for CreateSpeechRequestArgs

impl Sync for CreateSpeechRequestArgs

impl Unpin for CreateSpeechRequestArgs

impl UnwindSafe for CreateSpeechRequestArgs

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more