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/readers/assembly-ai/dist/index.d.ts:17
Properties
clientPromise
protected
clientPromise:Promise
<AssemblyAI
>
Inherited from
AssemblyAIReader.clientPromise
Defined in
packages/readers/assembly-ai/dist/index.d.ts:11
Methods
getTranscriptId()
protected
getTranscriptId(params
):Promise
<string
>
Parameters
• params: string
| TranscribeParams
Returns
Promise
<string
>
Inherited from
AssemblyAIReader.getTranscriptId
Defined in
packages/readers/assembly-ai/dist/index.d.ts:20
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
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/readers/assembly-ai/dist/index.d.ts:65
transcribeOrGetTranscript()
protected
transcribeOrGetTranscript(params
):Promise
<Transcript
>
Parameters
• params: string
| TranscribeParams
Returns
Promise
<Transcript
>
Inherited from
AssemblyAIReader.transcribeOrGetTranscript
Defined in
packages/readers/assembly-ai/dist/index.d.ts:19