Skip to content

@ralphschuler.ai function caller.index.<internal>.OpenAI.Audio.Transcriptions.TranscriptionCreateParams

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: TranscriptionCreateParams

Audio.Transcriptions.TranscriptionCreateParams

Table of contents

Properties

Properties

file

file: Uploadable

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

Defined in

node_modules/openai/resources/audio/transcriptions.d.ts:19


language

Optional language: string

The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.

Defined in

node_modules/openai/resources/audio/transcriptions.d.ts:29


model

model: string & {} | "whisper-1"

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

Defined in

node_modules/openai/resources/audio/transcriptions.d.ts:23


prompt

Optional prompt: string

An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.

Defined in

node_modules/openai/resources/audio/transcriptions.d.ts:36


response_format

Optional response_format: "json" | "text" | "srt" | "verbose_json" | "vtt"

The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.

Defined in

node_modules/openai/resources/audio/transcriptions.d.ts:41


temperature

Optional temperature: number

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.

Defined in

node_modules/openai/resources/audio/transcriptions.d.ts:49

Typescript Libraries

Modules

Namespaces

Clone this wiki locally