Class AudioSubtitleLoader

Transcribe audio and load subtitles for the transcript as srt or vtt format.

Hierarchy

CreateTranscriptLoader
- AudioSubtitleLoader

Index

Constructors

Properties

client transcribeParams? transcriptId?

Methods

load loadAndSplit transcribeOrGetTranscript

Constructors

constructor

new AudioSubtitleLoader(transcribeParams, subtitleFormat, assemblyAIOptions?): AudioSubtitleLoader
Create a new AudioSubtitleLoader.
Parameters
- transcribeParams: TranscriptParams | TranscribeParams
  
  The parameters to transcribe audio.
- subtitleFormat: SubtitleFormat
  
  The format of the subtitles, either srt or vtt.
- Optional assemblyAIOptions: AssemblyAIOptions
  
  The options to configure the AssemblyAI loader. Configure the assemblyAIOptions.apiKey with your AssemblyAI API key, or configure it as the ASSEMBLYAI_API_KEY environment variable.
Returns AudioSubtitleLoader
Overrides CreateTranscriptLoader.constructor
- Defined in langchain/src/document_loaders/web/assemblyai.ts:169
new AudioSubtitleLoader(transcriptId, subtitleFormat, assemblyAIOptions?): AudioSubtitleLoader
Create a new AudioSubtitleLoader.
Parameters
- transcriptId: string
  
  The ID of the transcript to retrieve.
- subtitleFormat: SubtitleFormat
  
  The format of the subtitles, either srt or vtt.
- Optional assemblyAIOptions: AssemblyAIOptions
  
  The options to configure the AssemblyAI loader. Configure the assemblyAIOptions.apiKey with your AssemblyAI API key, or configure it as the ASSEMBLYAI_API_KEY environment variable.
Returns AudioSubtitleLoader
Overrides CreateTranscriptLoader.constructor
- Defined in langchain/src/document_loaders/web/assemblyai.ts:182

Properties

`Protected` client

client: AssemblyAI

`Protected` `Optional` transcribeParams

transcribeParams?: TranscriptParams | TranscribeParams

`Protected` `Optional` transcriptId

transcriptId?: string

Methods

load

load(): Promise<Document<Record<string, any>>[]>
Transcribe audio and load subtitles for the transcript as srt or vtt format.

Returns Promise<Document<Record<string, any>>[]>
A promise that resolves a document containing the subtitles as the page content.
Overrides CreateTranscriptLoader.load
- Defined in langchain/src/document_loaders/web/assemblyai.ts:208

loadAndSplit

loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>
Loads the documents and splits them using a specified text splitter.
Parameters
- splitter: TextSplitter = ...
Returns Promise<Document<Record<string, any>>[]>
A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
Inherited from CreateTranscriptLoader.loadAndSplit
- Defined in langchain/src/document_loaders/base.ts:32

`Protected` transcribeOrGetTranscript

transcribeOrGetTranscript(): Promise<Transcript>
Returns Promise<Transcript>
Inherited from CreateTranscriptLoader.transcribeOrGetTranscript
- Defined in langchain/src/document_loaders/web/assemblyai.ts:69

Generated using TypeDoc