Class that extends the TextLoader class. It represents a document loader that loads documents from JSON files. It has a constructor that takes a filePathOrBlob parameter representing the path to the JSON file or a Blob object, and an optional pointers parameter that specifies the JSON pointers to extract.

Hierarchy

Constructors

Properties

filePathOrBlob: string | Blob
pointers: string[]

Methods

  • A method that loads the text file or blob and returns a promise that resolves to an array of Document instances. It reads the text from the file or blob using the readFile function from the node:fs/promises module or the text() method of the blob. It then parses the text using the parse() method and creates a Document instance for each parsed page. The metadata includes the source of the text (file path or blob) and, if there are multiple pages, the line number of each page.

    Returns Promise<Document<Record<string, any>>[]>

    A promise that resolves to an array of Document instances.

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

    Parameters

    Returns Promise<Document<Record<string, any>>[]>

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

  • A static method that imports the readFile function from the node:fs/promises module. 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>;
        };
    }>

    A promise that resolves to an object containing the readFile function from the node:fs/promises module.

  • Method that takes a raw string as a parameter and returns a promise that resolves to an array of strings. It parses the raw JSON string and extracts the values based on the specified JSON pointers. If no JSON pointers are specified, it extracts all the strings from the JSON object.

    Parameters

    • raw: string

      The raw JSON string to parse.

    Returns Promise<string[]>

    A promise that resolves to an array of strings.

Generated using TypeDoc