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
Inherited from
AssemblyAIReader.constructor
Defined in
packages/llamaindex/src/readers/AssemblyAIReader.ts:32
Properties
client
protectedclient:AssemblyAI
Inherited from
AssemblyAIReader.client
Defined in
packages/llamaindex/src/readers/AssemblyAIReader.ts:25
Methods
getTranscriptId()
protectedgetTranscriptId(params):Promise<string>
Parameters
• params: string | TranscribeParams
Returns
Promise<string>
Inherited from
AssemblyAIReader.getTranscriptId
Defined in
packages/llamaindex/src/readers/AssemblyAIReader.ts:62
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
A promise that resolves a document containing the subtitles as the page content.
Overrides
AssemblyAIReader.loadData
Defined in
packages/llamaindex/src/readers/AssemblyAIReader.ts:134
transcribeOrGetTranscript()
protectedtranscribeOrGetTranscript(params):Promise<Transcript>
Parameters
• params: string | TranscribeParams
Returns
Promise<Transcript>
Inherited from
AssemblyAIReader.transcribeOrGetTranscript