Class OpenAIWhisperAudio

Example

const loader = new OpenAIWhisperAudio(
  "./src/document_loaders/example_data/test.mp3",
);
const docs = await loader.load();
console.log(docs);

Hierarchy (view full)

Constructors

constructor

Properties

filePathOrBlob

Methods

load loadAndSplit imports parse

Constructors

constructor

Properties

filePathOrBlob

filePathOrBlob: string | Blob

Methods

load

  • load(): Promise<Document[]>

  • Method that reads the buffer contents and metadata based on the type of filePathOrBlob, and then calls the parse() method to parse the buffer and return the documents.

    Returns Promise<Document[]>

    Promise that resolves with an array of Document objects.

loadAndSplit

  • loadAndSplit(splitter?): Promise<Document[]>

  • Loads the documents and splits them using a specified text splitter.

    Parameters

    • splitter: TextSplitter = ...

    Returns Promise<Document[]>

    A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.

Static imports

  • imports(): Promise<{
        readFile: {
            (path, options?): Promise<Buffer>;
            (path, options): Promise<string>;
            (path, options?): Promise<string | Buffer>;
        };
    }>

  • Static method that imports the readFile function from the fs/promises module in Node.js. It is used to dynamically import the function when needed. If the import fails, it throws an error indicating that the fs/promises module is not available in the current environment.

    Returns Promise<{
        readFile: {
            (path, options?): Promise<Buffer>;
            (path, options): Promise<string>;
            (path, options?): Promise<string | Buffer>;
        };
    }>

    Promise that resolves with an object containing the readFile function.

Protected parse

  • parse(raw, metadata): Promise<Document[]>

  • Abstract method that needs to be implemented by subclasses. It is used to parse the buffer and return the documents.

    Parameters

    • raw: Buffer

      The buffer to be parsed.

    • metadata: Record<string, string>

      Metadata of the document.

    Returns Promise<Document[]>

    Promise that resolves with an array of Document objects.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc