langchain 0.0.130 → 0.0.132

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

@@ -1,11 +1,19 @@
 import { Client as PlanetScaleClient, Config as PlanetScaleConfig } from "@planetscale/database";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Type definition for the input parameters required when instantiating a
+ * PlanetScaleChatMessageHistory object.
+ */
 export type PlanetScaleChatMessageHistoryInput = {
     tableName?: string;
     sessionId: string;
     config?: PlanetScaleConfig;
     client?: PlanetScaleClient;
 };
+/**
+ * Class for storing and retrieving chat message history from a
+ * PlanetScale database. Extends the BaseListChatMessageHistory class.
+ */
 export declare class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     get lc_secrets(): {
@@ -20,8 +28,30 @@ export declare class PlanetScaleChatMessageHistory extends BaseListChatMessageHi
     private sessionId;
     private tableInitialized;
     constructor(fields: PlanetScaleChatMessageHistoryInput);
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * PlanetScale database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
     private ensureTable;
+    /**
+     * Method to retrieve all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Method to add a new message to the PlanetScale database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Method to delete all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/planetscale.js

@@ -1,6 +1,10 @@
 import { Client as PlanetScaleClient, } from "@planetscale/database";
 import { BaseListChatMessageHistory, } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class for storing and retrieving chat message history from a
+ * PlanetScale database. Extends the BaseListChatMessageHistory class.
+ */
 export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -63,6 +67,12 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         this.tableInitialized = false;
         this.sessionId = sessionId;
     }
+    /**
+     * Private method to ensure that the necessary table exists in the
+     * PlanetScale database before performing any operations. If the table
+     * does not exist, it is created.
+     * @returns Promise that resolves to void.
+     */
     async ensureTable() {
         if (this.tableInitialized) {
             return;
@@ -73,6 +83,11 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         await this.connection.execute(indexQuery);
         this.tableInitialized = true;
     }
+    /**
+     * Method to retrieve all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to an array of BaseMessage objects.
+     */
     async getMessages() {
         await this.ensureTable();
         const query = `SELECT * FROM ${this.tableName} WHERE session_id = :session_id`;
@@ -99,6 +114,12 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         });
         return mapStoredMessagesToChatMessages(orderedMessages);
     }
+    /**
+     * Method to add a new message to the PlanetScale database for the current
+     * session.
+     * @param message The BaseMessage object to be added to the database.
+     * @returns Promise that resolves to void.
+     */
     async addMessage(message) {
         await this.ensureTable();
         const messageToAdd = mapChatMessagesToStoredMessages([message]);
@@ -113,6 +134,11 @@ export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
         };
         await this.connection.execute(query, params);
     }
+    /**
+     * Method to delete all messages from the PlanetScale database for the
+     * current session.
+     * @returns Promise that resolves to void.
+     */
     async clear() {
         await this.ensureTable();
         const query = `DELETE FROM ${this.tableName} WHERE session_id = :session_id`;

package/dist/stores/message/redis.cjs

@@ -5,6 +5,10 @@ exports.RedisChatMessageHistory = void 0;
 const redis_1 = require("redis");
 const index_js_1 = require("../../schema/index.cjs");
 const utils_js_1 = require("./utils.cjs");
+/**
+ * Class for storing chat message history using Redis. Extends the
+ * `BaseListChatMessageHistory` class.
+ */
 class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -44,12 +48,22 @@ class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         this.sessionId = sessionId;
         this.sessionTTL = sessionTTL;
     }
+    /**
+     * Ensures the Redis client is ready to perform operations. If the client
+     * is not ready, it attempts to connect to the Redis database.
+     * @returns Promise resolving to true when the client is ready.
+     */
     async ensureReadiness() {
         if (!this.client.isReady) {
             await this.client.connect();
         }
         return true;
     }
+    /**
+     * Retrieves all chat messages from the Redis database for the current
+     * session.
+     * @returns Promise resolving to an array of `BaseMessage` instances.
+     */
     async getMessages() {
         await this.ensureReadiness();
         const rawStoredMessages = await this.client.lRange(this.sessionId, 0, -1);
@@ -58,6 +72,11 @@ class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             .map((message) => JSON.parse(message));
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(orderedMessages);
     }
+    /**
+     * Adds a new chat message to the Redis database for the current session.
+     * @param message The `BaseMessage` instance to add.
+     * @returns Promise resolving when the message has been added.
+     */
     async addMessage(message) {
         await this.ensureReadiness();
         const messageToAdd = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
@@ -66,6 +85,11 @@ class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             await this.client.expire(this.sessionId, this.sessionTTL);
         }
     }
+    /**
+     * Deletes all chat messages from the Redis database for the current
+     * session.
+     * @returns Promise resolving when the messages have been deleted.
+     */
     async clear() {
         await this.ensureReadiness();
         await this.client.del(this.sessionId);

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

@@ -1,11 +1,18 @@
 import { RedisClientOptions, RedisClientType, RedisModules, RedisFunctions, RedisScripts } from "redis";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Type for the input to the `RedisChatMessageHistory` constructor.
+ */
 export type RedisChatMessageHistoryInput = {
     sessionId: string;
     sessionTTL?: number;
     config?: RedisClientOptions;
     client?: any;
 };
+/**
+ * Class for storing chat message history using Redis. Extends the
+ * `BaseListChatMessageHistory` class.
+ */
 export declare class RedisChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     get lc_secrets(): {
@@ -17,8 +24,28 @@ export declare class RedisChatMessageHistory extends BaseListChatMessageHistory
     private sessionId;
     private sessionTTL?;
     constructor(fields: RedisChatMessageHistoryInput);
+    /**
+     * Ensures the Redis client is ready to perform operations. If the client
+     * is not ready, it attempts to connect to the Redis database.
+     * @returns Promise resolving to true when the client is ready.
+     */
     ensureReadiness(): Promise<boolean>;
+    /**
+     * Retrieves all chat messages from the Redis database for the current
+     * session.
+     * @returns Promise resolving to an array of `BaseMessage` instances.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Adds a new chat message to the Redis database for the current session.
+     * @param message The `BaseMessage` instance to add.
+     * @returns Promise resolving when the message has been added.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Deletes all chat messages from the Redis database for the current
+     * session.
+     * @returns Promise resolving when the messages have been deleted.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/redis.js

@@ -2,6 +2,10 @@
 import { createClient, } from "redis";
 import { BaseListChatMessageHistory } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class for storing chat message history using Redis. Extends the
+ * `BaseListChatMessageHistory` class.
+ */
 export class RedisChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -41,12 +45,22 @@ export class RedisChatMessageHistory extends BaseListChatMessageHistory {
         this.sessionId = sessionId;
         this.sessionTTL = sessionTTL;
     }
+    /**
+     * Ensures the Redis client is ready to perform operations. If the client
+     * is not ready, it attempts to connect to the Redis database.
+     * @returns Promise resolving to true when the client is ready.
+     */
     async ensureReadiness() {
         if (!this.client.isReady) {
             await this.client.connect();
         }
         return true;
     }
+    /**
+     * Retrieves all chat messages from the Redis database for the current
+     * session.
+     * @returns Promise resolving to an array of `BaseMessage` instances.
+     */
     async getMessages() {
         await this.ensureReadiness();
         const rawStoredMessages = await this.client.lRange(this.sessionId, 0, -1);
@@ -55,6 +69,11 @@ export class RedisChatMessageHistory extends BaseListChatMessageHistory {
             .map((message) => JSON.parse(message));
         return mapStoredMessagesToChatMessages(orderedMessages);
     }
+    /**
+     * Adds a new chat message to the Redis database for the current session.
+     * @param message The `BaseMessage` instance to add.
+     * @returns Promise resolving when the message has been added.
+     */
     async addMessage(message) {
         await this.ensureReadiness();
         const messageToAdd = mapChatMessagesToStoredMessages([message]);
@@ -63,6 +82,11 @@ export class RedisChatMessageHistory extends BaseListChatMessageHistory {
             await this.client.expire(this.sessionId, this.sessionTTL);
         }
     }
+    /**
+     * Deletes all chat messages from the Redis database for the current
+     * session.
+     * @returns Promise resolving when the messages have been deleted.
+     */
     async clear() {
         await this.ensureReadiness();
         await this.client.del(this.sessionId);

package/dist/stores/message/upstash_redis.cjs

@@ -4,6 +4,10 @@ exports.UpstashRedisChatMessageHistory = void 0;
 const redis_1 = require("@upstash/redis");
 const index_js_1 = require("../../schema/index.cjs");
 const utils_js_1 = require("./utils.cjs");
+/**
+ * Class used to store chat message history in Redis. It provides methods
+ * to add, get, and clear messages.
+ */
 class UpstashRedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -50,12 +54,21 @@ class UpstashRedisChatMessageHistory extends index_js_1.BaseListChatMessageHisto
         this.sessionId = sessionId;
         this.sessionTTL = sessionTTL;
     }
+    /**
+     * Retrieves the chat messages from the Redis database.
+     * @returns An array of BaseMessage instances representing the chat history.
+     */
     async getMessages() {
         const rawStoredMessages = await this.client.lrange(this.sessionId, 0, -1);
         const orderedMessages = rawStoredMessages.reverse();
         const previousMessages = orderedMessages.filter((x) => x.type !== undefined && x.data.content !== undefined);
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(previousMessages);
     }
+    /**
+     * Adds a new message to the chat history in the Redis database.
+     * @param message The message to be added to the chat history.
+     * @returns Promise resolving to void.
+     */
     async addMessage(message) {
         const messageToAdd = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
         await this.client.lpush(this.sessionId, JSON.stringify(messageToAdd[0]));
@@ -63,6 +76,10 @@ class UpstashRedisChatMessageHistory extends index_js_1.BaseListChatMessageHisto
             await this.client.expire(this.sessionId, this.sessionTTL);
         }
     }
+    /**
+     * Deletes all messages from the chat history in the Redis database.
+     * @returns Promise resolving to void.
+     */
     async clear() {
         await this.client.del(this.sessionId);
     }

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

@@ -1,11 +1,19 @@
 import { Redis, type RedisConfigNodejs } from "@upstash/redis";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * Type definition for the input parameters required to initialize an
+ * instance of the UpstashRedisChatMessageHistory class.
+ */
 export type UpstashRedisChatMessageHistoryInput = {
     sessionId: string;
     sessionTTL?: number;
     config?: RedisConfigNodejs;
     client?: Redis;
 };
+/**
+ * Class used to store chat message history in Redis. It provides methods
+ * to add, get, and clear messages.
+ */
 export declare class UpstashRedisChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];
     get lc_secrets(): {
@@ -16,7 +24,20 @@ export declare class UpstashRedisChatMessageHistory extends BaseListChatMessageH
     private sessionId;
     private sessionTTL?;
     constructor(fields: UpstashRedisChatMessageHistoryInput);
+    /**
+     * Retrieves the chat messages from the Redis database.
+     * @returns An array of BaseMessage instances representing the chat history.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Adds a new message to the chat history in the Redis database.
+     * @param message The message to be added to the chat history.
+     * @returns Promise resolving to void.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Deletes all messages from the chat history in the Redis database.
+     * @returns Promise resolving to void.
+     */
     clear(): Promise<void>;
 }

package/dist/stores/message/upstash_redis.js

@@ -1,6 +1,10 @@
 import { Redis } from "@upstash/redis";
 import { BaseListChatMessageHistory, } from "../../schema/index.js";
 import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } from "./utils.js";
+/**
+ * Class used to store chat message history in Redis. It provides methods
+ * to add, get, and clear messages.
+ */
 export class UpstashRedisChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {
         return {
@@ -47,12 +51,21 @@ export class UpstashRedisChatMessageHistory extends BaseListChatMessageHistory {
         this.sessionId = sessionId;
         this.sessionTTL = sessionTTL;
     }
+    /**
+     * Retrieves the chat messages from the Redis database.
+     * @returns An array of BaseMessage instances representing the chat history.
+     */
     async getMessages() {
         const rawStoredMessages = await this.client.lrange(this.sessionId, 0, -1);
         const orderedMessages = rawStoredMessages.reverse();
         const previousMessages = orderedMessages.filter((x) => x.type !== undefined && x.data.content !== undefined);
         return mapStoredMessagesToChatMessages(previousMessages);
     }
+    /**
+     * Adds a new message to the chat history in the Redis database.
+     * @param message The message to be added to the chat history.
+     * @returns Promise resolving to void.
+     */
     async addMessage(message) {
         const messageToAdd = mapChatMessagesToStoredMessages([message]);
         await this.client.lpush(this.sessionId, JSON.stringify(messageToAdd[0]));
@@ -60,6 +73,10 @@ export class UpstashRedisChatMessageHistory extends BaseListChatMessageHistory {
             await this.client.expire(this.sessionId, this.sessionTTL);
         }
     }
+    /**
+     * Deletes all messages from the chat history in the Redis database.
+     * @returns Promise resolving to void.
+     */
     async clear() {
         await this.client.del(this.sessionId);
     }

package/dist/stores/message/utils.cjs

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapChatMessagesToStoredMessages = exports.mapStoredMessagesToChatMessages = exports.mapV1MessageToStoredMessage = void 0;
 const index_js_1 = require("../../schema/index.cjs");
+/**
+ * Maps messages from an older format (V1) to the current `StoredMessage`
+ * format. If the message is already in the `StoredMessage` format, it is
+ * returned as is. Otherwise, it transforms the V1 message into a
+ * `StoredMessage`. This function is important for maintaining
+ * compatibility with older message formats.
+ */
 function mapV1MessageToStoredMessage(message) {
     // TODO: Remove this mapper when we deprecate the old message format.
     if (message.data !== undefined) {
@@ -20,6 +27,14 @@ function mapV1MessageToStoredMessage(message) {
     }
 }
 exports.mapV1MessageToStoredMessage = mapV1MessageToStoredMessage;
+/**
+ * Transforms an array of `StoredMessage` instances into an array of
+ * `BaseMessage` instances. It uses the `mapV1MessageToStoredMessage`
+ * function to ensure all messages are in the `StoredMessage` format, then
+ * creates new instances of the appropriate `BaseMessage` subclass based
+ * on the type of each message. This function is used to prepare stored
+ * messages for use in a chat context.
+ */
 function mapStoredMessagesToChatMessages(messages) {
     return messages.map((message) => {
         const storedMessage = mapV1MessageToStoredMessage(message);
@@ -47,6 +62,12 @@ function mapStoredMessagesToChatMessages(messages) {
     });
 }
 exports.mapStoredMessagesToChatMessages = mapStoredMessagesToChatMessages;
+/**
+ * Transforms an array of `BaseMessage` instances into an array of
+ * `StoredMessage` instances. It does this by calling the `toDict` method
+ * on each `BaseMessage`, which returns a `StoredMessage`. This function
+ * is used to prepare chat messages for storage.
+ */
 function mapChatMessagesToStoredMessages(messages) {
     return messages.map((message) => message.toDict());
 }

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

@@ -4,7 +4,28 @@ interface StoredMessageV1 {
     role: string | undefined;
     text: string;
 }
+/**
+ * Maps messages from an older format (V1) to the current `StoredMessage`
+ * format. If the message is already in the `StoredMessage` format, it is
+ * returned as is. Otherwise, it transforms the V1 message into a
+ * `StoredMessage`. This function is important for maintaining
+ * compatibility with older message formats.
+ */
 export declare function mapV1MessageToStoredMessage(message: StoredMessage | StoredMessageV1): StoredMessage;
+/**
+ * Transforms an array of `StoredMessage` instances into an array of
+ * `BaseMessage` instances. It uses the `mapV1MessageToStoredMessage`
+ * function to ensure all messages are in the `StoredMessage` format, then
+ * creates new instances of the appropriate `BaseMessage` subclass based
+ * on the type of each message. This function is used to prepare stored
+ * messages for use in a chat context.
+ */
 export declare function mapStoredMessagesToChatMessages(messages: StoredMessage[]): BaseMessage[];
+/**
+ * Transforms an array of `BaseMessage` instances into an array of
+ * `StoredMessage` instances. It does this by calling the `toDict` method
+ * on each `BaseMessage`, which returns a `StoredMessage`. This function
+ * is used to prepare chat messages for storage.
+ */
 export declare function mapChatMessagesToStoredMessages(messages: BaseMessage[]): StoredMessage[];
 export {};

package/dist/stores/message/utils.js

@@ -1,4 +1,11 @@
 import { AIMessage, ChatMessage, FunctionMessage, HumanMessage, SystemMessage, } from "../../schema/index.js";
+/**
+ * Maps messages from an older format (V1) to the current `StoredMessage`
+ * format. If the message is already in the `StoredMessage` format, it is
+ * returned as is. Otherwise, it transforms the V1 message into a
+ * `StoredMessage`. This function is important for maintaining
+ * compatibility with older message formats.
+ */
 export function mapV1MessageToStoredMessage(message) {
     // TODO: Remove this mapper when we deprecate the old message format.
     if (message.data !== undefined) {
@@ -16,6 +23,14 @@ export function mapV1MessageToStoredMessage(message) {
         };
     }
 }
+/**
+ * Transforms an array of `StoredMessage` instances into an array of
+ * `BaseMessage` instances. It uses the `mapV1MessageToStoredMessage`
+ * function to ensure all messages are in the `StoredMessage` format, then
+ * creates new instances of the appropriate `BaseMessage` subclass based
+ * on the type of each message. This function is used to prepare stored
+ * messages for use in a chat context.
+ */
 export function mapStoredMessagesToChatMessages(messages) {
     return messages.map((message) => {
         const storedMessage = mapV1MessageToStoredMessage(message);
@@ -42,6 +57,12 @@ export function mapStoredMessagesToChatMessages(messages) {
         }
     });
 }
+/**
+ * Transforms an array of `BaseMessage` instances into an array of
+ * `StoredMessage` instances. It does this by calling the `toDict` method
+ * on each `BaseMessage`, which returns a `StoredMessage`. This function
+ * is used to prepare chat messages for storage.
+ */
 export function mapChatMessagesToStoredMessages(messages) {
     return messages.map((message) => message.toDict());
 }

package/dist/stores/message/xata.cjs

@@ -12,6 +12,12 @@ const chatMemoryColumns = [
     { name: "name", type: "string" },
     { name: "additionalKwargs", type: "text" },
 ];
+/**
+ * A class for managing chat message history using Xata.io client. It
+ * extends the BaseListChatMessageHistory class and provides methods to
+ * get, add, and clear messages. It also ensures the existence of a table
+ * where the chat messages are stored.
+ */
 class XataChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     constructor(fields) {
         super(fields);
@@ -82,6 +88,11 @@ class XataChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         }
         this.tableInitialized = false;
     }
+    /**
+     * Retrieves all messages associated with the session ID, ordered by
+     * creation time.
+     * @returns A promise that resolves to an array of BaseMessage instances.
+     */
     async getMessages() {
         await this.ensureTable();
         const records = await this.client.db[this.table]
@@ -107,6 +118,11 @@ class XataChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         });
         return (0, utils_js_1.mapStoredMessagesToChatMessages)(orderedMessages);
     }
+    /**
+     * Adds a new message to the database.
+     * @param message The BaseMessage instance to be added.
+     * @returns A promise that resolves when the message has been added.
+     */
     async addMessage(message) {
         await this.ensureTable();
         const messageToAdd = (0, utils_js_1.mapChatMessagesToStoredMessages)([message]);
@@ -119,6 +135,10 @@ class XataChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
             additionalKwargs: JSON.stringify(messageToAdd[0].data.additional_kwargs),
         });
     }
+    /**
+     * Deletes all messages associated with the session ID.
+     * @returns A promise that resolves when the messages have been deleted.
+     */
     async clear() {
         await this.ensureTable();
         const records = await this.client.db[this.table]
@@ -128,6 +148,11 @@ class XataChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
         const ids = records.map((m) => m.id);
         await this.client.db[this.table].delete(ids);
     }
+    /**
+     * Checks if the table exists and creates it if it doesn't. This method is
+     * called before any operation on the table.
+     * @returns A promise that resolves when the table has been ensured.
+     */
     async ensureTable() {
         if (!this.createTable) {
             return;

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

@@ -1,5 +1,9 @@
 import { BaseClient, BaseClientOptions } from "@xata.io/client";
 import { BaseMessage, BaseListChatMessageHistory } from "../../schema/index.js";
+/**
+ * An object type that represents the input for the XataChatMessageHistory
+ * class.
+ */
 export type XataChatMessageHistoryInput<XataClient> = {
     sessionId: string;
     config?: BaseClientOptions;
@@ -8,6 +12,12 @@ export type XataChatMessageHistoryInput<XataClient> = {
     createTable?: boolean;
     apiKey?: string;
 };
+/**
+ * A class for managing chat message history using Xata.io client. It
+ * extends the BaseListChatMessageHistory class and provides methods to
+ * get, add, and clear messages. It also ensures the existence of a table
+ * where the chat messages are stored.
+ */
 export declare class XataChatMessageHistory<XataClient extends BaseClient> extends BaseListChatMessageHistory {
     lc_namespace: string[];
     client: XataClient;
@@ -17,8 +27,27 @@ export declare class XataChatMessageHistory<XataClient extends BaseClient> exten
     private createTable;
     private apiClient;
     constructor(fields: XataChatMessageHistoryInput<XataClient>);
+    /**
+     * Retrieves all messages associated with the session ID, ordered by
+     * creation time.
+     * @returns A promise that resolves to an array of BaseMessage instances.
+     */
     getMessages(): Promise<BaseMessage[]>;
+    /**
+     * Adds a new message to the database.
+     * @param message The BaseMessage instance to be added.
+     * @returns A promise that resolves when the message has been added.
+     */
     addMessage(message: BaseMessage): Promise<void>;
+    /**
+     * Deletes all messages associated with the session ID.
+     * @returns A promise that resolves when the messages have been deleted.
+     */
     clear(): Promise<void>;
+    /**
+     * Checks if the table exists and creates it if it doesn't. This method is
+     * called before any operation on the table.
+     * @returns A promise that resolves when the table has been ensured.
+     */
     private ensureTable;
 }