View Source OpenaiEx.Audio.Speech (openai_ex v0.5.0)

This module provides an implementation of the OpenAI audio speech API. The API reference can be found at https://platform.openai.com/docs/api-reference/audio/createSpeech.

API Fields

The following fields can be used as parameters when creating a new audio speech request:

  • :input
  • :model
  • :voice
  • :response_format
  • :speed

Summary

Functions

create(openai, audio)

Calls the audio speech endpoint.

new(args)

Creates a new audio speech request with the given arguments.

Functions

Link to this function

create(openai, audio)

View Source

Calls the audio speech endpoint.

Arguments

  • openai: A map containing the OpenAI configuration.
  • audio: A map containing the audio speech request.

Returns

A map containing the audio speech response.

See https://platform.openai.com/docs/api-reference/audio/createSpeech for more information.

Link to this function

new(args)

View Source

Creates a new audio speech request with the given arguments.

Arguments

  • args: A list of key-value pairs, or a map, representing the fields of the audio speech request.

Returns

A map containing the fields of the audio speech request.

The :file and :model fields are required.