langchain 0.0.130 → 0.0.132

package/dist/retrievers/vespa.js

@@ -1,6 +1,14 @@
 import { Document } from "../document.js";
 import { RemoteRetriever, } from "./remote/base.js";
+/**
+ * Class responsible for retrieving data from Vespa. It extends the
+ * `RemoteRetriever` class and includes methods for creating the JSON body
+ * for a query and processing the JSON response from Vespa.
+ */
 export class VespaRetriever extends RemoteRetriever {
+    static lc_name() {
+        return "VespaRetriever";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {
@@ -25,12 +33,25 @@ export class VespaRetriever extends RemoteRetriever {
         this.content_field = fields.content_field;
         this.url = `${this.url}/search/?`;
     }
+    /**
+     * Method that takes a query string as input and returns a JSON object
+     * that includes the query and the original `query_body`.
+     * @param query The query string to be sent to Vespa.
+     * @returns A JSON object that includes the query and the original `query_body`.
+     */
     createJsonBody(query) {
         return {
             ...this.query_body,
             query,
         };
     }
+    /**
+     * Method that processes the JSON response from Vespa into an array of
+     * `Document` instances. Each `Document` instance includes the content
+     * from the specified `content_field` and the document's ID.
+     * @param json The JSON response from Vespa.
+     * @returns An array of `Document` instances.
+     */
     processJsonResponse(json) {
         return json.root.children.map((doc) => new Document({
             pageContent: doc.fields[this.content_field],

package/dist/retrievers/zep.cjs

@@ -4,7 +4,14 @@ exports.ZepRetriever = void 0;
 const zep_js_1 = require("@getzep/zep-js");
 const retriever_js_1 = require("../schema/retriever.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * Class for retrieving information from a Zep long-term memory store.
+ * Extends the BaseRetriever class.
+ */
 class ZepRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "ZepRetriever";
+    }
     get lc_secrets() {
         return {
             apiKey: "ZEP_API_KEY",

package/dist/retrievers/zep.d.ts

@@ -1,13 +1,22 @@
 import { ZepClient } from "@getzep/zep-js";
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * Configuration interface for the ZepRetriever class. Extends the
+ * BaseRetrieverInput interface.
+ */
 export interface ZepRetrieverConfig extends BaseRetrieverInput {
     sessionId: string;
     url: string;
     topK?: number;
     apiKey?: string;
 }
+/**
+ * Class for retrieving information from a Zep long-term memory store.
+ * Extends the BaseRetriever class.
+ */
 export declare class ZepRetriever extends BaseRetriever {
+    static lc_name(): string;
     lc_namespace: string[];
     get lc_secrets(): {
         [key: string]: string;

package/dist/retrievers/zep.js

@@ -1,7 +1,14 @@
 import { NotFoundError, ZepClient, } from "@getzep/zep-js";
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * Class for retrieving information from a Zep long-term memory store.
+ * Extends the BaseRetriever class.
+ */
 export class ZepRetriever extends BaseRetriever {
+    static lc_name() {
+        return "ZepRetriever";
+    }
     get lc_secrets() {
         return {
             apiKey: "ZEP_API_KEY",

package/dist/schema/document.cjs

@@ -22,6 +22,13 @@ class BaseDocumentTransformer extends runnable_js_1.Runnable {
             value: ["langchain", "document_transformers"]
         });
     }
+    /**
+     * Method to invoke the document transformation. This method calls the
+     * transformDocuments method with the provided input.
+     * @param input The input documents to be transformed.
+     * @param _options Optional configuration object to customize the behavior of callbacks.
+     * @returns A Promise that resolves to the transformed documents.
+     */
     invoke(input, _options) {
         return this.transformDocuments(input);
     }

package/dist/schema/document.d.ts

@@ -19,6 +19,13 @@ export declare abstract class BaseDocumentTransformer<RunInput extends Document[
      * @returns A list of transformed documents.
      */
     abstract transformDocuments(documents: RunInput): Promise<RunOutput>;
+    /**
+     * Method to invoke the document transformation. This method calls the
+     * transformDocuments method with the provided input.
+     * @param input The input documents to be transformed.
+     * @param _options Optional configuration object to customize the behavior of callbacks.
+     * @returns A Promise that resolves to the transformed documents.
+     */
     invoke(input: RunInput, _options?: Partial<BaseCallbackConfig>): Promise<RunOutput>;
 }
 /**

package/dist/schema/document.js

@@ -19,6 +19,13 @@ export class BaseDocumentTransformer extends Runnable {
             value: ["langchain", "document_transformers"]
         });
     }
+    /**
+     * Method to invoke the document transformation. This method calls the
+     * transformDocuments method with the provided input.
+     * @param input The input documents to be transformed.
+     * @param _options Optional configuration object to customize the behavior of callbacks.
+     * @returns A Promise that resolves to the transformed documents.
+     */
     invoke(input, _options) {
         return this.transformDocuments(input);
     }

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,13 +139,26 @@ class BaseMessageChunk extends BaseMessage {
     }
 }
 exports.BaseMessageChunk = BaseMessageChunk;
+/**
+ * Represents a human message in a conversation.
+ */
 class HumanMessage extends BaseMessage {
+    static lc_name() {
+        return "HumanMessage";
+    }
     _getType() {
         return "human";
     }
 }
 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";
+    }
     _getType() {
         return "human";
     }
@@ -145,13 +170,26 @@ class HumanMessageChunk extends BaseMessageChunk {
     }
 }
 exports.HumanMessageChunk = HumanMessageChunk;
+/**
+ * Represents an AI message in a conversation.
+ */
 class AIMessage extends BaseMessage {
+    static lc_name() {
+        return "AIMessage";
+    }
     _getType() {
         return "ai";
     }
 }
 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";
+    }
     _getType() {
         return "ai";
     }
@@ -163,13 +201,26 @@ class AIMessageChunk extends BaseMessageChunk {
     }
 }
 exports.AIMessageChunk = AIMessageChunk;
+/**
+ * Represents a system message in a conversation.
+ */
 class SystemMessage extends BaseMessage {
+    static lc_name() {
+        return "SystemMessage";
+    }
     _getType() {
         return "system";
     }
 }
 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";
+    }
     _getType() {
         return "system";
     }
@@ -201,7 +252,13 @@ 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";
+    }
     constructor(fields, 
     /** @deprecated */
     name) {
@@ -216,7 +273,14 @@ 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";
+    }
     _getType() {
         return "function";
     }
@@ -229,7 +293,13 @@ class FunctionMessageChunk extends BaseMessageChunk {
     }
 }
 exports.FunctionMessageChunk = FunctionMessageChunk;
+/**
+ * Represents a chat message in a conversation.
+ */
 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
@@ -252,7 +322,14 @@ 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";
+    }
     constructor(fields, role) {
         if (typeof fields === "string") {
             // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-non-null-assertion
@@ -308,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));
@@ -320,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,28 +100,62 @@ 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;
     concat(chunk: SystemMessageChunk): SystemMessageChunk;
 }
@@ -140,25 +179,43 @@ 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);
     constructor(fields: string | BaseMessageFields, 
     /** @deprecated */
     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;
     constructor(content: string, role: string);
     constructor(fields: ChatMessageFieldsWithRole);
     _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;
     constructor(content: string, role: string);
     constructor(fields: ChatMessageFieldsWithRole);
@@ -201,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>;
@@ -208,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>;
@@ -228,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>;