Skip to main content

Class: AudioTranscriptSentencesReader

Transcribe audio and return a document for each sentence.

Hierarchy

  • AssemblyAIReader

    AudioTranscriptSentencesReader

Constructors

constructor

new AudioTranscriptSentencesReader(assemblyAIOptions?): AudioTranscriptSentencesReader

Creates a new AssemblyAI Reader.

Parameters

NameTypeDescription
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

AudioTranscriptSentencesReader

Inherited from

AssemblyAIReader.constructor

Defined in

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

Properties

client

Protected client: AssemblyAI

Inherited from

AssemblyAIReader.client

Defined in

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

Methods

getTranscriptId

getTranscriptId(params): Promise<string>

Parameters

NameType
paramsstring | TranscribeParams

Returns

Promise<string>

Inherited from

AssemblyAIReader.getTranscriptId

Defined in

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


loadData

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

Transcribe audio or get a transcript, and returns a document for each sentence.

Parameters

NameTypeDescription
paramsstring | TranscribeParamsThe parameters to transcribe audio or get an existing transcript.

Returns

Promise<Document<Metadata>[]>

A promise that resolves to an array of documents, each containing a sentence of the transcript.

Overrides

AssemblyAIReader.loadData

Defined in

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


transcribeOrGetTranscript

transcribeOrGetTranscript(params): Promise<Transcript>

Parameters

NameType
paramsstring | TranscribeParams

Returns

Promise<Transcript>

Inherited from

AssemblyAIReader.transcribeOrGetTranscript

Defined in

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