langchain 0.0.131 → 0.0.132

package/dist/schema/index.cjs

@@ -35,6 +35,11 @@ class GenerationChunk {
     }
 }
 exports.GenerationChunk = 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()`.
+ */
 class BaseMessage extends serializable_js_1.Serializable {
     /**
      * @deprecated
@@ -102,6 +107,13 @@ class BaseMessage extends serializable_js_1.Serializable {
     }
 }
 exports.BaseMessage = BaseMessage;
+/**
+ * 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.
+ */
 class BaseMessageChunk extends BaseMessage {
     static _mergeAdditionalKwargs(left, right) {
         const merged = { ...left };
@@ -127,6 +139,9 @@ class BaseMessageChunk extends BaseMessage {
     }
 }
 exports.BaseMessageChunk = BaseMessageChunk;
+/**
+ * Represents a human message in a conversation.
+ */
 class HumanMessage extends BaseMessage {
     static lc_name() {
         return "HumanMessage";
@@ -136,6 +151,10 @@ class HumanMessage extends BaseMessage {
     }
 }
 exports.HumanMessage = HumanMessage;
+/**
+ * Represents a chunk of a human message, which can be concatenated with
+ * other human message chunks.
+ */
 class HumanMessageChunk extends BaseMessageChunk {
     static lc_name() {
         return "HumanMessageChunk";
@@ -151,6 +170,9 @@ class HumanMessageChunk extends BaseMessageChunk {
     }
 }
 exports.HumanMessageChunk = HumanMessageChunk;
+/**
+ * Represents an AI message in a conversation.
+ */
 class AIMessage extends BaseMessage {
     static lc_name() {
         return "AIMessage";
@@ -160,6 +182,10 @@ class AIMessage extends BaseMessage {
     }
 }
 exports.AIMessage = AIMessage;
+/**
+ * Represents a chunk of an AI message, which can be concatenated with
+ * other AI message chunks.
+ */
 class AIMessageChunk extends BaseMessageChunk {
     static lc_name() {
         return "AIMessageChunk";
@@ -175,6 +201,9 @@ class AIMessageChunk extends BaseMessageChunk {
     }
 }
 exports.AIMessageChunk = AIMessageChunk;
+/**
+ * Represents a system message in a conversation.
+ */
 class SystemMessage extends BaseMessage {
     static lc_name() {
         return "SystemMessage";
@@ -184,6 +213,10 @@ class SystemMessage extends BaseMessage {
     }
 }
 exports.SystemMessage = SystemMessage;
+/**
+ * Represents a chunk of a system message, which can be concatenated with
+ * other system message chunks.
+ */
 class SystemMessageChunk extends BaseMessageChunk {
     static lc_name() {
         return "SystemMessageChunk";
@@ -219,6 +252,9 @@ exports.AIChatMessage = AIMessage;
  * Use {@link SystemMessage} instead.
  */
 exports.SystemChatMessage = SystemMessage;
+/**
+ * Represents a function message in a conversation.
+ */
 class FunctionMessage extends BaseMessage {
     static lc_name() {
         return "FunctionMessage";
@@ -237,6 +273,10 @@ class FunctionMessage extends BaseMessage {
     }
 }
 exports.FunctionMessage = FunctionMessage;
+/**
+ * Represents a chunk of a function message, which can be concatenated
+ * with other function message chunks.
+ */
 class FunctionMessageChunk extends BaseMessageChunk {
     static lc_name() {
         return "FunctionMessageChunk";
@@ -253,6 +293,9 @@ class FunctionMessageChunk extends BaseMessageChunk {
     }
 }
 exports.FunctionMessageChunk = FunctionMessageChunk;
+/**
+ * Represents a chat message in a conversation.
+ */
 class ChatMessage extends BaseMessage {
     static lc_name() {
         return "ChatMessage";
@@ -279,6 +322,10 @@ class ChatMessage extends BaseMessage {
     }
 }
 exports.ChatMessage = ChatMessage;
+/**
+ * Represents a chunk of a chat message, which can be concatenated with
+ * other chat message chunks.
+ */
 class ChatMessageChunk extends BaseMessageChunk {
     static lc_name() {
         return "ChatMessageChunk";
@@ -338,9 +385,17 @@ exports.ChatGenerationChunk = ChatGenerationChunk;
 class BasePromptValue extends serializable_js_1.Serializable {
 }
 exports.BasePromptValue = BasePromptValue;
+/**
+ * Base class for all chat message histories. All chat message histories
+ * should extend this class.
+ */
 class BaseChatMessageHistory extends serializable_js_1.Serializable {
 }
 exports.BaseChatMessageHistory = BaseChatMessageHistory;
+/**
+ * Base class for all list chat message histories. All list chat message
+ * histories should extend this class.
+ */
 class BaseListChatMessageHistory extends serializable_js_1.Serializable {
     addUserMessage(message) {
         return this.addMessage(new HumanMessage(message));
@@ -350,15 +405,30 @@ class BaseListChatMessageHistory extends serializable_js_1.Serializable {
     }
 }
 exports.BaseListChatMessageHistory = BaseListChatMessageHistory;
+/**
+ * Base class for all caches. All caches should extend this class.
+ */
 class BaseCache {
 }
 exports.BaseCache = BaseCache;
+/**
+ * Base class for all file stores. All file stores should extend this
+ * class.
+ */
 class BaseFileStore extends serializable_js_1.Serializable {
 }
 exports.BaseFileStore = BaseFileStore;
+/**
+ * Base class for all entity stores. All entity stores should extend this
+ * class.
+ */
 class BaseEntityStore extends serializable_js_1.Serializable {
 }
 exports.BaseEntityStore = BaseEntityStore;
+/**
+ * Abstract class for a document store. All document stores should extend
+ * this class.
+ */
 class Docstore {
 }
 exports.Docstore = Docstore;

package/dist/schema/index.d.ts

@@ -74,6 +74,11 @@ export interface ChatMessageFieldsWithRole extends BaseMessageFields {
 export interface FunctionMessageFieldsWithName extends BaseMessageFields {
     name: string;
 }
+/**
+ * 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 declare abstract class BaseMessage extends Serializable implements BaseMessageFields {
     lc_namespace: string[];
     lc_serializable: boolean;
@@ -95,32 +100,60 @@ export declare abstract class BaseMessage extends Serializable implements BaseMe
     kwargs?: Record<string, unknown>);
     toDict(): StoredMessage;
 }
+/**
+ * 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 declare abstract class BaseMessageChunk extends BaseMessage {
     abstract concat(chunk: BaseMessageChunk): BaseMessageChunk;
     static _mergeAdditionalKwargs(left: NonNullable<BaseMessageFields["additional_kwargs"]>, right: NonNullable<BaseMessageFields["additional_kwargs"]>): NonNullable<BaseMessageFields["additional_kwargs"]>;
 }
+/**
+ * Represents a human message in a conversation.
+ */
 export declare class HumanMessage extends BaseMessage {
     static lc_name(): string;
     _getType(): MessageType;
 }
+/**
+ * Represents a chunk of a human message, which can be concatenated with
+ * other human message chunks.
+ */
 export declare class HumanMessageChunk extends BaseMessageChunk {
     static lc_name(): string;
     _getType(): MessageType;
     concat(chunk: HumanMessageChunk): HumanMessageChunk;
 }
+/**
+ * Represents an AI message in a conversation.
+ */
 export declare class AIMessage extends BaseMessage {
     static lc_name(): string;
     _getType(): MessageType;
 }
+/**
+ * Represents a chunk of an AI message, which can be concatenated with
+ * other AI message chunks.
+ */
 export declare class AIMessageChunk extends BaseMessageChunk {
     static lc_name(): string;
     _getType(): MessageType;
     concat(chunk: AIMessageChunk): AIMessageChunk;
 }
+/**
+ * Represents a system message in a conversation.
+ */
 export declare class SystemMessage extends BaseMessage {
     static lc_name(): string;
     _getType(): MessageType;
 }
+/**
+ * Represents a chunk of a system message, which can be concatenated with
+ * other system message chunks.
+ */
 export declare class SystemMessageChunk extends BaseMessageChunk {
     static lc_name(): string;
     _getType(): MessageType;
@@ -146,6 +179,9 @@ export declare const AIChatMessage: typeof AIMessage;
  * Use {@link SystemMessage} instead.
  */
 export declare const SystemChatMessage: typeof SystemMessage;
+/**
+ * Represents a function message in a conversation.
+ */
 export declare class FunctionMessage extends BaseMessage {
     static lc_name(): string;
     constructor(fields: FunctionMessageFieldsWithName);
@@ -154,11 +190,18 @@ export declare class FunctionMessage extends BaseMessage {
     name: string);
     _getType(): MessageType;
 }
+/**
+ * Represents a chunk of a function message, which can be concatenated
+ * with other function message chunks.
+ */
 export declare class FunctionMessageChunk extends BaseMessageChunk {
     static lc_name(): string;
     _getType(): MessageType;
     concat(chunk: FunctionMessageChunk): FunctionMessageChunk;
 }
+/**
+ * Represents a chat message in a conversation.
+ */
 export declare class ChatMessage extends BaseMessage implements ChatMessageFieldsWithRole {
     static lc_name(): string;
     role: string;
@@ -167,6 +210,10 @@ export declare class ChatMessage extends BaseMessage implements ChatMessageField
     _getType(): MessageType;
     static isInstance(message: BaseMessage): message is ChatMessage;
 }
+/**
+ * Represents a chunk of a chat message, which can be concatenated with
+ * other chat message chunks.
+ */
 export declare class ChatMessageChunk extends BaseMessageChunk {
     static lc_name(): string;
     role: string;
@@ -211,6 +258,10 @@ export type AgentStep = {
     observation: string;
 };
 export type ChainValues = Record<string, any>;
+/**
+ * Base class for all chat message histories. All chat message histories
+ * should extend this class.
+ */
 export declare abstract class BaseChatMessageHistory extends Serializable {
     abstract getMessages(): Promise<BaseMessage[]>;
     abstract addMessage(message: BaseMessage): Promise<void>;
@@ -218,19 +269,34 @@ export declare abstract class BaseChatMessageHistory extends Serializable {
     abstract addAIChatMessage(message: string): Promise<void>;
     abstract clear(): Promise<void>;
 }
+/**
+ * Base class for all list chat message histories. All list chat message
+ * histories should extend this class.
+ */
 export declare abstract class BaseListChatMessageHistory extends Serializable {
     abstract addMessage(message: BaseMessage): Promise<void>;
     addUserMessage(message: string): Promise<void>;
     addAIChatMessage(message: string): Promise<void>;
 }
+/**
+ * Base class for all caches. All caches should extend this class.
+ */
 export declare abstract class BaseCache<T = Generation[]> {
     abstract lookup(prompt: string, llmKey: string): Promise<T | null>;
     abstract update(prompt: string, llmKey: string, value: T): Promise<void>;
 }
+/**
+ * Base class for all file stores. All file stores should extend this
+ * class.
+ */
 export declare abstract class BaseFileStore extends Serializable {
     abstract readFile(path: string): Promise<string>;
     abstract writeFile(path: string, contents: string): Promise<void>;
 }
+/**
+ * Base class for all entity stores. All entity stores should extend this
+ * class.
+ */
 export declare abstract class BaseEntityStore extends Serializable {
     abstract get(key: string, defaultValue?: string): Promise<string | undefined>;
     abstract set(key: string, value?: string): Promise<void>;
@@ -238,6 +304,10 @@ export declare abstract class BaseEntityStore extends Serializable {
     abstract exists(key: string): Promise<boolean>;
     abstract clear(): Promise<void>;
 }
+/**
+ * Abstract class for a document store. All document stores should extend
+ * this class.
+ */
 export declare abstract class Docstore {
     abstract search(search: string): Promise<Document>;
     abstract add(texts: Record<string, Document>): Promise<void>;

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,6 +133,9 @@ export class BaseMessageChunk extends BaseMessage {
         return merged;
     }
 }
+/**
+ * Represents a human message in a conversation.
+ */
 export class HumanMessage extends BaseMessage {
     static lc_name() {
         return "HumanMessage";
@@ -129,6 +144,10 @@ export class HumanMessage extends BaseMessage {
         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";
@@ -143,6 +162,9 @@ export class HumanMessageChunk extends BaseMessageChunk {
         });
     }
 }
+/**
+ * Represents an AI message in a conversation.
+ */
 export class AIMessage extends BaseMessage {
     static lc_name() {
         return "AIMessage";
@@ -151,6 +173,10 @@ export class AIMessage extends BaseMessage {
         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";
@@ -165,6 +191,9 @@ export class AIMessageChunk extends BaseMessageChunk {
         });
     }
 }
+/**
+ * Represents a system message in a conversation.
+ */
 export class SystemMessage extends BaseMessage {
     static lc_name() {
         return "SystemMessage";
@@ -173,6 +202,10 @@ export class SystemMessage extends BaseMessage {
         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";
@@ -207,6 +240,9 @@ 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";
@@ -224,6 +260,10 @@ 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";
@@ -239,6 +279,9 @@ export class FunctionMessageChunk extends BaseMessageChunk {
         });
     }
 }
+/**
+ * Represents a chat message in a conversation.
+ */
 export class ChatMessage extends BaseMessage {
     static lc_name() {
         return "ChatMessage";
@@ -264,6 +307,10 @@ 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";
@@ -320,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));
@@ -330,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,
@@ -78,6 +108,14 @@ class StringOutputParser extends BaseTransformOutputParser {
     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);
     }
@@ -123,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,6 +77,13 @@ 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>;
 }
 /**
@@ -55,6 +93,14 @@ 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;
 }
@@ -70,6 +116,11 @@ export declare class BytesOutputParser extends BaseTransformOutputParser<Uint8Ar
     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);