Class: AudioSubtitlesReader
Transcribe audio a transcript and read subtitles for the transcript as srt or vtt format.
Hierarchy
-
AssemblyAIReader↳
AudioSubtitlesReader
Constructors
constructor
• new AudioSubtitlesReader(assemblyAIOptions?): AudioSubtitlesReader
Creates a new AssemblyAI Reader.
Parameters
| Name | Type | Description |
|---|---|---|
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
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
| Name | Type |
|---|---|
params | string | TranscribeParams |
Returns
Promise<string>
Inherited from
AssemblyAIReader.getTranscriptId
Defined in
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
| Name | Type | Default value | Description |
|---|---|---|---|
params | string | TranscribeParams | undefined | The parameters to transcribe audio or get an existing transcript. |
subtitleFormat | SubtitleFormat | "srt" | The format of the subtitles, either srt or vtt. |
Returns
A promise that resolves a document containing the subtitles as the page content.
Overrides
AssemblyAIReader.loadData
Defined in
packages/core/src/readers/AssemblyAIReader.ts:125
transcribeOrGetTranscript
▸ transcribeOrGetTranscript(params): Promise<Transcript>
Parameters
| Name | Type |
|---|---|
params | string | TranscribeParams |
Returns
Promise<Transcript>
Inherited from
AssemblyAIReader.transcribeOrGetTranscript