ExOpenAI.Audio.create_transcription

You're seeing just the function create_transcription, go back to ExOpenAI.Audio module for more information.
Link to this function

create_transcription(file, model, opts \\ [])

View Source

Specs

create_transcription(bitstring(), any(),
  openai_organization_key: String.t(),
  openai_api_key: String.t(),
  temperature: float(),
  response_format: String.t(),
  prompt: String.t(),
  language: String.t(),
  stream_to: pid()
) ::
  {: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 object (not file name) to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

  • model: ID of the model to use. Only whisper-1 is currently available.

Optional Arguments:

  • stream_to: PID of the process to stream content to

  • 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.

  • openai_api_key: OpenAI API key to pass directly. If this is specified, it will override the api_key config value.

  • openai_organization_key: OpenAI API key to pass directly. If this is specified, it will override the organization_key config value.