`transcribe()`

transcribe is an experimental feature.

Generates a transcript from an audio file.

import { experimental_transcribe as transcribe } from 'ai';
import { openai } from '@ai-sdk/openai';
import { readFile } from 'fs/promises';

const { text: transcript } = await transcribe({
  model: openai.transcription('whisper-1'),
  audio: await readFile('audio.mp3'),
});

console.log(transcript);

Import

import { experimental_transcribe as transcribe } from "ai"

API Signature

Parameters

model:

TranscriptionModelV3

audio:

DataContent (string | Uint8Array | ArrayBuffer | Buffer) | URL

providerOptions?:

Record<string, JSONObject>

maxRetries?:

number

abortSignal?:

AbortSignal

headers?:

Record<string, string>

download?:

(options: { url: URL; abortSignal?: AbortSignal }) => Promise<{ data: Uint8Array; mediaType: string | undefined }>

Returns

text:

string

segments:

Array<{ text: string; startSecond: number; endSecond: number }>

language:

string | undefined

durationInSeconds:

number | undefined

warnings:

Warning[]

providerMetadata?:

Record<string, JSONObject>

responses:

Array<TranscriptionModelResponseMetadata>

TranscriptionModelResponseMetadata

timestamp:

Date

modelId:

string

headers?:

Record<string, string>