Interface TranslationCreateParams<ResponseFormat>

interface TranslationCreateParams<ResponseFormat> {
    file: Uploadable;
    model: string & {} | "whisper-1";
    prompt?: string;
    response_format?: ResponseFormat;
    temperature?: number;
}

Type Parameters

Properties

file model prompt? response_format? temperature?

Properties

file

file: Uploadable

The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

model

model: string & {} | "whisper-1"

ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.

Optionalprompt

prompt?: string

An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English.

Optionalresponse_format

response_format?: ResponseFormat

The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.

Optionaltemperature

temperature?: number

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

Settings

Member Visibility

On This Page

Properties