langchain 0.0.153 → 0.0.154

package/dist/base_language/index.cjs

@@ -8,6 +8,7 @@ const tiktoken_js_1 = require("../util/tiktoken.cjs");
 const index_js_2 = require("../schema/runnable/index.cjs");
 const base_js_1 = require("../prompts/base.cjs");
 const chat_js_1 = require("../prompts/chat.cjs");
+const index_js_3 = require("../cache/index.cjs");
 const getVerbosity = () => false;
 /**
  * Base class for language models, chains, tools.
@@ -80,12 +81,27 @@ class BaseLanguageModel extends BaseLangChain {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "cache", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "_encoding", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        if (typeof params.cache === "object") {
+            this.cache = params.cache;
+        }
+        else if (params.cache) {
+            this.cache = index_js_3.InMemoryCache.global();
+        }
+        else {
+            this.cache = undefined;
+        }
         this.caller = new async_caller_js_1.AsyncCaller(params ?? {});
     }
     async getNumTokens(text) {
@@ -124,6 +140,26 @@ class BaseLanguageModel extends BaseLangChain {
     _identifyingParams() {
         return {};
     }
+    /**
+     * Create a unique cache key for a specific call to a specific language model.
+     * @param callOptions Call options for the model
+     * @returns A unique cache key.
+     */
+    _getSerializedCacheKeyParametersForCall(callOptions) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const params = {
+            ...this._identifyingParams(),
+            ...callOptions,
+            _type: this._llmType(),
+            _model: this._modelType(),
+        };
+        const filteredEntries = Object.entries(params).filter(([_, value]) => value !== undefined);
+        const serializedEntries = filteredEntries
+            .map(([key, value]) => `${key}:${JSON.stringify(value)}`)
+            .sort()
+            .join(",");
+        return serializedEntries;
+    }
     /**
      * @deprecated
      * Return a json-like object representing this LLM.

package/dist/base_language/index.d.ts

@@ -1,5 +1,5 @@
 import type { OpenAI as OpenAIClient } from "openai";
-import { BaseMessage, BaseMessageLike, BasePromptValue, LLMResult } from "../schema/index.js";
+import { BaseCache, BaseMessage, BaseMessageLike, BasePromptValue, LLMResult } from "../schema/index.js";
 import { BaseCallbackConfig, CallbackManager, Callbacks } from "../callbacks/manager.js";
 import { AsyncCaller, AsyncCallerParams } from "../util/async_caller.js";
 import { Runnable } from "../schema/runnable/index.js";
@@ -40,6 +40,7 @@ export interface BaseLanguageModelParams extends AsyncCallerParams, BaseLangChai
      * @deprecated Use `callbacks` instead
      */
     callbackManager?: CallbackManager;
+    cache?: BaseCache | boolean;
 }
 export interface BaseLanguageModelCallOptions extends BaseCallbackConfig {
     /**
@@ -77,6 +78,7 @@ export declare abstract class BaseLanguageModel<RunOutput = any, CallOptions ext
      * which will thus benefit from the concurrency and retry logic.
      */
     caller: AsyncCaller;
+    cache?: BaseCache;
     constructor({ callbacks, callbackManager, ...params }: BaseLanguageModelParams);
     abstract generatePrompt(promptValues: BasePromptValue[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
     abstract predict(text: string, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<string>;
@@ -90,6 +92,12 @@ export declare abstract class BaseLanguageModel<RunOutput = any, CallOptions ext
      * Get the identifying parameters of the LLM.
      */
     _identifyingParams(): Record<string, any>;
+    /**
+     * Create a unique cache key for a specific call to a specific language model.
+     * @param callOptions Call options for the model
+     * @returns A unique cache key.
+     */
+    protected _getSerializedCacheKeyParametersForCall(callOptions: CallOptions): string;
     /**
      * @deprecated
      * Return a json-like object representing this LLM.

package/dist/base_language/index.js

@@ -5,6 +5,7 @@ import { encodingForModel } from "../util/tiktoken.js";
 import { Runnable } from "../schema/runnable/index.js";
 import { StringPromptValue } from "../prompts/base.js";
 import { ChatPromptValue } from "../prompts/chat.js";
+import { InMemoryCache } from "../cache/index.js";
 const getVerbosity = () => false;
 /**
  * Base class for language models, chains, tools.
@@ -76,12 +77,27 @@ export class BaseLanguageModel extends BaseLangChain {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "cache", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "_encoding", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        if (typeof params.cache === "object") {
+            this.cache = params.cache;
+        }
+        else if (params.cache) {
+            this.cache = InMemoryCache.global();
+        }
+        else {
+            this.cache = undefined;
+        }
         this.caller = new AsyncCaller(params ?? {});
     }
     async getNumTokens(text) {
@@ -120,6 +136,26 @@ export class BaseLanguageModel extends BaseLangChain {
     _identifyingParams() {
         return {};
     }
+    /**
+     * Create a unique cache key for a specific call to a specific language model.
+     * @param callOptions Call options for the model
+     * @returns A unique cache key.
+     */
+    _getSerializedCacheKeyParametersForCall(callOptions) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const params = {
+            ...this._identifyingParams(),
+            ...callOptions,
+            _type: this._llmType(),
+            _model: this._modelType(),
+        };
+        const filteredEntries = Object.entries(params).filter(([_, value]) => value !== undefined);
+        const serializedEntries = filteredEntries
+            .map(([key, value]) => `${key}:${JSON.stringify(value)}`)
+            .sort()
+            .join(",");
+        return serializedEntries;
+    }
     /**
      * @deprecated
      * Return a json-like object representing this LLM.

package/dist/cache/base.cjs

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCacheKey = void 0;
+exports.serializeGeneration = exports.deserializeStoredGeneration = exports.getCacheKey = void 0;
 const object_hash_1 = __importDefault(require("object-hash"));
+const index_js_1 = require("../schema/index.cjs");
 /**
  * This cache key should be consistent across all versions of langchain.
  * It is currently NOT consistent across versions of langchain.
@@ -17,3 +18,25 @@ const object_hash_1 = __importDefault(require("object-hash"));
  */
 const getCacheKey = (...strings) => (0, object_hash_1.default)(strings.join("_"));
 exports.getCacheKey = getCacheKey;
+function deserializeStoredGeneration(storedGeneration) {
+    if (storedGeneration.message !== undefined) {
+        return {
+            text: storedGeneration.text,
+            message: (0, index_js_1.mapStoredMessageToChatMessage)(storedGeneration.message),
+        };
+    }
+    else {
+        return { text: storedGeneration.text };
+    }
+}
+exports.deserializeStoredGeneration = deserializeStoredGeneration;
+function serializeGeneration(generation) {
+    const serializedValue = {
+        text: generation.text,
+    };
+    if (generation.message !== undefined) {
+        serializedValue.message = generation.message.toDict();
+    }
+    return serializedValue;
+}
+exports.serializeGeneration = serializeGeneration;

package/dist/cache/base.d.ts

@@ -1,3 +1,4 @@
+import { Generation, StoredGeneration } from "../schema/index.js";
 /**
  * This cache key should be consistent across all versions of langchain.
  * It is currently NOT consistent across versions of langchain.
@@ -9,3 +10,11 @@
  * TODO: Make cache key consistent across versions of langchain.
  */
 export declare const getCacheKey: (...strings: string[]) => string;
+export declare function deserializeStoredGeneration(storedGeneration: StoredGeneration): {
+    text: string;
+    message: import("../schema/index.js").HumanMessage | import("../schema/index.js").AIMessage | import("../schema/index.js").SystemMessage | import("../schema/index.js").FunctionMessage | import("../schema/index.js").ChatMessage;
+} | {
+    text: string;
+    message?: undefined;
+};
+export declare function serializeGeneration(generation: Generation): StoredGeneration;

package/dist/cache/base.js

@@ -1,4 +1,5 @@
 import hash from "object-hash";
+import { mapStoredMessageToChatMessage, } from "../schema/index.js";
 /**
  * This cache key should be consistent across all versions of langchain.
  * It is currently NOT consistent across versions of langchain.
@@ -10,3 +11,23 @@ import hash from "object-hash";
  * TODO: Make cache key consistent across versions of langchain.
  */
 export const getCacheKey = (...strings) => hash(strings.join("_"));
+export function deserializeStoredGeneration(storedGeneration) {
+    if (storedGeneration.message !== undefined) {
+        return {
+            text: storedGeneration.text,
+            message: mapStoredMessageToChatMessage(storedGeneration.message),
+        };
+    }
+    else {
+        return { text: storedGeneration.text };
+    }
+}
+export function serializeGeneration(generation) {
+    const serializedValue = {
+        text: generation.text,
+    };
+    if (generation.message !== undefined) {
+        serializedValue.message = generation.message.toDict();
+    }
+    return serializedValue;
+}

package/dist/cache/cloudflare_kv.cjs

@@ -33,10 +33,7 @@ class CloudflareKVCache extends index_js_1.BaseCache {
         let value = await this.binding.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            generations.push((0, base_js_1.deserializeStoredGeneration)(JSON.parse(value)));
             idx += 1;
             key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(idx));
             value = await this.binding.get(key);
@@ -54,7 +51,7 @@ class CloudflareKVCache extends index_js_1.BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(i));
-            await this.binding.put(key, value[i].text);
+            await this.binding.put(key, JSON.stringify((0, base_js_1.serializeGeneration)(value[i])));
         }
     }
 }

package/dist/cache/cloudflare_kv.js

@@ -1,5 +1,5 @@
 import { BaseCache } from "../schema/index.js";
-import { getCacheKey } from "./base.js";
+import { getCacheKey, serializeGeneration, deserializeStoredGeneration, } from "./base.js";
 /**
  * Represents a specific implementation of a caching mechanism using Cloudflare KV
  * as the underlying storage system. It extends the `BaseCache` class and
@@ -30,10 +30,7 @@ export class CloudflareKVCache extends BaseCache {
         let value = await this.binding.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            generations.push(deserializeStoredGeneration(JSON.parse(value)));
             idx += 1;
             key = getCacheKey(prompt, llmKey, String(idx));
             value = await this.binding.get(key);
@@ -51,7 +48,7 @@ export class CloudflareKVCache extends BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = getCacheKey(prompt, llmKey, String(i));
-            await this.binding.put(key, value[i].text);
+            await this.binding.put(key, JSON.stringify(serializeGeneration(value[i])));
         }
     }
 }

package/dist/cache/ioredis.cjs

@@ -7,7 +7,7 @@ const base_js_1 = require("./base.cjs");
  * Cache LLM results using Redis.
  */
 class RedisCache extends index_js_1.BaseCache {
-    constructor(redisClient) {
+    constructor(redisClient, config) {
         super();
         Object.defineProperty(this, "redisClient", {
             enumerable: true,
@@ -15,7 +15,14 @@ class RedisCache extends index_js_1.BaseCache {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "ttl", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.redisClient = redisClient;
+        this.ttl = config?.ttl;
     }
     /**
      * Retrieves data from the Redis server using a prompt and an LLM key. If
@@ -30,10 +37,8 @@ class RedisCache extends index_js_1.BaseCache {
         let value = await this.redisClient.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            const storedGeneration = JSON.parse(value);
+            generations.push((0, base_js_1.deserializeStoredGeneration)(storedGeneration));
             idx += 1;
             key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(idx));
             value = await this.redisClient.get(key);
@@ -49,7 +54,12 @@ class RedisCache extends index_js_1.BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(i));
-            await this.redisClient.set(key, value[i].text);
+            if (this.ttl !== undefined) {
+                await this.redisClient.set(key, JSON.stringify((0, base_js_1.serializeGeneration)(value[i])), "EX", this.ttl);
+            }
+            else {
+                await this.redisClient.set(key, JSON.stringify((0, base_js_1.serializeGeneration)(value[i])));
+            }
         }
     }
 }

package/dist/cache/ioredis.d.ts

@@ -4,8 +4,11 @@ import { BaseCache, Generation } from "../schema/index.js";
  * Cache LLM results using Redis.
  */
 export declare class RedisCache extends BaseCache {
-    private redisClient;
-    constructor(redisClient: Redis);
+    protected redisClient: Redis;
+    protected ttl?: number;
+    constructor(redisClient: Redis, config?: {
+        ttl?: number;
+    });
     /**
      * Retrieves data from the Redis server using a prompt and an LLM key. If
      * the data is not found, it returns null.

package/dist/cache/ioredis.js

@@ -1,10 +1,10 @@
 import { BaseCache } from "../schema/index.js";
-import { getCacheKey } from "./base.js";
+import { serializeGeneration, deserializeStoredGeneration, getCacheKey, } from "./base.js";
 /**
  * Cache LLM results using Redis.
  */
 export class RedisCache extends BaseCache {
-    constructor(redisClient) {
+    constructor(redisClient, config) {
         super();
         Object.defineProperty(this, "redisClient", {
             enumerable: true,
@@ -12,7 +12,14 @@ export class RedisCache extends BaseCache {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "ttl", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.redisClient = redisClient;
+        this.ttl = config?.ttl;
     }
     /**
      * Retrieves data from the Redis server using a prompt and an LLM key. If
@@ -27,10 +34,8 @@ export class RedisCache extends BaseCache {
         let value = await this.redisClient.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            const storedGeneration = JSON.parse(value);
+            generations.push(deserializeStoredGeneration(storedGeneration));
             idx += 1;
             key = getCacheKey(prompt, llmKey, String(idx));
             value = await this.redisClient.get(key);
@@ -46,7 +51,12 @@ export class RedisCache extends BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = getCacheKey(prompt, llmKey, String(i));
-            await this.redisClient.set(key, value[i].text);
+            if (this.ttl !== undefined) {
+                await this.redisClient.set(key, JSON.stringify(serializeGeneration(value[i])), "EX", this.ttl);
+            }
+            else {
+                await this.redisClient.set(key, JSON.stringify(serializeGeneration(value[i])));
+            }
         }
     }
 }

package/dist/cache/momento.cjs

@@ -76,7 +76,11 @@ class MomentoCache extends index_js_1.BaseCache {
         const getResponse = await this.client.get(this.cacheName, key);
         if (getResponse instanceof sdk_1.CacheGet.Hit) {
             const value = getResponse.valueString();
-            return JSON.parse(value);
+            const parsedValue = JSON.parse(value);
+            if (!Array.isArray(parsedValue)) {
+                return null;
+            }
+            return JSON.parse(value).map(base_js_1.deserializeStoredGeneration);
         }
         else if (getResponse instanceof sdk_1.CacheGet.Miss) {
             return null;
@@ -99,7 +103,7 @@ class MomentoCache extends index_js_1.BaseCache {
      */
     async update(prompt, llmKey, value) {
         const key = (0, base_js_1.getCacheKey)(prompt, llmKey);
-        const setResponse = await this.client.set(this.cacheName, key, JSON.stringify(value), { ttl: this.ttlSeconds });
+        const setResponse = await this.client.set(this.cacheName, key, JSON.stringify(value.map(base_js_1.serializeGeneration)), { ttl: this.ttlSeconds });
         if (setResponse instanceof sdk_1.CacheSet.Success) {
             // pass
         }

package/dist/cache/momento.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-instanceof/no-instanceof */
 import { CacheGet, CacheSet, InvalidArgumentError, } from "@gomomento/sdk";
 import { BaseCache } from "../schema/index.js";
-import { getCacheKey } from "./base.js";
+import { deserializeStoredGeneration, getCacheKey, serializeGeneration, } from "./base.js";
 import { ensureCacheExists } from "../util/momento.js";
 /**
  * A cache that uses Momento as the backing store.
@@ -73,7 +73,11 @@ export class MomentoCache extends BaseCache {
         const getResponse = await this.client.get(this.cacheName, key);
         if (getResponse instanceof CacheGet.Hit) {
             const value = getResponse.valueString();
-            return JSON.parse(value);
+            const parsedValue = JSON.parse(value);
+            if (!Array.isArray(parsedValue)) {
+                return null;
+            }
+            return JSON.parse(value).map(deserializeStoredGeneration);
         }
         else if (getResponse instanceof CacheGet.Miss) {
             return null;
@@ -96,7 +100,7 @@ export class MomentoCache extends BaseCache {
      */
     async update(prompt, llmKey, value) {
         const key = getCacheKey(prompt, llmKey);
-        const setResponse = await this.client.set(this.cacheName, key, JSON.stringify(value), { ttl: this.ttlSeconds });
+        const setResponse = await this.client.set(this.cacheName, key, JSON.stringify(value.map(serializeGeneration)), { ttl: this.ttlSeconds });
         if (setResponse instanceof CacheSet.Success) {
             // pass
         }

package/dist/cache/redis.cjs

@@ -33,10 +33,8 @@ class RedisCache extends index_js_1.BaseCache {
         let value = await this.redisClient.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            const storedGeneration = JSON.parse(value);
+            generations.push((0, base_js_1.deserializeStoredGeneration)(storedGeneration));
             idx += 1;
             key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(idx));
             value = await this.redisClient.get(key);
@@ -54,7 +52,7 @@ class RedisCache extends index_js_1.BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(i));
-            await this.redisClient.set(key, value[i].text);
+            await this.redisClient.set(key, JSON.stringify((0, base_js_1.serializeGeneration)(value[i])));
         }
     }
 }

package/dist/cache/redis.js

@@ -1,5 +1,5 @@
 import { BaseCache } from "../schema/index.js";
-import { getCacheKey } from "./base.js";
+import { deserializeStoredGeneration, getCacheKey, serializeGeneration, } from "./base.js";
 /**
  * Represents a specific implementation of a caching mechanism using Redis
  * as the underlying storage system. It extends the `BaseCache` class and
@@ -30,10 +30,8 @@ export class RedisCache extends BaseCache {
         let value = await this.redisClient.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            const storedGeneration = JSON.parse(value);
+            generations.push(deserializeStoredGeneration(storedGeneration));
             idx += 1;
             key = getCacheKey(prompt, llmKey, String(idx));
             value = await this.redisClient.get(key);
@@ -51,7 +49,7 @@ export class RedisCache extends BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = getCacheKey(prompt, llmKey, String(i));
-            await this.redisClient.set(key, value[i].text);
+            await this.redisClient.set(key, JSON.stringify(serializeGeneration(value[i])));
         }
     }
 }

package/dist/cache/upstash_redis.cjs

@@ -37,10 +37,7 @@ class UpstashRedisCache extends index_js_1.BaseCache {
         let value = await this.redisClient.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            generations.push((0, base_js_1.deserializeStoredGeneration)(JSON.parse(value)));
             idx += 1;
             key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(idx));
             value = await this.redisClient.get(key);
@@ -55,7 +52,7 @@ class UpstashRedisCache extends index_js_1.BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(i));
-            await this.redisClient.set(key, value[i].text);
+            await this.redisClient.set(key, JSON.stringify((0, base_js_1.serializeGeneration)(value[i])));
         }
     }
 }

package/dist/cache/upstash_redis.js

@@ -1,6 +1,6 @@
 import { Redis } from "@upstash/redis";
 import { BaseCache } from "../schema/index.js";
-import { getCacheKey } from "./base.js";
+import { deserializeStoredGeneration, getCacheKey, serializeGeneration, } from "./base.js";
 /**
  * A cache that uses Upstash as the backing store.
  * See https://docs.upstash.com/redis.
@@ -34,10 +34,7 @@ export class UpstashRedisCache extends BaseCache {
         let value = await this.redisClient.get(key);
         const generations = [];
         while (value) {
-            if (!value) {
-                break;
-            }
-            generations.push({ text: value });
+            generations.push(deserializeStoredGeneration(JSON.parse(value)));
             idx += 1;
             key = getCacheKey(prompt, llmKey, String(idx));
             value = await this.redisClient.get(key);
@@ -52,7 +49,7 @@ export class UpstashRedisCache extends BaseCache {
     async update(prompt, llmKey, value) {
         for (let i = 0; i < value.length; i += 1) {
             const key = getCacheKey(prompt, llmKey, String(i));
-            await this.redisClient.set(key, value[i].text);
+            await this.redisClient.set(key, JSON.stringify(serializeGeneration(value[i])));
         }
     }
 }