Class: AudioTranscriptReader
Transcribe audio and read the transcript as a document using AssemblyAI.
Hierarchy
-
AssemblyAIReader
↳
AudioTranscriptReader
Constructors
constructor
• new AudioTranscriptReader(assemblyAIOptions?
): AudioTranscriptReader
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
): Promise
<Document
<Metadata
>[]>
Transcribe audio or get a transcript and load the transcript as a document using AssemblyAI.
Parameters
Name | Type | Description |
---|---|---|
params | string | TranscribeParams | Parameters to transcribe an audio file or get an existing transcript. |
Returns
A promise that resolves to a single document containing the transcript text.
Overrides
AssemblyAIReader.loadData
Defined in
packages/core/src/readers/AssemblyAIReader.ts:71
transcribeOrGetTranscript
▸ transcribeOrGetTranscript(params
): Promise
<Transcript
>
Parameters
Name | Type |
---|---|
params | string | TranscribeParams |
Returns
Promise
<Transcript
>
Inherited from
AssemblyAIReader.transcribeOrGetTranscript