AudioSubtitlesReader
Defined in: .build/typescript/packages/providers/assemblyai/src/reader.ts:134
Transcribe audio a transcript and read subtitles for the transcript as srt or vtt format.
Extends
Section titled “Extends”AssemblyAIReader
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AudioSubtitlesReader(
assemblyAIOptions?):AudioSubtitlesReader
Defined in: .build/typescript/packages/providers/assemblyai/src/reader.ts:33
Creates a new AssemblyAI Reader.
Parameters
Section titled “Parameters”assemblyAIOptions?
Section titled “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
Section titled “Returns”AudioSubtitlesReader
Inherited from
Section titled “Inherited from”AssemblyAIReader.constructor
Properties
Section titled “Properties”clientPromise
Section titled “clientPromise”
protectedclientPromise:Promise<AssemblyAI>
Defined in: .build/typescript/packages/providers/assemblyai/src/reader.ts:26
Inherited from
Section titled “Inherited from”AssemblyAIReader.clientPromise
Methods
Section titled “Methods”transcribeOrGetTranscript()
Section titled “transcribeOrGetTranscript()”
protectedtranscribeOrGetTranscript(params):Promise<Transcript>
Defined in: .build/typescript/packages/providers/assemblyai/src/reader.ts:58
Parameters
Section titled “Parameters”params
Section titled “params”string | TranscribeParams
Returns
Section titled “Returns”Promise<Transcript>
Inherited from
Section titled “Inherited from”AssemblyAIReader.transcribeOrGetTranscript
getTranscriptId()
Section titled “getTranscriptId()”
protectedgetTranscriptId(params):Promise<string>
Defined in: .build/typescript/packages/providers/assemblyai/src/reader.ts:67
Parameters
Section titled “Parameters”params
Section titled “params”string | TranscribeParams
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”AssemblyAIReader.getTranscriptId
loadData()
Section titled “loadData()”loadData(
params,subtitleFormat):Promise<Document<Metadata>[]>
Defined in: .build/typescript/packages/providers/assemblyai/src/reader.ts:141
Transcribe audio or get a transcript and reads subtitles for the transcript as srt or vtt format.
Parameters
Section titled “Parameters”params
Section titled “params”The parameters to transcribe audio or get an existing transcript.
string | TranscribeParams
subtitleFormat
Section titled “subtitleFormat”SubtitleFormat = "srt"
The format of the subtitles, either srt or vtt.
Returns
Section titled “Returns”Promise<Document<Metadata>[]>
A promise that resolves a document containing the subtitles as the page content.
Overrides
Section titled “Overrides”AssemblyAIReader.loadData