langchain 0.0.130 → 0.0.132

package/dist/schema/index.js

@@ -31,6 +31,11 @@ export class GenerationChunk {
         });
     }
 }
+/**
+ * Base class for all types of messages in a conversation. It includes
+ * properties like `content`, `name`, and `additional_kwargs`. It also
+ * includes methods like `toDict()` and `_getType()`.
+ */
 export class BaseMessage extends Serializable {
     /**
      * @deprecated
@@ -97,6 +102,13 @@ export class BaseMessage extends Serializable {
         };
     }
 }
+/**
+ * Represents a chunk of a message, which can be concatenated with other
+ * message chunks. It includes a method `_merge_kwargs_dict()` for merging
+ * additional keyword arguments from another `BaseMessageChunk` into this
+ * one. It also overrides the `__add__()` method to support concatenation
+ * of `BaseMessageChunk` instances.
+ */
 export class BaseMessageChunk extends BaseMessage {
     static _mergeAdditionalKwargs(left, right) {
         const merged = { ...left };
@@ -121,12 +133,25 @@ export class BaseMessageChunk extends BaseMessage {
         return merged;
     }
 }
+/**
+ * Represents a human message in a conversation.
+ */
 export class HumanMessage extends BaseMessage {
+    static lc_name() {
+        return "HumanMessage";
+    }
     _getType() {
         return "human";
     }
 }
+/**
+ * Represents a chunk of a human message, which can be concatenated with
+ * other human message chunks.
+ */
 export class HumanMessageChunk extends BaseMessageChunk {
+    static lc_name() {
+        return "HumanMessageChunk";
+    }
     _getType() {
         return "human";
     }
@@ -137,12 +162,25 @@ export class HumanMessageChunk extends BaseMessageChunk {
         });
     }
 }
+/**
+ * Represents an AI message in a conversation.
+ */
 export class AIMessage extends BaseMessage {
+    static lc_name() {
+        return "AIMessage";
+    }
     _getType() {
         return "ai";
     }
 }
+/**
+ * Represents a chunk of an AI message, which can be concatenated with
+ * other AI message chunks.
+ */
 export class AIMessageChunk extends BaseMessageChunk {
+    static lc_name() {
+        return "AIMessageChunk";
+    }
     _getType() {
         return "ai";
     }
@@ -153,12 +191,25 @@ export class AIMessageChunk extends BaseMessageChunk {
         });
     }
 }
+/**
+ * Represents a system message in a conversation.
+ */
 export class SystemMessage extends BaseMessage {
+    static lc_name() {
+        return "SystemMessage";
+    }
     _getType() {
         return "system";
     }
 }
+/**
+ * Represents a chunk of a system message, which can be concatenated with
+ * other system message chunks.
+ */
 export class SystemMessageChunk extends BaseMessageChunk {
+    static lc_name() {
+        return "SystemMessageChunk";
+    }
     _getType() {
         return "system";
     }
@@ -189,7 +240,13 @@ export const AIChatMessage = AIMessage;
  * Use {@link SystemMessage} instead.
  */
 export const SystemChatMessage = SystemMessage;
+/**
+ * Represents a function message in a conversation.
+ */
 export class FunctionMessage extends BaseMessage {
+    static lc_name() {
+        return "FunctionMessage";
+    }
     constructor(fields, 
     /** @deprecated */
     name) {
@@ -203,7 +260,14 @@ export class FunctionMessage extends BaseMessage {
         return "function";
     }
 }
+/**
+ * Represents a chunk of a function message, which can be concatenated
+ * with other function message chunks.
+ */
 export class FunctionMessageChunk extends BaseMessageChunk {
+    static lc_name() {
+        return "FunctionMessageChunk";
+    }
     _getType() {
         return "function";
     }
@@ -215,7 +279,13 @@ export class FunctionMessageChunk extends BaseMessageChunk {
         });
     }
 }
+/**
+ * Represents a chat message in a conversation.
+ */
 export class ChatMessage extends BaseMessage {
+    static lc_name() {
+        return "ChatMessage";
+    }
     constructor(fields, role) {
         if (typeof fields === "string") {
             // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-non-null-assertion
@@ -237,7 +307,14 @@ export class ChatMessage extends BaseMessage {
         return message._getType() === "generic";
     }
 }
+/**
+ * Represents a chunk of a chat message, which can be concatenated with
+ * other chat message chunks.
+ */
 export class ChatMessageChunk extends BaseMessageChunk {
+    static lc_name() {
+        return "ChatMessageChunk";
+    }
     constructor(fields, role) {
         if (typeof fields === "string") {
             // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-non-null-assertion
@@ -290,8 +367,16 @@ export class ChatGenerationChunk extends GenerationChunk {
  */
 export class BasePromptValue extends Serializable {
 }
+/**
+ * Base class for all chat message histories. All chat message histories
+ * should extend this class.
+ */
 export class BaseChatMessageHistory extends Serializable {
 }
+/**
+ * Base class for all list chat message histories. All list chat message
+ * histories should extend this class.
+ */
 export class BaseListChatMessageHistory extends Serializable {
     addUserMessage(message) {
         return this.addMessage(new HumanMessage(message));
@@ -300,11 +385,26 @@ export class BaseListChatMessageHistory extends Serializable {
         return this.addMessage(new AIMessage(message));
     }
 }
+/**
+ * Base class for all caches. All caches should extend this class.
+ */
 export class BaseCache {
 }
+/**
+ * Base class for all file stores. All file stores should extend this
+ * class.
+ */
 export class BaseFileStore extends Serializable {
 }
+/**
+ * Base class for all entity stores. All entity stores should extend this
+ * class.
+ */
 export class BaseEntityStore extends Serializable {
 }
+/**
+ * Abstract class for a document store. All document stores should extend
+ * this class.
+ */
 export class Docstore {
 }

package/dist/schema/output_parser.cjs

@@ -2,10 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutputParserException = exports.BytesOutputParser = exports.StringOutputParser = exports.BaseTransformOutputParser = exports.BaseOutputParser = exports.BaseLLMOutputParser = void 0;
 const runnable_js_1 = require("./runnable.cjs");
+/**
+ * Abstract base class for parsing the output of a Large Language Model
+ * (LLM) call. It provides methods for parsing the result of an LLM call
+ * and invoking the parser with a given input.
+ */
 class BaseLLMOutputParser extends runnable_js_1.Runnable {
+    /**
+     * Parses the result of an LLM call with a given prompt. By default, it
+     * simply calls `parseResult`.
+     * @param generations The generations from an LLM call.
+     * @param _prompt The prompt used in the LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parseResultWithPrompt(generations, _prompt, callbacks) {
         return this.parseResult(generations, callbacks);
     }
+    /**
+     * Calls the parser with a given input and optional configuration options.
+     * If the input is a string, it creates a generation with the input as
+     * text and calls `parseResult`. If the input is a `BaseMessage`, it
+     * creates a generation with the input as a message and the content of the
+     * input as text, and then calls `parseResult`.
+     * @param input The input to the parser, which can be a string or a `BaseMessage`.
+     * @param options Optional configuration options.
+     * @returns A promise of the parsed output.
+     */
     async invoke(input, options) {
         if (typeof input === "string") {
             return this._callWithConfig(async (input) => this.parseResult([{ text: input }]), input, { ...options, runType: "parser" });
@@ -48,6 +71,13 @@ class BaseTransformOutputParser extends BaseOutputParser {
             }
         }
     }
+    /**
+     * Transforms an asynchronous generator of input into an asynchronous
+     * generator of parsed output.
+     * @param inputGenerator An asynchronous generator of input.
+     * @param options A configuration object.
+     * @returns An asynchronous generator of parsed output.
+     */
     async *transform(inputGenerator, options) {
         yield* this._streamWithConfig(this._transform(inputGenerator), {
             ...options,
@@ -75,6 +105,17 @@ class StringOutputParser extends BaseTransformOutputParser {
             value: true
         });
     }
+    static lc_name() {
+        return "StrOutputParser";
+    }
+    /**
+     * Parses a string output from an LLM call. This method is meant to be
+     * implemented by subclasses to define how a string output from an LLM
+     * should be parsed.
+     * @param text The string output from an LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parse(text) {
         return Promise.resolve(text);
     }
@@ -109,6 +150,9 @@ class BytesOutputParser extends BaseTransformOutputParser {
             value: new TextEncoder()
         });
     }
+    static lc_name() {
+        return "BytesOutputParser";
+    }
     parse(text) {
         return Promise.resolve(this.textEncoder.encode(text));
     }
@@ -117,6 +161,11 @@ class BytesOutputParser extends BaseTransformOutputParser {
     }
 }
 exports.BytesOutputParser = BytesOutputParser;
+/**
+ * Custom error class used to handle exceptions related to output parsing.
+ * It extends the built-in `Error` class and adds an optional `output`
+ * property that can hold the output that caused the exception.
+ */
 class OutputParserException extends Error {
     constructor(message, output) {
         super(message);

package/dist/schema/output_parser.d.ts

@@ -6,9 +6,40 @@ import { Runnable, RunnableConfig } from "./runnable.js";
  */
 export interface FormatInstructionsOptions {
 }
+/**
+ * Abstract base class for parsing the output of a Large Language Model
+ * (LLM) call. It provides methods for parsing the result of an LLM call
+ * and invoking the parser with a given input.
+ */
 export declare abstract class BaseLLMOutputParser<T = unknown> extends Runnable<string | BaseMessage, T> {
+    /**
+     * Parses the result of an LLM call. This method is meant to be
+     * implemented by subclasses to define how the output from the LLM should
+     * be parsed.
+     * @param generations The generations from an LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     abstract parseResult(generations: Generation[] | ChatGeneration[], callbacks?: Callbacks): Promise<T>;
+    /**
+     * Parses the result of an LLM call with a given prompt. By default, it
+     * simply calls `parseResult`.
+     * @param generations The generations from an LLM call.
+     * @param _prompt The prompt used in the LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parseResultWithPrompt(generations: Generation[] | ChatGeneration[], _prompt: BasePromptValue, callbacks?: Callbacks): Promise<T>;
+    /**
+     * Calls the parser with a given input and optional configuration options.
+     * If the input is a string, it creates a generation with the input as
+     * text and calls `parseResult`. If the input is a `BaseMessage`, it
+     * creates a generation with the input as a message and the content of the
+     * input as text, and then calls `parseResult`.
+     * @param input The input to the parser, which can be a string or a `BaseMessage`.
+     * @param options Optional configuration options.
+     * @returns A promise of the parsed output.
+     */
     invoke(input: string | BaseMessage, options?: RunnableConfig): Promise<T>;
 }
 /**
@@ -46,14 +77,30 @@ export declare abstract class BaseOutputParser<T = unknown> extends BaseLLMOutpu
  */
 export declare abstract class BaseTransformOutputParser<T = unknown> extends BaseOutputParser<T> {
     _transform(inputGenerator: AsyncGenerator<string | BaseMessage>): AsyncGenerator<T>;
+    /**
+     * Transforms an asynchronous generator of input into an asynchronous
+     * generator of parsed output.
+     * @param inputGenerator An asynchronous generator of input.
+     * @param options A configuration object.
+     * @returns An asynchronous generator of parsed output.
+     */
     transform(inputGenerator: AsyncGenerator<string | BaseMessage>, options: BaseCallbackConfig): AsyncGenerator<T>;
 }
 /**
  * OutputParser that parses LLMResult into the top likely string.
  */
 export declare class StringOutputParser extends BaseTransformOutputParser<string> {
+    static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
+    /**
+     * Parses a string output from an LLM call. This method is meant to be
+     * implemented by subclasses to define how a string output from an LLM
+     * should be parsed.
+     * @param text The string output from an LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parse(text: string): Promise<string>;
     getFormatInstructions(): string;
 }
@@ -62,12 +109,18 @@ export declare class StringOutputParser extends BaseTransformOutputParser<string
  * encodes it into bytes.
  */
 export declare class BytesOutputParser extends BaseTransformOutputParser<Uint8Array> {
+    static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
     protected textEncoder: TextEncoder;
     parse(text: string): Promise<Uint8Array>;
     getFormatInstructions(): string;
 }
+/**
+ * Custom error class used to handle exceptions related to output parsing.
+ * It extends the built-in `Error` class and adds an optional `output`
+ * property that can hold the output that caused the exception.
+ */
 export declare class OutputParserException extends Error {
     output?: string;
     constructor(message: string, output?: string);

package/dist/schema/output_parser.js

@@ -1,8 +1,31 @@
 import { Runnable } from "./runnable.js";
+/**
+ * Abstract base class for parsing the output of a Large Language Model
+ * (LLM) call. It provides methods for parsing the result of an LLM call
+ * and invoking the parser with a given input.
+ */
 export class BaseLLMOutputParser extends Runnable {
+    /**
+     * Parses the result of an LLM call with a given prompt. By default, it
+     * simply calls `parseResult`.
+     * @param generations The generations from an LLM call.
+     * @param _prompt The prompt used in the LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parseResultWithPrompt(generations, _prompt, callbacks) {
         return this.parseResult(generations, callbacks);
     }
+    /**
+     * Calls the parser with a given input and optional configuration options.
+     * If the input is a string, it creates a generation with the input as
+     * text and calls `parseResult`. If the input is a `BaseMessage`, it
+     * creates a generation with the input as a message and the content of the
+     * input as text, and then calls `parseResult`.
+     * @param input The input to the parser, which can be a string or a `BaseMessage`.
+     * @param options Optional configuration options.
+     * @returns A promise of the parsed output.
+     */
     async invoke(input, options) {
         if (typeof input === "string") {
             return this._callWithConfig(async (input) => this.parseResult([{ text: input }]), input, { ...options, runType: "parser" });
@@ -43,6 +66,13 @@ export class BaseTransformOutputParser extends BaseOutputParser {
             }
         }
     }
+    /**
+     * Transforms an asynchronous generator of input into an asynchronous
+     * generator of parsed output.
+     * @param inputGenerator An asynchronous generator of input.
+     * @param options A configuration object.
+     * @returns An asynchronous generator of parsed output.
+     */
     async *transform(inputGenerator, options) {
         yield* this._streamWithConfig(this._transform(inputGenerator), {
             ...options,
@@ -69,6 +99,17 @@ export class StringOutputParser extends BaseTransformOutputParser {
             value: true
         });
     }
+    static lc_name() {
+        return "StrOutputParser";
+    }
+    /**
+     * Parses a string output from an LLM call. This method is meant to be
+     * implemented by subclasses to define how a string output from an LLM
+     * should be parsed.
+     * @param text The string output from an LLM call.
+     * @param callbacks Optional callbacks.
+     * @returns A promise of the parsed output.
+     */
     parse(text) {
         return Promise.resolve(text);
     }
@@ -102,6 +143,9 @@ export class BytesOutputParser extends BaseTransformOutputParser {
             value: new TextEncoder()
         });
     }
+    static lc_name() {
+        return "BytesOutputParser";
+    }
     parse(text) {
         return Promise.resolve(this.textEncoder.encode(text));
     }
@@ -109,6 +153,11 @@ export class BytesOutputParser extends BaseTransformOutputParser {
         return "";
     }
 }
+/**
+ * Custom error class used to handle exceptions related to output parsing.
+ * It extends the built-in `Error` class and adds an optional `output`
+ * property that can hold the output that caused the exception.
+ */
 export class OutputParserException extends Error {
     constructor(message, output) {
         super(message);

package/dist/schema/query_constructor.cjs

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AttributeInfo = void 0;
+/**
+ * A simple data structure that holds information about an attribute. It
+ * is typically used to provide metadata about attributes in other classes
+ * or data structures within the LangChain framework.
+ */
 class AttributeInfo {
     constructor(name, type, description) {
         Object.defineProperty(this, "name", {

package/dist/schema/query_constructor.d.ts

@@ -1,3 +1,8 @@
+/**
+ * A simple data structure that holds information about an attribute. It
+ * is typically used to provide metadata about attributes in other classes
+ * or data structures within the LangChain framework.
+ */
 export declare class AttributeInfo {
     name: string;
     type: string;

package/dist/schema/query_constructor.js

@@ -1,3 +1,8 @@
+/**
+ * A simple data structure that holds information about an attribute. It
+ * is typically used to provide metadata about attributes in other classes
+ * or data structures within the LangChain framework.
+ */
 export class AttributeInfo {
     constructor(name, type, description) {
         Object.defineProperty(this, "name", {

package/dist/schema/retriever.cjs

@@ -3,6 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseRetriever = void 0;
 const manager_js_1 = require("../callbacks/manager.cjs");
 const runnable_js_1 = require("./runnable.cjs");
+/**
+ * Abstract base class for a Document retrieval system. A retrieval system
+ * is defined as something that can take string queries and return the
+ * most 'relevant' Documents from some source. It extends the `Runnable`
+ * class, which means it is a unit of work that can be invoked, batched,
+ * streamed, or transformed. In the context of `BaseRetriever`, it is
+ * invoked with a string input and returns an array of `Document` objects.
+ */
 class BaseRetriever extends runnable_js_1.Runnable {
     constructor(fields) {
         super(fields);
@@ -46,6 +54,16 @@ class BaseRetriever extends runnable_js_1.Runnable {
     async invoke(input, options) {
         return this.getRelevantDocuments(input, options);
     }
+    /**
+     * Main method used to retrieve relevant documents. It takes a query
+     * string and an optional configuration object, and returns a promise that
+     * resolves to an array of `Document` objects. This method handles the
+     * retrieval process, including starting and ending callbacks, and error
+     * handling.
+     * @param query The query string to retrieve relevant documents for.
+     * @param config Optional configuration object for the retrieval process.
+     * @returns A promise that resolves to an array of `Document` objects.
+     */
     async getRelevantDocuments(query, config) {
         const parsedConfig = (0, manager_js_1.parseCallbackConfigArg)(config);
         const callbackManager_ = await manager_js_1.CallbackManager.configure(parsedConfig.callbacks, this.callbacks, parsedConfig.tags, this.tags, parsedConfig.metadata, this.metadata, { verbose: this.verbose });

package/dist/schema/retriever.d.ts

@@ -10,6 +10,14 @@ export interface BaseRetrieverInput {
     metadata?: Record<string, unknown>;
     verbose?: boolean;
 }
+/**
+ * Abstract base class for a Document retrieval system. A retrieval system
+ * is defined as something that can take string queries and return the
+ * most 'relevant' Documents from some source. It extends the `Runnable`
+ * class, which means it is a unit of work that can be invoked, batched,
+ * streamed, or transformed. In the context of `BaseRetriever`, it is
+ * invoked with a string input and returns an array of `Document` objects.
+ */
 export declare abstract class BaseRetriever extends Runnable<string, Document[]> {
     callbacks?: Callbacks;
     tags?: string[];
@@ -23,5 +31,15 @@ export declare abstract class BaseRetriever extends Runnable<string, Document[]>
      */
     _getRelevantDocuments(_query: string, _callbacks?: CallbackManagerForRetrieverRun): Promise<Document[]>;
     invoke(input: string, options?: RunnableConfig): Promise<Document[]>;
+    /**
+     * Main method used to retrieve relevant documents. It takes a query
+     * string and an optional configuration object, and returns a promise that
+     * resolves to an array of `Document` objects. This method handles the
+     * retrieval process, including starting and ending callbacks, and error
+     * handling.
+     * @param query The query string to retrieve relevant documents for.
+     * @param config Optional configuration object for the retrieval process.
+     * @returns A promise that resolves to an array of `Document` objects.
+     */
     getRelevantDocuments(query: string, config?: Callbacks | BaseCallbackConfig): Promise<Document[]>;
 }

package/dist/schema/retriever.js

@@ -1,5 +1,13 @@
 import { CallbackManager, parseCallbackConfigArg, } from "../callbacks/manager.js";
 import { Runnable } from "./runnable.js";
+/**
+ * Abstract base class for a Document retrieval system. A retrieval system
+ * is defined as something that can take string queries and return the
+ * most 'relevant' Documents from some source. It extends the `Runnable`
+ * class, which means it is a unit of work that can be invoked, batched,
+ * streamed, or transformed. In the context of `BaseRetriever`, it is
+ * invoked with a string input and returns an array of `Document` objects.
+ */
 export class BaseRetriever extends Runnable {
     constructor(fields) {
         super(fields);
@@ -43,6 +51,16 @@ export class BaseRetriever extends Runnable {
     async invoke(input, options) {
         return this.getRelevantDocuments(input, options);
     }
+    /**
+     * Main method used to retrieve relevant documents. It takes a query
+     * string and an optional configuration object, and returns a promise that
+     * resolves to an array of `Document` objects. This method handles the
+     * retrieval process, including starting and ending callbacks, and error
+     * handling.
+     * @param query The query string to retrieve relevant documents for.
+     * @param config Optional configuration object for the retrieval process.
+     * @returns A promise that resolves to an array of `Document` objects.
+     */
     async getRelevantDocuments(query, config) {
         const parsedConfig = parseCallbackConfigArg(config);
         const callbackManager_ = await CallbackManager.configure(parsedConfig.callbacks, this.callbacks, parsedConfig.tags, this.tags, parsedConfig.metadata, this.metadata, { verbose: this.verbose });