Skip to content

@ralphschuler.ai function caller.index.<internal>.OpenAI.Audio.Speech.SpeechCreateParams

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: SpeechCreateParams

Audio.Speech.SpeechCreateParams

Table of contents

Properties

Properties

input

input: string

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

Defined in

node_modules/openai/resources/audio/speech.d.ts:15


model

model: string & {} | "tts-1" | "tts-1-hd"

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

Defined in

node_modules/openai/resources/audio/speech.d.ts:20


response_format

Optional response_format: "mp3" | "opus" | "aac" | "flac"

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

Defined in

node_modules/openai/resources/audio/speech.d.ts:29


speed

Optional speed: number

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

Defined in

node_modules/openai/resources/audio/speech.d.ts:34


voice

voice: "alloy" | "echo" | "fable" | "onyx" | "nova" | "shimmer"

The voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.

Defined in

node_modules/openai/resources/audio/speech.d.ts:25

Typescript Libraries

Modules

Namespaces

Clone this wiki locally