Cloud

openai_translation

Available in: Cloud, Self-Managed

Translates spoken audio into English, using the OpenAI API.

  • Common

  • Advanced

processors:
  label: ""
  openai_translation:
    server_address: https://api.openai.com/v1
    api_key: "" # No default (required)
    model: "" # No default (required)
    file: "" # No default (optional)
processors:
  label: ""
  openai_translation:
    server_address: https://api.openai.com/v1
    api_key: "" # No default (required)
    model: "" # No default (required)
    file: "" # No default (optional)
    prompt: "" # No default (optional)

This processor sends an audio file object to OpenAI API to generate a translation. By default, the processor submits the entire payload of each message as a string, unless you use the file configuration field to customize it.

To learn more about translation, see the OpenAI API documentation.

Fields

api_key

The API key for OpenAI API.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration.

Type: string

file

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

Type: string

model

The name of the OpenAI model to use.

Type: string

# Examples:
model: whisper-1

prompt

Optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language. This field supports interpolation functions.

Type: string

server_address

The Open API endpoint that the processor sends requests to. Update the default value to use another OpenAI compatible service.

Type: string

Default: https://api.openai.com/v1