Skip to main content

Class: AudioTranscriptReader

Transcribe audio and read the transcript as a document using AssemblyAI.

Extends

  • AssemblyAIReader

Constructors

new AudioTranscriptReader()

new AudioTranscriptReader(assemblyAIOptions?): AudioTranscriptReader

Creates a new AssemblyAI Reader.

Parameters

assemblyAIOptions?: Partial<BaseServiceParams>

The options to configure the AssemblyAI Reader. Configure the assemblyAIOptions.apiKey with your AssemblyAI API key, or configure it as the ASSEMBLYAI_API_KEY environment variable.

Returns

AudioTranscriptReader

Inherited from

AssemblyAIReader.constructor

Defined in

packages/llamaindex/src/readers/AssemblyAIReader.ts:26

Properties

client

protected client: AssemblyAI

Inherited from

AssemblyAIReader.client

Defined in

packages/llamaindex/src/readers/AssemblyAIReader.ts:19

Methods

getTranscriptId()

protected getTranscriptId(params): Promise<string>

Parameters

params: string | TranscribeParams

Returns

Promise<string>

Inherited from

AssemblyAIReader.getTranscriptId

Defined in

packages/llamaindex/src/readers/AssemblyAIReader.ts:53


loadData()

loadData(params): Promise<Document<Metadata>[]>

Transcribe audio or get a transcript and load the transcript as a document using AssemblyAI.

Parameters

params: string | TranscribeParams

Parameters to transcribe an audio file or get an existing transcript.

Returns

Promise<Document<Metadata>[]>

A promise that resolves to a single document containing the transcript text.

Overrides

AssemblyAIReader.loadData

Defined in

packages/llamaindex/src/readers/AssemblyAIReader.ts:71


transcribeOrGetTranscript()

protected transcribeOrGetTranscript(params): Promise<Transcript>

Parameters

params: string | TranscribeParams

Returns

Promise<Transcript>

Inherited from

AssemblyAIReader.transcribeOrGetTranscript

Defined in

packages/llamaindex/src/readers/AssemblyAIReader.ts:45