Class: AudioSubtitlesReader

Transcribe audio a transcript and read subtitles for the transcript as srt or vtt format.

Extends

• AssemblyAIReader

Constructors

new AudioSubtitlesReader()

new AudioSubtitlesReader(assemblyAIOptions?): AudioSubtitlesReader

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

AudioSubtitlesReader

Inherited from

AssemblyAIReader.constructor

Source

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

Properties

client

protected client: AssemblyAI

Inherited from

AssemblyAIReader.client

Source

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

Methods

getTranscriptId()

protected getTranscriptId(params): Promise<string>

Parameters

• params: string | TranscribeParams

Returns

Promise<string>

Inherited from

AssemblyAIReader.getTranscriptId

Source

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

---

loadData()

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

Transcribe audio or get a transcript and reads subtitles for the transcript as srt or vtt format.

Parameters

• params: string | TranscribeParams

The parameters to transcribe audio or get an existing transcript.

• subtitleFormat: SubtitleFormat= "srt"

The format of the subtitles, either srt or vtt.

Returns

Promise <Document <Metadata>[]>

A promise that resolves a document containing the subtitles as the page content.

Overrides

AssemblyAIReader.loadData

Source

packages/core/src/readers/AssemblyAIReader.ts:125

---

transcribeOrGetTranscript()

protected transcribeOrGetTranscript(params): Promise<Transcript>

Parameters

• params: string | TranscribeParams

Returns

Promise<Transcript>

Inherited from

AssemblyAIReader.transcribeOrGetTranscript

Source

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