langchain 0.0.153 → 0.0.155

package/dist/document_loaders/web/searchapi.d.ts

@@ -0,0 +1,65 @@
+import { Document } from "../../document.js";
+import { BaseDocumentLoader } from "../base.js";
+type JSONPrimitive = string | number | boolean | null;
+type JSONValue = JSONPrimitive | JSONObject | JSONArray;
+interface JSONObject {
+    [key: string]: JSONValue;
+}
+interface JSONArray extends Array<JSONValue> {
+}
+/**
+ * SearchApiParameters Type Definition.
+ *
+ * For more parameters and supported search engines, refer specific engine documentation:
+ * Google - https://www.searchapi.io/docs/google
+ * Google News - https://www.searchapi.io/docs/google-news
+ * Google Scholar - https://www.searchapi.io/docs/google-scholar
+ * YouTube Transcripts - https://www.searchapi.io/docs/youtube-transcripts
+ * and others.
+ *
+ */
+type SearchApiParameters = {
+    [key: string]: JSONValue;
+};
+/**
+ * Class representing a document loader for loading search results from
+ * the SearchApi. It extends the BaseDocumentLoader class.
+ */
+export declare class SearchApiLoader extends BaseDocumentLoader {
+    private apiKey;
+    private parameters;
+    constructor(params: SearchApiParameters);
+    /**
+     * Builds the URL for the SearchApi search request.
+     * @returns The URL for the search request.
+     */
+    buildUrl(): string;
+    /**
+     * Extracts documents from the provided output.
+     * @param output - The output to extract documents from.
+     * @param responseType - The type of the response to extract documents from.
+     * @returns An array of Documents.
+     */
+    private extractDocuments;
+    /**
+     * Processes the response data from the SearchApi search request and converts it into an array of Documents.
+     * @param data - The response data from the SearchApi search request.
+     * @returns An array of Documents.
+     */
+    processResponseData(data: Record<string, unknown>): Document[];
+    /**
+     * Fetches the data from the provided URL and returns it as a JSON object.
+     * If an error occurs during the fetch operation, an exception is thrown with the error message.
+     * @param url - The URL to fetch data from.
+     * @returns A promise that resolves to the fetched data as a JSON object.
+     * @throws An error if the fetch operation fails.
+     */
+    private fetchData;
+    /**
+     * Loads the search results from the SearchApi.
+     * @returns An array of Documents representing the search results.
+     * @throws An error if the search results could not be loaded.
+     */
+    load(): Promise<Document[]>;
+}
+export {};

package/dist/document_loaders/web/searchapi.js

@@ -0,0 +1,130 @@
+import { getEnvironmentVariable } from "../../util/env.js";
+import { Document } from "../../document.js";
+import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for loading search results from
+ * the SearchApi. It extends the BaseDocumentLoader class.
+ */
+export class SearchApiLoader extends BaseDocumentLoader {
+    constructor(params) {
+        super();
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "parameters", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const { apiKey = getEnvironmentVariable("SEARCHAPI_API_KEY") } = params;
+        if (typeof apiKey !== "string") {
+            throw new Error("Invalid type for apiKey. Expected string.");
+        }
+        if (!apiKey) {
+            throw new Error("SearchApi API key not set. You can set it as SEARCHAPI_API_KEY in your .env file, or pass it to SearchApi.");
+        }
+        this.apiKey = apiKey;
+        this.parameters = { ...params };
+    }
+    /**
+     * Builds the URL for the SearchApi search request.
+     * @returns The URL for the search request.
+     */
+    buildUrl() {
+        this.parameters = {
+            engine: "google",
+            api_key: this.apiKey,
+            ...this.parameters,
+        };
+        const preparedParams = Object.entries(this.parameters)
+            .filter(([key, value]) => value !== undefined && value !== null && key !== "apiKey")
+            .map(([key, value]) => [key, `${value}`]);
+        const searchParams = new URLSearchParams(preparedParams);
+        return `https://www.searchapi.io/api/v1/search?${searchParams}`;
+    }
+    /**
+     * Extracts documents from the provided output.
+     * @param output - The output to extract documents from.
+     * @param responseType - The type of the response to extract documents from.
+     * @returns An array of Documents.
+     */
+    extractDocuments(output, responseType) {
+        const documents = [];
+        const results = Array.isArray(output) ? output : [output];
+        if (responseType === "transcripts") {
+            const pageContent = results.map((result) => result.text).join("\n");
+            const metadata = {
+                source: "SearchApi",
+                responseType,
+            };
+            documents.push(new Document({ pageContent, metadata }));
+        }
+        else {
+            for (const result of results) {
+                const pageContent = JSON.stringify(result);
+                const metadata = {
+                    source: "SearchApi",
+                    responseType,
+                };
+                documents.push(new Document({ pageContent, metadata }));
+            }
+        }
+        return documents;
+    }
+    /**
+     * Processes the response data from the SearchApi search request and converts it into an array of Documents.
+     * @param data - The response data from the SearchApi search request.
+     * @returns An array of Documents.
+     */
+    processResponseData(data) {
+        const documents = [];
+        const responseTypes = [
+            "answer_box",
+            "shopping_results",
+            "knowledge_graph",
+            "organic_results",
+            "transcripts",
+        ];
+        for (const responseType of responseTypes) {
+            if (responseType in data) {
+                documents.push(...this.extractDocuments(data[responseType], responseType));
+            }
+        }
+        return documents;
+    }
+    /**
+     * Fetches the data from the provided URL and returns it as a JSON object.
+     * If an error occurs during the fetch operation, an exception is thrown with the error message.
+     * @param url - The URL to fetch data from.
+     * @returns A promise that resolves to the fetched data as a JSON object.
+     * @throws An error if the fetch operation fails.
+     */
+    async fetchData(url) {
+        const response = await fetch(url);
+        const data = await response.json();
+        if (data.error) {
+            throw new Error(`Failed to load search results from SearchApi due to: ${data.error}`);
+        }
+        return data;
+    }
+    /**
+     * Loads the search results from the SearchApi.
+     * @returns An array of Documents representing the search results.
+     * @throws An error if the search results could not be loaded.
+     */
+    async load() {
+        const url = this.buildUrl();
+        const data = await this.fetchData(url);
+        try {
+            return this.processResponseData(data);
+        }
+        catch (error) {
+            console.error(error);
+            throw new Error(`Failed to process search results from SearchApi: ${error}`);
+        }
+    }
+}

package/dist/llms/base.cjs

@@ -1,16 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LLM = exports.BaseLLM = void 0;
-const index_js_1 = require("../cache/index.cjs");
-const index_js_2 = require("../schema/index.cjs");
-const index_js_3 = require("../base_language/index.cjs");
+const index_js_1 = require("../schema/index.cjs");
+const index_js_2 = require("../base_language/index.cjs");
 const manager_js_1 = require("../callbacks/manager.cjs");
 const base_js_1 = require("../memory/base.cjs");
 /**
  * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
  */
-class BaseLLM extends index_js_3.BaseLanguageModel {
-    constructor({ cache, concurrency, ...rest }) {
+class BaseLLM extends index_js_2.BaseLanguageModel {
+    constructor({ concurrency, ...rest }) {
         super(concurrency ? { maxConcurrency: concurrency, ...rest } : rest);
         Object.defineProperty(this, "lc_namespace", {
             enumerable: true,
@@ -18,21 +17,6 @@ class BaseLLM extends index_js_3.BaseLanguageModel {
             writable: true,
             value: ["langchain", "llms", this._llmType()]
         });
-        Object.defineProperty(this, "cache", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        if (typeof cache === "object") {
-            this.cache = cache;
-        }
-        else if (cache) {
-            this.cache = index_js_1.InMemoryCache.global();
-        }
-        else {
-            this.cache = undefined;
-        }
     }
     /**
      * This method takes an input and options, and returns a string. It
@@ -72,7 +56,7 @@ class BaseLLM extends index_js_3.BaseLanguageModel {
                 invocation_params: this?.invocationParams(callOptions),
             };
             const runManagers = await callbackManager_?.handleLLMStart(this.toJSON(), [prompt.toString()], undefined, undefined, extra);
-            let generation = new index_js_2.GenerationChunk({
+            let generation = new index_js_1.GenerationChunk({
                 text: "",
             });
             try {
@@ -160,7 +144,7 @@ class BaseLLM extends index_js_3.BaseLanguageModel {
         // This defines RUN_KEY as a non-enumerable property on the output object
         // so that it is not serialized when the output is stringified, and so that
         // it isnt included when listing the keys of the output object.
-        Object.defineProperty(output, index_js_2.RUN_KEY, {
+        Object.defineProperty(output, index_js_1.RUN_KEY, {
             value: runIds ? { runIds } : undefined,
             configurable: true,
         });
@@ -186,9 +170,7 @@ class BaseLLM extends index_js_3.BaseLanguageModel {
             return this._generateUncached(prompts, callOptions, runnableConfig);
         }
         const { cache } = this;
-        const params = this.serialize();
-        params.stop = callOptions.stop ?? params.stop;
-        const llmStringKey = `${Object.entries(params).sort()}`;
+        const llmStringKey = this._getSerializedCacheKeyParametersForCall(callOptions);
         const missingPromptIndices = [];
         const generations = await Promise.all(prompts.map(async (prompt, index) => {
             const result = await cache.lookup(prompt, llmStringKey);
@@ -238,7 +220,7 @@ class BaseLLM extends index_js_3.BaseLanguageModel {
     async predictMessages(messages, options, callbacks) {
         const text = (0, base_js_1.getBufferString)(messages);
         const prediction = await this.call(text, options, callbacks);
-        return new index_js_2.AIMessage(prediction);
+        return new index_js_1.AIMessage(prediction);
     }
     /**
      * Get the identifying parameters of the LLM.
@@ -248,6 +230,7 @@ class BaseLLM extends index_js_3.BaseLanguageModel {
         return {};
     }
     /**
+     * @deprecated
      * Return a json-like object representing this LLM.
      */
     serialize() {
@@ -261,6 +244,7 @@ class BaseLLM extends index_js_3.BaseLanguageModel {
         return "base_llm";
     }
     /**
+     * @deprecated
      * Load an LLM from a json-like object describing it.
      */
     static async deserialize(data) {

package/dist/llms/base.d.ts

@@ -1,4 +1,4 @@
-import { BaseCache, BaseMessage, BasePromptValue, GenerationChunk, LLMResult } from "../schema/index.js";
+import { BaseMessage, BasePromptValue, GenerationChunk, LLMResult } from "../schema/index.js";
 import { BaseLanguageModel, BaseLanguageModelCallOptions, BaseLanguageModelInput, BaseLanguageModelParams } from "../base_language/index.js";
 import { BaseCallbackConfig, CallbackManagerForLLMRun, Callbacks } from "../callbacks/manager.js";
 import { RunnableConfig } from "../schema/runnable/config.js";
@@ -11,7 +11,6 @@ export interface BaseLLMParams extends BaseLanguageModelParams {
      * @deprecated Use `maxConcurrency` instead
      */
     concurrency?: number;
-    cache?: BaseCache | boolean;
 }
 export interface BaseLLMCallOptions extends BaseLanguageModelCallOptions {
 }
@@ -21,8 +20,7 @@ export interface BaseLLMCallOptions extends BaseLanguageModelCallOptions {
 export declare abstract class BaseLLM<CallOptions extends BaseLLMCallOptions = BaseLLMCallOptions> extends BaseLanguageModel<string, CallOptions> {
     ParsedCallOptions: Omit<CallOptions, keyof RunnableConfig & "timeout">;
     lc_namespace: string[];
-    cache?: BaseCache;
-    constructor({ cache, concurrency, ...rest }: BaseLLMParams);
+    constructor({ concurrency, ...rest }: BaseLLMParams);
     /**
      * This method takes an input and options, and returns a string. It
      * converts the input to a prompt value and generates a result based on
@@ -90,11 +88,13 @@ export declare abstract class BaseLLM<CallOptions extends BaseLLMCallOptions = B
      */
     abstract _llmType(): string;
     /**
+     * @deprecated
      * Return a json-like object representing this LLM.
      */
     serialize(): SerializedLLM;
     _modelType(): string;
     /**
+     * @deprecated
      * Load an LLM from a json-like object describing it.
      */
     static deserialize(data: SerializedLLM): Promise<BaseLLM>;

package/dist/llms/base.js

@@ -1,4 +1,3 @@
-import { InMemoryCache } from "../cache/index.js";
 import { AIMessage, GenerationChunk, RUN_KEY, } from "../schema/index.js";
 import { BaseLanguageModel, } from "../base_language/index.js";
 import { CallbackManager, } from "../callbacks/manager.js";
@@ -7,7 +6,7 @@ import { getBufferString } from "../memory/base.js";
  * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
  */
 export class BaseLLM extends BaseLanguageModel {
-    constructor({ cache, concurrency, ...rest }) {
+    constructor({ concurrency, ...rest }) {
         super(concurrency ? { maxConcurrency: concurrency, ...rest } : rest);
         Object.defineProperty(this, "lc_namespace", {
             enumerable: true,
@@ -15,21 +14,6 @@ export class BaseLLM extends BaseLanguageModel {
             writable: true,
             value: ["langchain", "llms", this._llmType()]
         });
-        Object.defineProperty(this, "cache", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        if (typeof cache === "object") {
-            this.cache = cache;
-        }
-        else if (cache) {
-            this.cache = InMemoryCache.global();
-        }
-        else {
-            this.cache = undefined;
-        }
     }
     /**
      * This method takes an input and options, and returns a string. It
@@ -183,9 +167,7 @@ export class BaseLLM extends BaseLanguageModel {
             return this._generateUncached(prompts, callOptions, runnableConfig);
         }
         const { cache } = this;
-        const params = this.serialize();
-        params.stop = callOptions.stop ?? params.stop;
-        const llmStringKey = `${Object.entries(params).sort()}`;
+        const llmStringKey = this._getSerializedCacheKeyParametersForCall(callOptions);
         const missingPromptIndices = [];
         const generations = await Promise.all(prompts.map(async (prompt, index) => {
             const result = await cache.lookup(prompt, llmStringKey);
@@ -245,6 +227,7 @@ export class BaseLLM extends BaseLanguageModel {
         return {};
     }
     /**
+     * @deprecated
      * Return a json-like object representing this LLM.
      */
     serialize() {
@@ -258,6 +241,7 @@ export class BaseLLM extends BaseLanguageModel {
         return "base_llm";
     }
     /**
+     * @deprecated
      * Load an LLM from a json-like object describing it.
      */
     static async deserialize(data) {

package/dist/load/import_constants.cjs

@@ -57,6 +57,7 @@ exports.optionalImportEntrypoints = [
     "langchain/vectorstores/singlestore",
     "langchain/vectorstores/tigris",
     "langchain/vectorstores/usearch",
+    "langchain/vectorstores/vercel_postgres",
     "langchain/vectorstores/voy",
     "langchain/vectorstores/zep",
     "langchain/memory/zep",

package/dist/load/import_constants.js

@@ -54,6 +54,7 @@ export const optionalImportEntrypoints = [
     "langchain/vectorstores/singlestore",
     "langchain/vectorstores/tigris",
     "langchain/vectorstores/usearch",
+    "langchain/vectorstores/vercel_postgres",
     "langchain/vectorstores/voy",
     "langchain/vectorstores/zep",
     "langchain/memory/zep",

package/dist/load/import_map.cjs

@@ -24,8 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.retrievers__databerry = exports.retrievers__remote = exports.output_parsers = exports.callbacks = exports.schema__storage = exports.schema__runnable = exports.schema__retriever = exports.schema__query_constructor = exports.schema__output_parser = exports.schema__document = exports.schema = exports.chat_models__minimax = exports.chat_models__ollama = exports.chat_models__baiduwenxin = exports.chat_models__fireworks = exports.chat_models__anthropic = exports.chat_models__openai = exports.chat_models__base = exports.document_transformers__openai_functions = exports.document_loaders__web__sort_xyz_blockchain = exports.document_loaders__web__serpapi = exports.document_loaders__base = exports.document = exports.memory = exports.text_splitter = exports.vectorstores__xata = exports.vectorstores__vectara = exports.vectorstores__prisma = exports.vectorstores__memory = exports.vectorstores__base = exports.prompts = exports.llms__fireworks = exports.llms__ollama = exports.llms__aleph_alpha = exports.llms__ai21 = exports.llms__openai = exports.llms__base = exports.embeddings__minimax = exports.embeddings__openai = exports.embeddings__ollama = exports.embeddings__fake = exports.embeddings__cache_backed = exports.embeddings__base = exports.chains__openai_functions = exports.chains = exports.tools = exports.base_language = exports.agents__toolkits = exports.agents = exports.load__serializable = void 0;
-exports.evaluation = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__autogpt = exports.util__math = exports.storage__in_memory = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.cache = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = void 0;
+exports.retrievers__remote = exports.output_parsers = exports.callbacks = exports.schema__storage = exports.schema__runnable = exports.schema__retriever = exports.schema__query_constructor = exports.schema__output_parser = exports.schema__document = exports.schema = exports.chat_models__minimax = exports.chat_models__ollama = exports.chat_models__baiduwenxin = exports.chat_models__fireworks = exports.chat_models__anthropic = exports.chat_models__openai = exports.chat_models__base = exports.document_transformers__openai_functions = exports.document_loaders__web__sort_xyz_blockchain = exports.document_loaders__web__serpapi = exports.document_loaders__web__searchapi = exports.document_loaders__base = exports.document = exports.memory = exports.text_splitter = exports.vectorstores__xata = exports.vectorstores__vectara = exports.vectorstores__prisma = exports.vectorstores__memory = exports.vectorstores__base = exports.prompts = exports.llms__fireworks = exports.llms__ollama = exports.llms__aleph_alpha = exports.llms__ai21 = exports.llms__openai = exports.llms__base = exports.embeddings__minimax = exports.embeddings__openai = exports.embeddings__ollama = exports.embeddings__fake = exports.embeddings__cache_backed = exports.embeddings__base = exports.chains__openai_functions = exports.chains = exports.tools = exports.base_language = exports.agents__toolkits = exports.agents = exports.load__serializable = void 0;
+exports.evaluation = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__autogpt = exports.util__math = exports.storage__in_memory = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.cache = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = exports.retrievers__databerry = void 0;
 exports.load__serializable = __importStar(require("../load/serializable.cjs"));
 exports.agents = __importStar(require("../agents/index.cjs"));
 exports.agents__toolkits = __importStar(require("../agents/toolkits/index.cjs"));
@@ -55,6 +55,7 @@ exports.text_splitter = __importStar(require("../text_splitter.cjs"));
 exports.memory = __importStar(require("../memory/index.cjs"));
 exports.document = __importStar(require("../document.cjs"));
 exports.document_loaders__base = __importStar(require("../document_loaders/base.cjs"));
+exports.document_loaders__web__searchapi = __importStar(require("../document_loaders/web/searchapi.cjs"));
 exports.document_loaders__web__serpapi = __importStar(require("../document_loaders/web/serpapi.cjs"));
 exports.document_loaders__web__sort_xyz_blockchain = __importStar(require("../document_loaders/web/sort_xyz_blockchain.cjs"));
 exports.document_transformers__openai_functions = __importStar(require("../document_transformers/openai_functions.cjs"));

package/dist/load/import_map.d.ts

@@ -27,6 +27,7 @@ export * as text_splitter from "../text_splitter.js";
 export * as memory from "../memory/index.js";
 export * as document from "../document.js";
 export * as document_loaders__base from "../document_loaders/base.js";
+export * as document_loaders__web__searchapi from "../document_loaders/web/searchapi.js";
 export * as document_loaders__web__serpapi from "../document_loaders/web/serpapi.js";
 export * as document_loaders__web__sort_xyz_blockchain from "../document_loaders/web/sort_xyz_blockchain.js";
 export * as document_transformers__openai_functions from "../document_transformers/openai_functions.js";

package/dist/load/import_map.js

@@ -28,6 +28,7 @@ export * as text_splitter from "../text_splitter.js";
 export * as memory from "../memory/index.js";
 export * as document from "../document.js";
 export * as document_loaders__base from "../document_loaders/base.js";
+export * as document_loaders__web__searchapi from "../document_loaders/web/searchapi.js";
 export * as document_loaders__web__serpapi from "../document_loaders/web/serpapi.js";
 export * as document_loaders__web__sort_xyz_blockchain from "../document_loaders/web/sort_xyz_blockchain.js";
 export * as document_transformers__openai_functions from "../document_transformers/openai_functions.js";

package/dist/schema/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Docstore = exports.BaseEntityStore = exports.BaseFileStore = exports.BaseCache = exports.BaseListChatMessageHistory = exports.BaseChatMessageHistory = exports.BasePromptValue = exports.ChatGenerationChunk = exports.ChatMessageChunk = exports.coerceMessageLikeToMessage = exports.isBaseMessage = exports.ChatMessage = exports.FunctionMessageChunk = exports.FunctionMessage = exports.SystemChatMessage = exports.AIChatMessage = exports.HumanChatMessage = exports.BaseChatMessage = exports.SystemMessageChunk = exports.SystemMessage = exports.AIMessageChunk = exports.AIMessage = exports.HumanMessageChunk = exports.HumanMessage = exports.BaseMessageChunk = exports.BaseMessage = exports.GenerationChunk = exports.RUN_KEY = void 0;
+exports.Docstore = exports.BaseEntityStore = exports.BaseFileStore = exports.BaseCache = exports.BaseListChatMessageHistory = exports.BaseChatMessageHistory = exports.BasePromptValue = exports.mapStoredMessageToChatMessage = exports.ChatGenerationChunk = exports.ChatMessageChunk = exports.coerceMessageLikeToMessage = exports.isBaseMessage = exports.ChatMessage = exports.FunctionMessageChunk = exports.FunctionMessage = exports.SystemChatMessage = exports.AIChatMessage = exports.HumanChatMessage = exports.BaseChatMessage = exports.SystemMessageChunk = exports.SystemMessage = exports.AIMessageChunk = exports.AIMessage = exports.HumanMessageChunk = exports.HumanMessage = exports.BaseMessageChunk = exports.BaseMessage = exports.GenerationChunk = exports.RUN_KEY = void 0;
 const serializable_js_1 = require("../load/serializable.cjs");
 exports.RUN_KEY = "__run";
 /**
@@ -405,6 +405,55 @@ class ChatGenerationChunk extends GenerationChunk {
     }
 }
 exports.ChatGenerationChunk = ChatGenerationChunk;
+/**
+ * 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) {
+        return message;
+    }
+    else {
+        const v1Message = message;
+        return {
+            type: v1Message.type,
+            data: {
+                content: v1Message.text,
+                role: v1Message.role,
+                name: undefined,
+            },
+        };
+    }
+}
+function mapStoredMessageToChatMessage(message) {
+    const storedMessage = mapV1MessageToStoredMessage(message);
+    switch (storedMessage.type) {
+        case "human":
+            return new HumanMessage(storedMessage.data);
+        case "ai":
+            return new AIMessage(storedMessage.data);
+        case "system":
+            return new SystemMessage(storedMessage.data);
+        case "function":
+            if (storedMessage.data.name === undefined) {
+                throw new Error("Name must be defined for function messages");
+            }
+            return new FunctionMessage(storedMessage.data);
+        case "chat": {
+            if (storedMessage.data.role === undefined) {
+                throw new Error("Role must be defined for chat messages");
+            }
+            return new ChatMessage(storedMessage.data);
+        }
+        default:
+            throw new Error(`Got unexpected type: ${storedMessage.type}`);
+    }
+}
+exports.mapStoredMessageToChatMessage = mapStoredMessageToChatMessage;
 /**
  * Base PromptValue class. All prompt values should extend this class.
  */

package/dist/schema/index.d.ts

@@ -59,6 +59,10 @@ export interface StoredMessage {
     type: string;
     data: StoredMessageData;
 }
+export interface StoredGeneration {
+    text: string;
+    message?: StoredMessage;
+}
 export type MessageType = "human" | "ai" | "generic" | "system" | "function";
 export interface BaseMessageFields {
     content: string;
@@ -239,6 +243,7 @@ export declare class ChatGenerationChunk extends GenerationChunk implements Chat
     constructor(fields: ChatGenerationChunkFields);
     concat(chunk: ChatGenerationChunk): ChatGenerationChunk;
 }
+export declare function mapStoredMessageToChatMessage(message: StoredMessage): HumanMessage | AIMessage | SystemMessage | FunctionMessage | ChatMessage;
 export interface ChatResult {
     generations: ChatGeneration[];
     llmOutput?: Record<string, any>;

package/dist/schema/index.js

@@ -386,6 +386,54 @@ export class ChatGenerationChunk extends GenerationChunk {
         });
     }
 }
+/**
+ * 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) {
+        return message;
+    }
+    else {
+        const v1Message = message;
+        return {
+            type: v1Message.type,
+            data: {
+                content: v1Message.text,
+                role: v1Message.role,
+                name: undefined,
+            },
+        };
+    }
+}
+export function mapStoredMessageToChatMessage(message) {
+    const storedMessage = mapV1MessageToStoredMessage(message);
+    switch (storedMessage.type) {
+        case "human":
+            return new HumanMessage(storedMessage.data);
+        case "ai":
+            return new AIMessage(storedMessage.data);
+        case "system":
+            return new SystemMessage(storedMessage.data);
+        case "function":
+            if (storedMessage.data.name === undefined) {
+                throw new Error("Name must be defined for function messages");
+            }
+            return new FunctionMessage(storedMessage.data);
+        case "chat": {
+            if (storedMessage.data.role === undefined) {
+                throw new Error("Role must be defined for chat messages");
+            }
+            return new ChatMessage(storedMessage.data);
+        }
+        default:
+            throw new Error(`Got unexpected type: ${storedMessage.type}`);
+    }
+}
 /**
  * Base PromptValue class. All prompt values should extend this class.
  */