Translations

Create translation

$ openai audio:translations create

post /audio/translations

Translates audio into English.

Parameters

• --file: string

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

• --model: string or AudioModel

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

• --prompt: optional string

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

• --response-format: optional "json" or "text" or "srt" or 2 more

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

• --temperature: optional 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.

Returns

• unnamed_schema_1: Translation or TranslationVerbose

  • translation: object { text }

    • text: string

  • translation_verbose: object { duration, language, text, segments }

    • duration: number

      The duration of the input audio.

    • language: string

      The language of the output translation (always english).

    • text: string

      The translated text.

    • segments: optional array of TranscriptionSegment

      Segments of the translated text and their corresponding details.

      • id: number

        Unique identifier of the segment.

      • avg_logprob: number

        Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.

      • compression_ratio: number

        Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.

      • end: number

        End time of the segment in seconds.

      • no_speech_prob: number

        Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.

      • seek: number

        Seek offset of the segment.

      • start: number

        Start time of the segment in seconds.

      • temperature: number

        Temperature parameter used for generating the segment.

      • text: string

        Text content of the segment.

      • tokens: array of number

        Array of token IDs for the text content.

Example

openai audio:translations create \
  --api-key 'My API Key' \
  --file 'Example data' \
  --model whisper-1

Response

{
  "text": "text"
}

Domain Types

Translation

• translation: object { text }

  • text: string

Translation Verbose

• translation_verbose: object { duration, language, text, segments }

  • duration: number

    The duration of the input audio.

  • language: string

    The language of the output translation (always english).

  • text: string

    The translated text.

  • segments: optional array of TranscriptionSegment

    Segments of the translated text and their corresponding details.

    • id: number

      Unique identifier of the segment.

    • avg_logprob: number

      Average logprob of the segment. If the value is lower than -1, consider the logprobs failed.

    • compression_ratio: number

      Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed.

    • end: number

      End time of the segment in seconds.

    • no_speech_prob: number

      Probability of no speech in the segment. If the value is higher than 1.0 and the avg_logprob is below -1, consider this segment silent.

    • seek: number

      Seek offset of the segment.

    • start: number

      Start time of the segment in seconds.

    • temperature: number

      Temperature parameter used for generating the segment.

    • text: string

      Text content of the segment.

    • tokens: array of number

      Array of token IDs for the text content.