openai_client
v0.5.3

OpenAI.Audio (openai_client v0.5.3)

Learn how to turn audio into text.

Related guide: Speech to text

https://platform.openai.com/docs/api-reference/audio

Link to this section Summary

Types

create_transcription_params()
create_translation_params()

Functions

create_transcription(client, params, opts \\ [])

Transcribes audio into the input language.

create_translation(client, params, opts \\ [])

Translates audio into English.

Link to this section Types

Link to this type

create_transcription_params()

@type create_transcription_params() :: %{
  :file => iodata(),
  :filename => String.t(),
  :model => String.t(),
  optional(:prompt) => String.t(),
  optional(:response_format) => String.t(),
  optional(:temperature) => float(),
  optional(:language) => String.t()
}
Link to this type

create_translation_params()

@type create_translation_params() :: %{
  :file => String.t(),
  :model => String.t(),
  optional(:prompt) => String.t(),
  optional(:response_format) => String.t(),
  optional(:temperature) => float()
}

Link to this section Functions

Link to this function

create_transcription(client, params, opts \\ [])

@spec create_transcription(
  OpenAI.Client.t(),
  create_transcription_params(),
  Keyword.t()
) ::
  OpenAI.Client.result()

Transcribes audio into the input language.

Link to this function

create_translation(client, params, opts \\ [])

@spec create_translation(OpenAI.Client.t(), create_translation_params(), Keyword.t()) ::
  OpenAI.Client.result()

Translates audio into English.