44 lines
1.6 KiB
TypeScript
44 lines
1.6 KiB
TypeScript
|
import { APIResource } from "../../resource.js";
|
||
|
|
import * as Core from "../../core.js";
|
||
|
|
import * as SpeechAPI from "./speech.js";
|
||
|
|
import { type Response } from "../../_shims/index.js";
|
||
|
|
export declare class Speech extends APIResource {
|
||
|
|
/**
|
||
|
|
* Generates audio from the input text.
|
||
|
|
*/
|
||
|
|
create(body: SpeechCreateParams, options?: Core.RequestOptions): Core.APIPromise<Response>;
|
||
|
|
}
|
||
|
|
export type SpeechModel = 'tts-1' | 'tts-1-hd';
|
||
|
|
export interface SpeechCreateParams {
|
||
|
|
/**
|
||
|
|
* The text to generate audio for. The maximum length is 4096 characters.
|
||
|
|
*/
|
||
|
|
input: string;
|
||
|
|
/**
|
||
|
|
* One of the available [TTS models](https://platform.openai.com/docs/models/tts):
|
||
|
|
* `tts-1` or `tts-1-hd`
|
||
|
|
*/
|
||
|
|
model: (string & {}) | SpeechModel;
|
||
|
|
/**
|
||
|
|
* 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](https://platform.openai.com/docs/guides/text-to-speech/voice-options).
|
||
|
|
*/
|
||
|
|
voice: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
|
||
|
|
/**
|
||
|
|
* The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`,
|
||
|
|
* `wav`, and `pcm`.
|
||
|
|
*/
|
||
|
|
response_format?: 'mp3' | 'opus' | 'aac' | 'flac' | 'wav' | 'pcm';
|
||
|
|
/**
|
||
|
|
* The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
|
||
|
|
* the default.
|
||
|
|
*/
|
||
|
|
speed?: number;
|
||
|
|
}
|
||
|
|
export declare namespace Speech {
|
||
|
|
export import SpeechModel = SpeechAPI.SpeechModel;
|
||
|
|
export import SpeechCreateParams = SpeechAPI.SpeechCreateParams;
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=speech.d.ts.map
|