langchain 0.0.131 → 0.0.132

package/dist/stores/doc/gcs.cjs

@@ -4,6 +4,12 @@ exports.GoogleCloudStorageDocstore = void 0;
 const storage_1 = require("@google-cloud/storage");
 const document_js_1 = require("../../document.cjs");
 const index_js_1 = require("../../schema/index.cjs");
+/**
+ * Class that provides an interface for interacting with Google Cloud
+ * Storage (GCS) as a document store. It extends the Docstore class and
+ * implements methods to search, add, and add a document to the GCS
+ * bucket.
+ */
 class GoogleCloudStorageDocstore extends index_js_1.Docstore {
     constructor(config) {
         super();
@@ -29,6 +35,12 @@ class GoogleCloudStorageDocstore extends index_js_1.Docstore {
         this.prefix = config.prefix ?? this.prefix;
         this.storage = new storage_1.Storage();
     }
+    /**
+     * Searches for a document in the GCS bucket and returns it as a Document
+     * instance.
+     * @param search The name of the document to search for in the GCS bucket
+     * @returns A Promise that resolves to a Document instance representing the found document
+     */
     async search(search) {
         const file = this.getFile(search);
         const [fileMetadata] = await file.getMetadata();
@@ -41,14 +53,30 @@ class GoogleCloudStorageDocstore extends index_js_1.Docstore {
         });
         return ret;
     }
+    /**
+     * Adds multiple documents to the GCS bucket.
+     * @param texts An object where each key is the name of a document and the value is the Document instance to be added
+     * @returns A Promise that resolves when all documents have been added
+     */
     async add(texts) {
         await Promise.all(Object.keys(texts).map((key) => this.addDocument(key, texts[key])));
     }
+    /**
+     * Adds a single document to the GCS bucket.
+     * @param name The name of the document to be added
+     * @param document The Document instance to be added
+     * @returns A Promise that resolves when the document has been added
+     */
     async addDocument(name, document) {
         const file = this.getFile(name);
         await file.save(document.pageContent);
         await file.setMetadata({ metadata: document.metadata });
     }
+    /**
+     * Gets a file from the GCS bucket.
+     * @param name The name of the file to get from the GCS bucket
+     * @returns A File instance representing the fetched file
+     */
     getFile(name) {
         const filename = this.prefix + name;
         const file = this.storage.bucket(this.bucket).file(filename);

package/dist/stores/doc/gcs.d.ts

@@ -1,6 +1,11 @@
 import { Storage } from "@google-cloud/storage";
 import { Document } from "../../document.js";
 import { Docstore } from "../../schema/index.js";
+/**
+ * Interface that defines the configuration for the
+ * GoogleCloudStorageDocstore. It includes the bucket name and an optional
+ * prefix.
+ */
 export interface GoogleCloudStorageDocstoreConfiguration {
     /** The identifier for the GCS bucket */
     bucket: string;
@@ -10,13 +15,41 @@ export interface GoogleCloudStorageDocstoreConfiguration {
      */
     prefix?: string;
 }
+/**
+ * Class that provides an interface for interacting with Google Cloud
+ * Storage (GCS) as a document store. It extends the Docstore class and
+ * implements methods to search, add, and add a document to the GCS
+ * bucket.
+ */
 export declare class GoogleCloudStorageDocstore extends Docstore {
     bucket: string;
     prefix: string;
     storage: Storage;
     constructor(config: GoogleCloudStorageDocstoreConfiguration);
+    /**
+     * Searches for a document in the GCS bucket and returns it as a Document
+     * instance.
+     * @param search The name of the document to search for in the GCS bucket
+     * @returns A Promise that resolves to a Document instance representing the found document
+     */
     search(search: string): Promise<Document>;
+    /**
+     * Adds multiple documents to the GCS bucket.
+     * @param texts An object where each key is the name of a document and the value is the Document instance to be added
+     * @returns A Promise that resolves when all documents have been added
+     */
     add(texts: Record<string, Document>): Promise<void>;
+    /**
+     * Adds a single document to the GCS bucket.
+     * @param name The name of the document to be added
+     * @param document The Document instance to be added
+     * @returns A Promise that resolves when the document has been added
+     */
     addDocument(name: string, document: Document): Promise<void>;
+    /**
+     * Gets a file from the GCS bucket.
+     * @param name The name of the file to get from the GCS bucket
+     * @returns A File instance representing the fetched file
+     */
     private getFile;
 }

package/dist/stores/doc/gcs.js

@@ -1,6 +1,12 @@
 import { Storage } from "@google-cloud/storage";
 import { Document } from "../../document.js";
 import { Docstore } from "../../schema/index.js";
+/**
+ * Class that provides an interface for interacting with Google Cloud
+ * Storage (GCS) as a document store. It extends the Docstore class and
+ * implements methods to search, add, and add a document to the GCS
+ * bucket.
+ */
 export class GoogleCloudStorageDocstore extends Docstore {
     constructor(config) {
         super();
@@ -26,6 +32,12 @@ export class GoogleCloudStorageDocstore extends Docstore {
         this.prefix = config.prefix ?? this.prefix;
         this.storage = new Storage();
     }
+    /**
+     * Searches for a document in the GCS bucket and returns it as a Document
+     * instance.
+     * @param search The name of the document to search for in the GCS bucket
+     * @returns A Promise that resolves to a Document instance representing the found document
+     */
     async search(search) {
         const file = this.getFile(search);
         const [fileMetadata] = await file.getMetadata();
@@ -38,14 +50,30 @@ export class GoogleCloudStorageDocstore extends Docstore {
         });
         return ret;
     }
+    /**
+     * Adds multiple documents to the GCS bucket.
+     * @param texts An object where each key is the name of a document and the value is the Document instance to be added
+     * @returns A Promise that resolves when all documents have been added
+     */
     async add(texts) {
         await Promise.all(Object.keys(texts).map((key) => this.addDocument(key, texts[key])));
     }
+    /**
+     * Adds a single document to the GCS bucket.
+     * @param name The name of the document to be added
+     * @param document The Document instance to be added
+     * @returns A Promise that resolves when the document has been added
+     */
     async addDocument(name, document) {
         const file = this.getFile(name);
         await file.save(document.pageContent);
         await file.setMetadata({ metadata: document.metadata });
     }
+    /**
+     * Gets a file from the GCS bucket.
+     * @param name The name of the file to get from the GCS bucket
+     * @returns A File instance representing the fetched file
+     */
     getFile(name) {
         const filename = this.prefix + name;
         const file = this.storage.bucket(this.bucket).file(filename);

package/dist/stores/doc/in_memory.cjs

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SynchronousInMemoryDocstore = exports.InMemoryDocstore = void 0;
 const index_js_1 = require("../../schema/index.cjs");
+/**
+ * Class for storing and retrieving documents in memory asynchronously.
+ * Extends the Docstore class.
+ */
 class InMemoryDocstore extends index_js_1.Docstore {
     constructor(docs) {
         super();
@@ -13,6 +17,11 @@ class InMemoryDocstore extends index_js_1.Docstore {
         });
         this._docs = docs ?? new Map();
     }
+    /**
+     * Searches for a document in the store based on its ID.
+     * @param search The ID of the document to search for.
+     * @returns The document with the given ID.
+     */
     async search(search) {
         const result = this._docs.get(search);
         if (!result) {
@@ -22,6 +31,11 @@ class InMemoryDocstore extends index_js_1.Docstore {
             return result;
         }
     }
+    /**
+     * Adds new documents to the store.
+     * @param texts An object where the keys are document IDs and the values are the documents themselves.
+     * @returns Void
+     */
     async add(texts) {
         const keys = [...this._docs.keys()];
         const overlapping = Object.keys(texts).filter((x) => keys.includes(x));
@@ -34,6 +48,9 @@ class InMemoryDocstore extends index_js_1.Docstore {
     }
 }
 exports.InMemoryDocstore = InMemoryDocstore;
+/**
+ * Class for storing and retrieving documents in memory synchronously.
+ */
 class SynchronousInMemoryDocstore {
     constructor(docs) {
         Object.defineProperty(this, "_docs", {
@@ -44,6 +61,11 @@ class SynchronousInMemoryDocstore {
         });
         this._docs = docs ?? new Map();
     }
+    /**
+     * Searches for a document in the store based on its ID.
+     * @param search The ID of the document to search for.
+     * @returns The document with the given ID.
+     */
     search(search) {
         const result = this._docs.get(search);
         if (!result) {
@@ -53,6 +75,11 @@ class SynchronousInMemoryDocstore {
             return result;
         }
     }
+    /**
+     * Adds new documents to the store.
+     * @param texts An object where the keys are document IDs and the values are the documents themselves.
+     * @returns Void
+     */
     add(texts) {
         const keys = [...this._docs.keys()];
         const overlapping = Object.keys(texts).filter((x) => keys.includes(x));

package/dist/stores/doc/in_memory.d.ts

@@ -1,14 +1,41 @@
 import { Document } from "../../document.js";
 import { Docstore } from "../../schema/index.js";
+/**
+ * Class for storing and retrieving documents in memory asynchronously.
+ * Extends the Docstore class.
+ */
 export declare class InMemoryDocstore extends Docstore {
     _docs: Map<string, Document>;
     constructor(docs?: Map<string, Document>);
+    /**
+     * Searches for a document in the store based on its ID.
+     * @param search The ID of the document to search for.
+     * @returns The document with the given ID.
+     */
     search(search: string): Promise<Document>;
+    /**
+     * Adds new documents to the store.
+     * @param texts An object where the keys are document IDs and the values are the documents themselves.
+     * @returns Void
+     */
     add(texts: Record<string, Document>): Promise<void>;
 }
+/**
+ * Class for storing and retrieving documents in memory synchronously.
+ */
 export declare class SynchronousInMemoryDocstore {
     _docs: Map<string, Document>;
     constructor(docs?: Map<string, Document>);
+    /**
+     * Searches for a document in the store based on its ID.
+     * @param search The ID of the document to search for.
+     * @returns The document with the given ID.
+     */
     search(search: string): Document;
+    /**
+     * Adds new documents to the store.
+     * @param texts An object where the keys are document IDs and the values are the documents themselves.
+     * @returns Void
+     */
     add(texts: Record<string, Document>): void;
 }

package/dist/stores/doc/in_memory.js

@@ -1,4 +1,8 @@
 import { Docstore } from "../../schema/index.js";
+/**
+ * Class for storing and retrieving documents in memory asynchronously.
+ * Extends the Docstore class.
+ */
 export class InMemoryDocstore extends Docstore {
     constructor(docs) {
         super();
@@ -10,6 +14,11 @@ export class InMemoryDocstore extends Docstore {
         });
         this._docs = docs ?? new Map();
     }
+    /**
+     * Searches for a document in the store based on its ID.
+     * @param search The ID of the document to search for.
+     * @returns The document with the given ID.
+     */
     async search(search) {
         const result = this._docs.get(search);
         if (!result) {
@@ -19,6 +28,11 @@ export class InMemoryDocstore extends Docstore {
             return result;
         }
     }
+    /**
+     * Adds new documents to the store.
+     * @param texts An object where the keys are document IDs and the values are the documents themselves.
+     * @returns Void
+     */
     async add(texts) {
         const keys = [...this._docs.keys()];
         const overlapping = Object.keys(texts).filter((x) => keys.includes(x));
@@ -30,6 +44,9 @@ export class InMemoryDocstore extends Docstore {
         }
     }
 }
+/**
+ * Class for storing and retrieving documents in memory synchronously.
+ */
 export class SynchronousInMemoryDocstore {
     constructor(docs) {
         Object.defineProperty(this, "_docs", {
@@ -40,6 +57,11 @@ export class SynchronousInMemoryDocstore {
         });
         this._docs = docs ?? new Map();
     }
+    /**
+     * Searches for a document in the store based on its ID.
+     * @param search The ID of the document to search for.
+     * @returns The document with the given ID.
+     */
     search(search) {
         const result = this._docs.get(search);
         if (!result) {
@@ -49,6 +71,11 @@ export class SynchronousInMemoryDocstore {
             return result;
         }
     }
+    /**
+     * Adds new documents to the store.
+     * @param texts An object where the keys are document IDs and the values are the documents themselves.
+     * @returns Void
+     */
     add(texts) {
         const keys = [...this._docs.keys()];
         const overlapping = Object.keys(texts).filter((x) => keys.includes(x));

package/dist/stores/file/in_memory.cjs

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InMemoryFileStore = void 0;
 const index_js_1 = require("../../schema/index.cjs");
+/**
+ * Class that provides an in-memory file storage system. It extends the
+ * BaseFileStore class and implements its readFile and writeFile methods.
+ * This class is typically used in scenarios where temporary, in-memory
+ * file storage is needed, such as during testing or for caching files in
+ * memory for quick access.
+ */
 class InMemoryFileStore extends index_js_1.BaseFileStore {
     constructor() {
         super(...arguments);
@@ -18,6 +25,12 @@ class InMemoryFileStore extends index_js_1.BaseFileStore {
             value: new Map()
         });
     }
+    /**
+     * Retrieves the contents of a file given its path. If the file does not
+     * exist, it throws an error.
+     * @param path The path of the file to read.
+     * @returns The contents of the file as a string.
+     */
     async readFile(path) {
         const contents = this.files.get(path);
         if (contents === undefined) {
@@ -25,6 +38,13 @@ class InMemoryFileStore extends index_js_1.BaseFileStore {
         }
         return contents;
     }
+    /**
+     * Writes contents to a file at a given path. If the file already exists,
+     * it overwrites the existing contents.
+     * @param path The path of the file to write.
+     * @param contents The contents to write to the file.
+     * @returns Void
+     */
     async writeFile(path, contents) {
         this.files.set(path, contents);
     }

package/dist/stores/file/in_memory.d.ts

@@ -1,7 +1,27 @@
 import { BaseFileStore } from "../../schema/index.js";
+/**
+ * Class that provides an in-memory file storage system. It extends the
+ * BaseFileStore class and implements its readFile and writeFile methods.
+ * This class is typically used in scenarios where temporary, in-memory
+ * file storage is needed, such as during testing or for caching files in
+ * memory for quick access.
+ */
 export declare class InMemoryFileStore extends BaseFileStore {
     lc_namespace: string[];
     private files;
+    /**
+     * Retrieves the contents of a file given its path. If the file does not
+     * exist, it throws an error.
+     * @param path The path of the file to read.
+     * @returns The contents of the file as a string.
+     */
     readFile(path: string): Promise<string>;
+    /**
+     * Writes contents to a file at a given path. If the file already exists,
+     * it overwrites the existing contents.
+     * @param path The path of the file to write.
+     * @param contents The contents to write to the file.
+     * @returns Void
+     */
     writeFile(path: string, contents: string): Promise<void>;
 }

package/dist/stores/file/in_memory.js

@@ -1,4 +1,11 @@
 import { BaseFileStore } from "../../schema/index.js";
+/**
+ * Class that provides an in-memory file storage system. It extends the
+ * BaseFileStore class and implements its readFile and writeFile methods.
+ * This class is typically used in scenarios where temporary, in-memory
+ * file storage is needed, such as during testing or for caching files in
+ * memory for quick access.
+ */
 export class InMemoryFileStore extends BaseFileStore {
     constructor() {
         super(...arguments);
@@ -15,6 +22,12 @@ export class InMemoryFileStore extends BaseFileStore {
             value: new Map()
         });
     }
+    /**
+     * Retrieves the contents of a file given its path. If the file does not
+     * exist, it throws an error.
+     * @param path The path of the file to read.
+     * @returns The contents of the file as a string.
+     */
     async readFile(path) {
         const contents = this.files.get(path);
         if (contents === undefined) {
@@ -22,6 +35,13 @@ export class InMemoryFileStore extends BaseFileStore {
         }
         return contents;
     }
+    /**
+     * Writes contents to a file at a given path. If the file already exists,
+     * it overwrites the existing contents.
+     * @param path The path of the file to write.
+     * @param contents The contents to write to the file.
+     * @returns Void
+     */
     async writeFile(path, contents) {
         this.files.set(path, contents);
     }

package/dist/stores/file/node.cjs

@@ -28,6 +28,10 @@ const fs = __importStar(require("node:fs/promises"));
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const index_js_1 = require("../../schema/index.cjs");
+/**
+ * Specific implementation of the `BaseFileStore` class for Node.js.
+ * Provides methods to read and write files in a specific base path.
+ */
 class NodeFileStore extends index_js_1.BaseFileStore {
     constructor(basePath = (0, node_fs_1.mkdtempSync)("langchain-")) {
         super();
@@ -44,9 +48,20 @@ class NodeFileStore extends index_js_1.BaseFileStore {
             value: ["langchain", "stores", "file", "node"]
         });
     }
+    /**
+     * Reads the contents of a file at the given path.
+     * @param path Path of the file to read.
+     * @returns The contents of the file as a string.
+     */
     async readFile(path) {
         return await fs.readFile((0, node_path_1.join)(this.basePath, path), "utf8");
     }
+    /**
+     * Writes the given contents to a file at the specified path.
+     * @param path Path of the file to write to.
+     * @param contents Contents to write to the file.
+     * @returns Promise that resolves when the file has been written.
+     */
     async writeFile(path, contents) {
         await fs.writeFile((0, node_path_1.join)(this.basePath, path), contents, "utf8");
     }

package/dist/stores/file/node.d.ts

@@ -1,8 +1,23 @@
 import { BaseFileStore } from "../../schema/index.js";
+/**
+ * Specific implementation of the `BaseFileStore` class for Node.js.
+ * Provides methods to read and write files in a specific base path.
+ */
 export declare class NodeFileStore extends BaseFileStore {
     basePath: string;
     lc_namespace: string[];
     constructor(basePath?: string);
+    /**
+     * Reads the contents of a file at the given path.
+     * @param path Path of the file to read.
+     * @returns The contents of the file as a string.
+     */
     readFile(path: string): Promise<string>;
+    /**
+     * Writes the given contents to a file at the specified path.
+     * @param path Path of the file to write to.
+     * @param contents Contents to write to the file.
+     * @returns Promise that resolves when the file has been written.
+     */
     writeFile(path: string, contents: string): Promise<void>;
 }

package/dist/stores/file/node.js

@@ -2,6 +2,10 @@ import * as fs from "node:fs/promises";
 import { mkdtempSync } from "node:fs";
 import { join } from "node:path";
 import { BaseFileStore } from "../../schema/index.js";
+/**
+ * Specific implementation of the `BaseFileStore` class for Node.js.
+ * Provides methods to read and write files in a specific base path.
+ */
 export class NodeFileStore extends BaseFileStore {
     constructor(basePath = mkdtempSync("langchain-")) {
         super();
@@ -18,9 +22,20 @@ export class NodeFileStore extends BaseFileStore {
             value: ["langchain", "stores", "file", "node"]
         });
     }
+    /**
+     * Reads the contents of a file at the given path.
+     * @param path Path of the file to read.
+     * @returns The contents of the file as a string.
+     */
     async readFile(path) {
         return await fs.readFile(join(this.basePath, path), "utf8");
     }
+    /**
+     * Writes the given contents to a file at the specified path.
+     * @param path Path of the file to write to.
+     * @param contents Contents to write to the file.
+     * @returns Promise that resolves when the file has been written.
+     */
     async writeFile(path, contents) {
         await fs.writeFile(join(this.basePath, path), contents, "utf8");
     }

package/dist/stores/message/dynamodb.cjs

@@ -4,6 +4,11 @@ exports.DynamoDBChatMessageHistory = void 0;
 const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const index_js_1 = require("../../schema/index.cjs");
 const utils_js_1 = require("./utils.cjs");
+/**
+ * Class providing methods to interact with a DynamoDB table to store and
+ * retrieve chat messages. It extends the `BaseListChatMessageHistory`
+ * class.
+ */
 class DynamoDBChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -75,6 +80,11 @@ class DynamoDBChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             this.dynamoKey[this.sortKey] = { S: this.sortKey };
         }
     }
+    /**
+     * Retrieves all messages from the DynamoDB table and returns them as an
+     * array of `BaseMessage` instances.
+     * @returns Array of stored messages
+     */
     async getMessages() {
         const params = {
             TableName: this.tableName,
@@ -95,6 +105,9 @@ class DynamoDBChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             .filter((x) => x.type !== undefined && x.data.content !== undefined);
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(messages);
     }
+    /**
+     * Deletes all messages from the DynamoDB table.
+     */
     async clear() {
         const params = {
             TableName: this.tableName,
@@ -102,6 +115,10 @@ class DynamoDBChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         };
         await this.client.send(new client_dynamodb_1.DeleteItemCommand(params));
     }
+    /**
+     * Adds a new message to the DynamoDB table.
+     * @param message The message to be added to the DynamoDB table.
+     */
     async addMessage(message) {
         const messages = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
         const params = {

package/dist/stores/message/dynamodb.d.ts

@@ -1,5 +1,11 @@
 import { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Interface defining the fields required to create an instance of
+ * `DynamoDBChatMessageHistory`. It includes the DynamoDB table name,
+ * session ID, partition key, sort key, message attribute name, and
+ * DynamoDB client configuration.
+ */
 export interface DynamoDBChatMessageHistoryFields {
     tableName: string;
     sessionId: string;
@@ -8,6 +14,11 @@ export interface DynamoDBChatMessageHistoryFields {
     messageAttributeName?: string;
     config?: DynamoDBClientConfig;
 }
+/**
+ * Class providing methods to interact with a DynamoDB table to store and
+ * retrieve chat messages. It extends the `BaseListChatMessageHistory`
+ * class.
+ */
 export declare class DynamoDBChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     get lc_secrets(): {
@@ -21,7 +32,19 @@ export declare class DynamoDBChatMessageHistory extends BaseListChatMessageHisto
     private messageAttributeName;
     private dynamoKey;
     constructor({ tableName, sessionId, partitionKey, sortKey, messageAttributeName, config, }: DynamoDBChatMessageHistoryFields);
+    /**
+     * Retrieves all messages from the DynamoDB table and returns them as an
+     * array of `BaseMessage` instances.
+     * @returns Array of stored messages
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Deletes all messages from the DynamoDB table.
+     */
     clear(): Promise<void>;
+    /**
+     * Adds a new message to the DynamoDB table.
+     * @param message The message to be added to the DynamoDB table.
+     */
     addMessage(message: BaseMessage): Promise<void>;
 }

package/dist/stores/message/dynamodb.js

@@ -1,6 +1,11 @@
 import { DynamoDBClient, GetItemCommand, UpdateItemCommand, DeleteItemCommand, } from "@aws-sdk/client-dynamodb";
 import { BaseListChatMessageHistory, } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class providing methods to interact with a DynamoDB table to store and
+ * retrieve chat messages. It extends the `BaseListChatMessageHistory`
+ * class.
+ */
 export class DynamoDBChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -72,6 +77,11 @@ export class DynamoDBChatMessageHistory extends BaseListChatMessageHistory {
             this.dynamoKey[this.sortKey] = { S: this.sortKey };
         }
     }
+    /**
+     * Retrieves all messages from the DynamoDB table and returns them as an
+     * array of `BaseMessage` instances.
+     * @returns Array of stored messages
+     */
     async getMessages() {
         const params = {
             TableName: this.tableName,
@@ -92,6 +102,9 @@ export class DynamoDBChatMessageHistory extends BaseListChatMessageHistory {
             .filter((x) => x.type !== undefined && x.data.content !== undefined);
         return mapStoredMessagesToChatMessages(messages);
     }
+    /**
+     * Deletes all messages from the DynamoDB table.
+     */
     async clear() {
         const params = {
             TableName: this.tableName,
@@ -99,6 +112,10 @@ export class DynamoDBChatMessageHistory extends BaseListChatMessageHistory {
         };
         await this.client.send(new DeleteItemCommand(params));
     }
+    /**
+     * Adds a new message to the DynamoDB table.
+     * @param message The message to be added to the DynamoDB table.
+     */
     async addMessage(message) {
         const messages = mapChatMessagesToStoredMessages([message]);
         const params = {