Skip to main content

openai_speech

Generates audio from a text description and other attributes, using OpenAI API.

# Common config fields, showing default values
pipeline:
  processors:
    - label: ""
      openai_speech:
        server_address: "https://api.openai.com/v1"
        api_key: "" # No default (required)
        model: "" # No default (required)
        input: "" # No default (optional)
        voice: "" # No default (required)

This processor sends a text description and other attributes, such as a voice type and format to the OpenAI API, which generates audio. By default, the processor submits the entire payload of each message as a string, unless you use the input configuration field to customize it.

To learn more about turning text into spoken audio, see the OpenAI API documentation.

Fields​

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"

api_key​

The API key for OpenAI API.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string

model​

The name of the OpenAI model to use.

Type: string

input​

A text description of the audio you want to generate. The input field accepts a maximum of 4096 characters.

Type: string

voice​

The type of voice to use when generating the audio.

This field supports interpolation functions.

Type: string

response_format​

The format to generate audio in. Default is mp3.

This field supports interpolation functions.

Type: string