langchain 0.0.130 → 0.0.132

package/dist/chat_models/googlevertexai.js

@@ -1,6 +1,9 @@
 import { BaseChatModel } from "./base.js";
 import { AIMessage, ChatMessage, } from "../schema/index.js";
 import { GoogleVertexAIConnection } from "../util/googlevertexai-connection.js";
+/**
+ * Represents a chat message in the Google Vertex AI chat model.
+ */
 export class GoogleVertexAIChatMessage {
     constructor(fields) {
         Object.defineProperty(this, "author", {
@@ -25,6 +28,12 @@ export class GoogleVertexAIChatMessage {
         this.content = fields.content;
         this.name = fields.name;
     }
+    /**
+     * Extracts the role of a generic message and maps it to a Google Vertex
+     * AI chat author.
+     * @param message The chat message to extract the role from.
+     * @returns The role of the message mapped to a Google Vertex AI chat author.
+     */
     static extractGenericMessageCustomRole(message) {
         if (message.role !== "system" &&
             message.role !== "bot" &&
@@ -34,6 +43,12 @@ export class GoogleVertexAIChatMessage {
         }
         return message.role;
     }
+    /**
+     * Maps a message type to a Google Vertex AI chat author.
+     * @param message The message to map.
+     * @param model The model to use for mapping.
+     * @returns The message type mapped to a Google Vertex AI chat author.
+     */
     static mapMessageTypeToVertexChatAuthor(message, model) {
         const type = message._getType();
         switch (type) {
@@ -52,6 +67,12 @@ export class GoogleVertexAIChatMessage {
                 throw new Error(`Unknown / unsupported message type: ${message}`);
         }
     }
+    /**
+     * Creates a new Google Vertex AI chat message from a base message.
+     * @param message The base message to convert.
+     * @param model The model to use for conversion.
+     * @returns A new Google Vertex AI chat message.
+     */
     static fromChatMessage(message, model) {
         return new GoogleVertexAIChatMessage({
             author: GoogleVertexAIChatMessage.mapMessageTypeToVertexChatAuthor(message, model),
@@ -74,8 +95,17 @@ export class GoogleVertexAIChatMessage {
  *   Google Cloud project using Vertex AI.
  */
 export class ChatGoogleVertexAI extends BaseChatModel {
+    static lc_name() {
+        return "ChatGoogleVertexAI";
+    }
     constructor(fields) {
         super(fields ?? {});
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
@@ -151,6 +181,11 @@ export class ChatGoogleVertexAI extends BaseChatModel {
     _llmType() {
         return "googlevertexai";
     }
+    /**
+     * Creates an instance of the Google Vertex AI chat model.
+     * @param messages The messages for the model instance.
+     * @returns A new instance of the Google Vertex AI chat model.
+     */
     createInstance(messages) {
         let context = "";
         let conversationMessages = messages;
@@ -184,6 +219,12 @@ export class ChatGoogleVertexAI extends BaseChatModel {
         };
         return instance;
     }
+    /**
+     * Converts a prediction from the Google Vertex AI chat model to a chat
+     * generation.
+     * @param prediction The prediction to convert.
+     * @returns The converted chat generation.
+     */
     static convertPrediction(prediction) {
         const message = prediction?.candidates[0];
         return {

package/dist/chat_models/ollama.cjs

@@ -4,7 +4,15 @@ exports.ChatOllama = void 0;
 const base_js_1 = require("./base.cjs");
 const ollama_js_1 = require("../util/ollama.cjs");
 const index_js_1 = require("../schema/index.cjs");
+/**
+ * A class that enables calls to the Ollama API to access large language
+ * models in a chat-like fashion. It extends the SimpleChatModel class and
+ * implements the OllamaInput interface.
+ */
 class ChatOllama extends base_js_1.SimpleChatModel {
+    static lc_name() {
+        return "ChatOllama";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_serializable", {
@@ -124,6 +132,12 @@ class ChatOllama extends base_js_1.SimpleChatModel {
     _llmType() {
         return "ollama";
     }
+    /**
+     * A method that returns the parameters for an Ollama API call. It
+     * includes model and options parameters.
+     * @param options Optional parsed call options.
+     * @returns An object containing the parameters for an Ollama API call.
+     */
     invocationParams(options) {
         return {
             model: this.model,

package/dist/chat_models/ollama.d.ts

@@ -3,10 +3,20 @@ import { BaseLanguageModelCallOptions } from "../base_language/index.js";
 import { OllamaInput } from "../util/ollama.js";
 import { CallbackManagerForLLMRun } from "../callbacks/manager.js";
 import { BaseMessage, ChatGenerationChunk } from "../schema/index.js";
+/**
+ * An interface defining the options for an Ollama API call. It extends
+ * the BaseLanguageModelCallOptions interface.
+ */
 export interface OllamaCallOptions extends BaseLanguageModelCallOptions {
 }
+/**
+ * A class that enables calls to the Ollama API to access large language
+ * models in a chat-like fashion. It extends the SimpleChatModel class and
+ * implements the OllamaInput interface.
+ */
 export declare class ChatOllama extends SimpleChatModel implements OllamaInput {
     CallOptions: OllamaCallOptions;
+    static lc_name(): string;
     lc_serializable: boolean;
     model: string;
     baseUrl: string;
@@ -25,6 +35,12 @@ export declare class ChatOllama extends SimpleChatModel implements OllamaInput {
     topP?: number;
     constructor(fields: OllamaInput & BaseChatModelParams);
     _llmType(): string;
+    /**
+     * A method that returns the parameters for an Ollama API call. It
+     * includes model and options parameters.
+     * @param options Optional parsed call options.
+     * @returns An object containing the parameters for an Ollama API call.
+     */
     invocationParams(options?: this["ParsedCallOptions"]): {
         model: string;
         options: {

package/dist/chat_models/ollama.js

@@ -1,7 +1,15 @@
 import { SimpleChatModel } from "./base.js";
 import { createOllamaStream } from "../util/ollama.js";
 import { AIMessageChunk, ChatGenerationChunk, ChatMessage, } from "../schema/index.js";
+/**
+ * A class that enables calls to the Ollama API to access large language
+ * models in a chat-like fashion. It extends the SimpleChatModel class and
+ * implements the OllamaInput interface.
+ */
 export class ChatOllama extends SimpleChatModel {
+    static lc_name() {
+        return "ChatOllama";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_serializable", {
@@ -121,6 +129,12 @@ export class ChatOllama extends SimpleChatModel {
     _llmType() {
         return "ollama";
     }
+    /**
+     * A method that returns the parameters for an Ollama API call. It
+     * includes model and options parameters.
+     * @param options Optional parsed call options.
+     * @returns An object containing the parameters for an Ollama API call.
+     */
     invocationParams(options) {
         return {
             model: this.model,

package/dist/chat_models/openai.cjs

@@ -5,15 +5,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PromptLayerChatOpenAI = exports.ChatOpenAI = void 0;
 const openai_1 = require("openai");
-const env_js_1 = require("../util/env.cjs");
-const axios_fetch_adapter_js_1 = __importDefault(require("../util/axios-fetch-adapter.cjs"));
-const base_js_1 = require("./base.cjs");
-const index_js_1 = require("../schema/index.cjs");
 const count_tokens_js_1 = require("../base_language/count_tokens.cjs");
-const prompt_layer_js_1 = require("../util/prompt-layer.cjs");
+const index_js_1 = require("../schema/index.cjs");
 const convert_to_openai_js_1 = require("../tools/convert_to_openai.cjs");
+const axios_fetch_adapter_js_1 = __importDefault(require("../util/axios-fetch-adapter.cjs"));
 const azure_js_1 = require("../util/azure.cjs");
+const env_js_1 = require("../util/env.cjs");
+const prompt_layer_js_1 = require("../util/prompt-layer.cjs");
 const stream_js_1 = require("../util/stream.cjs");
+const base_js_1 = require("./base.cjs");
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "system" &&
         message.role !== "assistant" &&
@@ -111,6 +111,9 @@ delta, defaultRole) {
  * if not explicitly available on this class.
  */
 class ChatOpenAI extends base_js_1.BaseChatModel {
+    static lc_name() {
+        return "ChatOpenAI";
+    }
     get callKeys() {
         return [
             ...super.callKeys,
@@ -125,6 +128,7 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
         return {
             openAIApiKey: "OPENAI_API_KEY",
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
+            organization: "OPENAI_ORGANIZATION",
         };
     }
     get lc_aliases() {
@@ -261,6 +265,12 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "organization", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -293,6 +303,9 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
         this.azureOpenAIBasePath =
             fields?.azureOpenAIBasePath ??
                 (0, env_js_1.getEnvironmentVariable)("AZURE_OPENAI_BASE_PATH");
+        this.organization =
+            fields?.configuration?.organization ??
+                (0, env_js_1.getEnvironmentVariable)("OPENAI_ORGANIZATION");
         this.modelName = fields?.modelName ?? this.modelName;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.timeout = fields?.timeout;
@@ -319,6 +332,7 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
         }
         this.clientConfig = {
             apiKey: this.openAIApiKey,
+            organization: this.organization,
             ...configuration,
             ...fields?.configuration,
         };

package/dist/chat_models/openai.d.ts

@@ -1,11 +1,11 @@
-import { CreateChatCompletionRequest, ConfigurationParameters, CreateChatCompletionResponse, ChatCompletionFunctions, CreateChatCompletionRequestFunctionCall } from "openai";
+import { ChatCompletionFunctions, ConfigurationParameters, CreateChatCompletionRequest, CreateChatCompletionRequestFunctionCall, CreateChatCompletionResponse } from "openai";
+import { CallbackManagerForLLMRun } from "../callbacks/manager.js";
+import { BaseMessage, ChatGenerationChunk, ChatResult } from "../schema/index.js";
+import { StructuredTool } from "../tools/base.js";
 import { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput } from "../types/openai-types.js";
 import type { StreamingAxiosConfiguration } from "../util/axios-types.js";
 import { BaseChatModel, BaseChatModelParams } from "./base.js";
-import { BaseMessage, ChatGenerationChunk, ChatResult } from "../schema/index.js";
-import { CallbackManagerForLLMRun } from "../callbacks/manager.js";
-import { StructuredTool } from "../tools/base.js";
-export { OpenAICallOptions, OpenAIChatInput, AzureOpenAIInput };
+export { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput };
 interface TokenUsage {
     completionTokens?: number;
     promptTokens?: number;
@@ -40,6 +40,7 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions {
  * if not explicitly available on this class.
  */
 export declare class ChatOpenAI extends BaseChatModel<ChatOpenAICallOptions> implements OpenAIChatInput, AzureOpenAIInput {
+    static lc_name(): string;
     get callKeys(): (keyof ChatOpenAICallOptions)[];
     lc_serializable: boolean;
     get lc_secrets(): {
@@ -65,6 +66,7 @@ export declare class ChatOpenAI extends BaseChatModel<ChatOpenAICallOptions> imp
     azureOpenAIApiInstanceName?: string;
     azureOpenAIApiDeploymentName?: string;
     azureOpenAIBasePath?: string;
+    organization?: string;
     private client;
     private clientConfig;
     constructor(fields?: Partial<OpenAIChatInput> & Partial<AzureOpenAIInput> & BaseChatModelParams & {

package/dist/chat_models/openai.js

@@ -1,13 +1,13 @@
 import { Configuration, OpenAIApi, } from "openai";
-import { getEnvironmentVariable, isNode } from "../util/env.js";
-import fetchAdapter from "../util/axios-fetch-adapter.js";
-import { BaseChatModel } from "./base.js";
-import { AIMessage, AIMessageChunk, ChatGenerationChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessage, HumanMessageChunk, SystemMessage, SystemMessageChunk, } from "../schema/index.js";
 import { getModelNameForTiktoken } from "../base_language/count_tokens.js";
-import { promptLayerTrackRequest } from "../util/prompt-layer.js";
+import { AIMessage, AIMessageChunk, ChatGenerationChunk, ChatMessage, ChatMessageChunk, FunctionMessageChunk, HumanMessage, HumanMessageChunk, SystemMessage, SystemMessageChunk, } from "../schema/index.js";
 import { formatToOpenAIFunction } from "../tools/convert_to_openai.js";
+import fetchAdapter from "../util/axios-fetch-adapter.js";
 import { getEndpoint } from "../util/azure.js";
+import { getEnvironmentVariable, isNode } from "../util/env.js";
+import { promptLayerTrackRequest } from "../util/prompt-layer.js";
 import { readableStreamToAsyncIterable } from "../util/stream.js";
+import { BaseChatModel } from "./base.js";
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "system" &&
         message.role !== "assistant" &&
@@ -105,6 +105,9 @@ delta, defaultRole) {
  * if not explicitly available on this class.
  */
 export class ChatOpenAI extends BaseChatModel {
+    static lc_name() {
+        return "ChatOpenAI";
+    }
     get callKeys() {
         return [
             ...super.callKeys,
@@ -119,6 +122,7 @@ export class ChatOpenAI extends BaseChatModel {
         return {
             openAIApiKey: "OPENAI_API_KEY",
             azureOpenAIApiKey: "AZURE_OPENAI_API_KEY",
+            organization: "OPENAI_ORGANIZATION",
         };
     }
     get lc_aliases() {
@@ -255,6 +259,12 @@ export class ChatOpenAI extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "organization", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -287,6 +297,9 @@ export class ChatOpenAI extends BaseChatModel {
         this.azureOpenAIBasePath =
             fields?.azureOpenAIBasePath ??
                 getEnvironmentVariable("AZURE_OPENAI_BASE_PATH");
+        this.organization =
+            fields?.configuration?.organization ??
+                getEnvironmentVariable("OPENAI_ORGANIZATION");
         this.modelName = fields?.modelName ?? this.modelName;
         this.modelKwargs = fields?.modelKwargs ?? {};
         this.timeout = fields?.timeout;
@@ -313,6 +326,7 @@ export class ChatOpenAI extends BaseChatModel {
         }
         this.clientConfig = {
             apiKey: this.openAIApiKey,
+            organization: this.organization,
             ...configuration,
             ...fields?.configuration,
         };

package/dist/document_loaders/base.cjs

@@ -2,7 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseDocumentLoader = void 0;
 const text_splitter_js_1 = require("../text_splitter.cjs");
+/**
+ * Abstract class that provides a default implementation for the
+ * loadAndSplit() method from the DocumentLoader interface. The load()
+ * method is left abstract and needs to be implemented by subclasses.
+ */
 class BaseDocumentLoader {
+    /**
+     * Loads the documents and splits them using a specified text splitter.
+     * @param textSplitter The TextSplitter instance to use for splitting the loaded documents. Defaults to a RecursiveCharacterTextSplitter instance.
+     * @returns A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
+     */
     async loadAndSplit(splitter = new text_splitter_js_1.RecursiveCharacterTextSplitter()) {
         const docs = await this.load();
         return splitter.splitDocuments(docs);

package/dist/document_loaders/base.d.ts

@@ -1,10 +1,27 @@
 import { TextSplitter } from "../text_splitter.js";
 import { Document } from "../document.js";
+/**
+ * Interface that defines the methods for loading and splitting documents.
+ */
 export interface DocumentLoader {
     load(): Promise<Document[]>;
     loadAndSplit(textSplitter?: TextSplitter): Promise<Document[]>;
 }
+/**
+ * Abstract class that provides a default implementation for the
+ * loadAndSplit() method from the DocumentLoader interface. The load()
+ * method is left abstract and needs to be implemented by subclasses.
+ */
 export declare abstract class BaseDocumentLoader implements DocumentLoader {
+    /**
+     * Loads the documents.
+     * @returns A Promise that resolves with an array of Document instances.
+     */
     abstract load(): Promise<Document[]>;
+    /**
+     * Loads the documents and splits them using a specified text splitter.
+     * @param textSplitter The TextSplitter instance to use for splitting the loaded documents. Defaults to a RecursiveCharacterTextSplitter instance.
+     * @returns A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
+     */
     loadAndSplit(splitter?: TextSplitter): Promise<Document[]>;
 }

package/dist/document_loaders/base.js

@@ -1,5 +1,15 @@
 import { RecursiveCharacterTextSplitter, } from "../text_splitter.js";
+/**
+ * Abstract class that provides a default implementation for the
+ * loadAndSplit() method from the DocumentLoader interface. The load()
+ * method is left abstract and needs to be implemented by subclasses.
+ */
 export class BaseDocumentLoader {
+    /**
+     * Loads the documents and splits them using a specified text splitter.
+     * @param textSplitter The TextSplitter instance to use for splitting the loaded documents. Defaults to a RecursiveCharacterTextSplitter instance.
+     * @returns A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
+     */
     async loadAndSplit(splitter = new RecursiveCharacterTextSplitter()) {
         const docs = await this.load();
         return splitter.splitDocuments(docs);

package/dist/document_loaders/fs/buffer.cjs

@@ -3,6 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BufferLoader = void 0;
 const env_js_1 = require("../../util/env.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Abstract class that extends the `BaseDocumentLoader` class. It
+ * represents a document loader that loads documents from a buffer. The
+ * `load()` method is implemented to read 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.
+ */
 class BufferLoader extends base_js_1.BaseDocumentLoader {
     constructor(filePathOrBlob) {
         super();
@@ -13,6 +20,12 @@ class BufferLoader extends base_js_1.BaseDocumentLoader {
             value: filePathOrBlob
         });
     }
+    /**
+     * 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 that resolves with an array of `Document` objects.
+     */
     async load() {
         let buffer;
         let metadata;
@@ -29,6 +42,14 @@ class BufferLoader extends base_js_1.BaseDocumentLoader {
         }
         return this.parse(buffer, metadata);
     }
+    /**
+     * 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 that resolves with an object containing the `readFile` function.
+     */
     static async imports() {
         try {
             const { readFile } = await import("node:fs/promises");

package/dist/document_loaders/fs/buffer.d.ts

@@ -3,11 +3,39 @@
 import type { readFile as ReadFileT } from "node:fs/promises";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Abstract class that extends the `BaseDocumentLoader` class. It
+ * represents a document loader that loads documents from a buffer. The
+ * `load()` method is implemented to read 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.
+ */
 export declare abstract class BufferLoader extends BaseDocumentLoader {
     filePathOrBlob: string | Blob;
     constructor(filePathOrBlob: string | Blob);
+    /**
+     * Abstract method that needs to be implemented by subclasses. It is used
+     * to parse the buffer and return the documents.
+     * @param raw The buffer to be parsed.
+     * @param metadata Metadata of the document.
+     * @returns Promise that resolves with an array of `Document` objects.
+     */
     protected abstract parse(raw: Buffer, metadata: Document["metadata"]): 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 that resolves with an array of `Document` objects.
+     */
     load(): Promise<Document[]>;
+    /**
+     * 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 that resolves with an object containing the `readFile` function.
+     */
     static imports(): Promise<{
         readFile: typeof ReadFileT;
     }>;

package/dist/document_loaders/fs/buffer.js

@@ -1,5 +1,12 @@
 import { getEnv } from "../../util/env.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Abstract class that extends the `BaseDocumentLoader` class. It
+ * represents a document loader that loads documents from a buffer. The
+ * `load()` method is implemented to read 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.
+ */
 export class BufferLoader extends BaseDocumentLoader {
     constructor(filePathOrBlob) {
         super();
@@ -10,6 +17,12 @@ export class BufferLoader extends BaseDocumentLoader {
             value: filePathOrBlob
         });
     }
+    /**
+     * 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 that resolves with an array of `Document` objects.
+     */
     async load() {
         let buffer;
         let metadata;
@@ -26,6 +39,14 @@ export class BufferLoader extends BaseDocumentLoader {
         }
         return this.parse(buffer, metadata);
     }
+    /**
+     * 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 that resolves with an object containing the `readFile` function.
+     */
     static async imports() {
         try {
             const { readFile } = await import("node:fs/promises");

package/dist/document_loaders/fs/csv.cjs

@@ -2,6 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CSVLoader = void 0;
 const text_js_1 = require("./text.cjs");
+/**
+ * A class that extends the TextLoader class. It represents a document
+ * loader that loads documents from a CSV file. It has a constructor that
+ * takes a `filePathOrBlob` parameter representing the path to the CSV
+ * file or a Blob object, and an optional `options` parameter of type
+ * `CSVLoaderOptions` or a string representing the column to use as the
+ * document's pageContent.
+ */
 class CSVLoader extends text_js_1.TextLoader {
     constructor(filePathOrBlob, options) {
         super(filePathOrBlob);
@@ -18,6 +26,17 @@ class CSVLoader extends text_js_1.TextLoader {
             this.options = options ?? this.options;
         }
     }
+    /**
+     * A protected method that parses the raw CSV data and returns an array of
+     * strings representing the pageContent of each document. It uses the
+     * `dsvFormat` function from the `d3-dsv` module to parse the CSV data. If
+     * the `column` option is specified, it checks if the column exists in the
+     * CSV file and returns the values of that column as the pageContent. If
+     * the `column` option is not specified, it converts each row of the CSV
+     * data into key/value pairs and joins them with newline characters.
+     * @param raw The raw CSV data to be parsed.
+     * @returns An array of strings representing the pageContent of each document.
+     */
     async parse(raw) {
         const { column, separator = "," } = this.options;
         const { dsvFormat } = await CSVLoaderImports();

package/dist/document_loaders/fs/csv.d.ts

@@ -38,9 +38,28 @@ type CSVLoaderOptions = {
     column?: string;
     separator?: string;
 };
+/**
+ * A class that extends the TextLoader class. It represents a document
+ * loader that loads documents from a CSV file. It has a constructor that
+ * takes a `filePathOrBlob` parameter representing the path to the CSV
+ * file or a Blob object, and an optional `options` parameter of type
+ * `CSVLoaderOptions` or a string representing the column to use as the
+ * document's pageContent.
+ */
 export declare class CSVLoader extends TextLoader {
     protected options: CSVLoaderOptions;
     constructor(filePathOrBlob: string | Blob, options?: CSVLoaderOptions | string);
+    /**
+     * A protected method that parses the raw CSV data and returns an array of
+     * strings representing the pageContent of each document. It uses the
+     * `dsvFormat` function from the `d3-dsv` module to parse the CSV data. If
+     * the `column` option is specified, it checks if the column exists in the
+     * CSV file and returns the values of that column as the pageContent. If
+     * the `column` option is not specified, it converts each row of the CSV
+     * data into key/value pairs and joins them with newline characters.
+     * @param raw The raw CSV data to be parsed.
+     * @returns An array of strings representing the pageContent of each document.
+     */
     protected parse(raw: string): Promise<string[]>;
 }
 export {};

package/dist/document_loaders/fs/csv.js

@@ -1,4 +1,12 @@
 import { TextLoader } from "./text.js";
+/**
+ * A class that extends the TextLoader class. It represents a document
+ * loader that loads documents from a CSV file. It has a constructor that
+ * takes a `filePathOrBlob` parameter representing the path to the CSV
+ * file or a Blob object, and an optional `options` parameter of type
+ * `CSVLoaderOptions` or a string representing the column to use as the
+ * document's pageContent.
+ */
 export class CSVLoader extends TextLoader {
     constructor(filePathOrBlob, options) {
         super(filePathOrBlob);
@@ -15,6 +23,17 @@ export class CSVLoader extends TextLoader {
             this.options = options ?? this.options;
         }
     }
+    /**
+     * A protected method that parses the raw CSV data and returns an array of
+     * strings representing the pageContent of each document. It uses the
+     * `dsvFormat` function from the `d3-dsv` module to parse the CSV data. If
+     * the `column` option is specified, it checks if the column exists in the
+     * CSV file and returns the values of that column as the pageContent. If
+     * the `column` option is not specified, it converts each row of the CSV
+     * data into key/value pairs and joins them with newline characters.
+     * @param raw The raw CSV data to be parsed.
+     * @returns An array of strings representing the pageContent of each document.
+     */
     async parse(raw) {
         const { column, separator = "," } = this.options;
         const { dsvFormat } = await CSVLoaderImports();