ExOpenAI.Audio (ex_openai.ex v1.0.4) View Source
Modules for interacting with the audio group of OpenAI APIs
API Reference: https://platform.openai.com/docs/api-reference/audio
Link to this section Summary
Link to this section Functions
Specs
create_transcription(bitstring(), String.t(), temperature: float(), response_format: String.t(), prompt: String.t(), language: String.t() ) :: {:ok, ExOpenAI.Components.CreateTranscriptionResponse.t()} | {:error, any()}
Transcribes audio into the input language.
Endpoint: https://api.openai.com/v1/audio/transcriptions
Method: POST
Docs: https://platform.openai.com/docs/api-reference/audio
Required Arguments:
file: The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.model: ID of the model to use. Onlywhisper-1is currently available.
Optional Arguments:
language: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.prompt: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.response_format: The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.temperature: 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.
Specs
create_translation(bitstring(), String.t(), temperature: float(), response_format: String.t(), prompt: String.t() ) :: {:ok, ExOpenAI.Components.CreateTranslationResponse.t()} | {:error, any()}
Translates audio into into English.
Endpoint: https://api.openai.com/v1/audio/translations
Method: POST
Docs: https://platform.openai.com/docs/api-reference/audio
Required Arguments:
file: The audio file to translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.model: ID of the model to use. Onlywhisper-1is currently available.
Optional Arguments:
prompt: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English.response_format: The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.temperature: 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.