@langchain/core 1.0.0-alpha.2 → 1.0.0-alpha.4

package/README.md

@@ -1,6 +1,6 @@
 # 🦜🍎️ @langchain/core
 
-[![CI](https://github.com/langchain-ai/langchainjs/actions/workflows/ci.yml/badge.svg)](https://github.com/langchain-ai/langchainjs/actions/workflows/ci.yml) ![npm](https://img.shields.io/npm/dm/@langchain/core) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
+![npm](https://img.shields.io/npm/dm/@langchain/core) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
 
 `@langchain/core` contains the core abstractions and schemas of LangChain.js, including base classes for language models,
 chat models, vectorstores, retrievers, and runnables.
@@ -8,7 +8,7 @@ chat models, vectorstores, retrievers, and runnables.
 ## 💾 Quick Install
 
 ```bash
-$ pnpm install @langchain/core
+pnpm install @langchain/core
 ```
 
 ## 🤔 What is this?
@@ -21,7 +21,7 @@ The benefit of having these abstractions is that any provider can implement the
 For example, you can install other provider-specific packages like this:
 
 ```bash
-$ pnpm install @langchain/openai
+pnpm install @langchain/openai
 ```
 
 And use them as follows:
@@ -72,22 +72,6 @@ leigh
 Note that for compatibility, all used LangChain packages (including the base LangChain package, which itself depends on core!) must share the same version of `@langchain/core`.
 This means that you may need to install/resolve a specific version of `@langchain/core` that matches the dependencies of your used packages.
 
-## 🔗 What is LangChain Expression Language?
-
-LangChain Core also contains LangChain Expression Language, or LCEL, a runtime that allows users to compose arbitrary sequences together and get several benefits that are important when building LLM applications.
-We call these sequences “runnables”.
-
-All runnables expose the same interface with single-invocation, batch, streaming and async methods.
-This design is useful because it is not enough to have a single sync interface when building an LLM application.
-Batch is needed for efficient processing of many inputs.
-Streaming (and streaming of intermediate steps) is needed to show the user that progress is being made.
-Async interfaces are nice when moving into production.
-Rather than having to write multiple implementations for all of those, LCEL allows you to write a runnable once and invoke it in many different ways.
-
-For more check out the [LCEL docs](https://js.langchain.com/docs/concepts/lcel).
-
-![LangChain Stack](../docs/core_docs/static/svg/langchain_stack_062024.svg)
-
 ## 📕 Releases & Versioning
 
 `@langchain/core` is currently on version `0.3.x`.

package/dist/agents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"agents.d.ts","names":["AgentAction","Record","AgentFinish","AgentStep"],"sources":["../src/agents.d.ts"],"sourcesContent":["export type AgentAction = {\n    tool: string;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    toolInput: string | Record<string, any>;\n    log: string;\n};\nexport type AgentFinish = {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    returnValues: Record<string, any>;\n    log: string;\n};\nexport type AgentStep = {\n    action: AgentAction;\n    observation: string;\n};\n"],"mappings":";KAAYA,WAAAA;EAAAA,IAAAA,EAAAA,MAAAA;EAMAE;EAKAC,SAAAA,EAAAA,MAAS,GARGF,MASZD,CAAAA,MAAAA,EAAW,GAAA,CAAA;;;KANXE,WAAAA;;gBAEMD;;;KAGNE,SAAAA;UACAH"}
+{"version":3,"file":"agents.d.ts","names":["AgentAction","Record","AgentFinish","AgentStep"],"sources":["../src/agents.d.ts"],"sourcesContent":["export type AgentAction = {\n    tool: string;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    toolInput: string | Record<string, any>;\n    log: string;\n};\nexport type AgentFinish = {\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    returnValues: Record<string, any>;\n    log: string;\n};\nexport type AgentStep = {\n    action: AgentAction;\n    observation: string;\n};\n"],"mappings":";KAAYA,WAAAA;EAAAA,IAAAA,EAAAA,MAAAA;EAMAE;EAKAC,SAAAA,EAAAA,MAAS,GARGF,MASZD,CAAAA,MAAW,EAAA,GAAA,CAAA;;;KANXE,WAAAA;;gBAEMD;;;KAGNE,SAAAA;UACAH"}

package/dist/caches/base.cjs

@@ -1,6 +1,6 @@
 const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
 const require_utils = require('../messages/utils.cjs');
-const require_utils_js_sha1_hash = require('../utils/js-sha1/hash.cjs');
+const require_hash = require('../utils/js-sha256/hash.cjs');
 require('../utils/hash.cjs');
 
 //#region src/caches/base.ts
@@ -8,24 +8,11 @@ var base_exports = {};
 require_rolldown_runtime.__export(base_exports, {
 	BaseCache: () => BaseCache,
 	InMemoryCache: () => InMemoryCache,
+	defaultHashKeyEncoder: () => defaultHashKeyEncoder,
 	deserializeStoredGeneration: () => deserializeStoredGeneration,
-	getCacheKey: () => getCacheKey,
 	serializeGeneration: () => serializeGeneration
 });
-/**
-* This cache key should be consistent across all versions of LangChain.
-* It is currently NOT consistent across versions of LangChain.
-*
-* A huge benefit of having a remote cache (like redis) is that you can
-* access the cache from different processes/machines. The allows you to
-* separate concerns and scale horizontally.
-*
-* TODO: Make cache key consistent across versions of LangChain.
-*
-* @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.
-* This function will be removed in a future version.
-*/
-const getCacheKey = (...strings) => require_utils_js_sha1_hash.insecureHash(strings.join("_"));
+const defaultHashKeyEncoder = (...strings) => require_hash.sha256(strings.join("_"));
 function deserializeStoredGeneration(storedGeneration) {
 	if (storedGeneration.message !== void 0) return {
 		text: storedGeneration.text,
@@ -42,7 +29,7 @@ function serializeGeneration(generation) {
 * Base class for all caches. All caches should extend this class.
 */
 var BaseCache = class {
-	keyEncoder = getCacheKey;
+	keyEncoder = defaultHashKeyEncoder;
 	/**
 	* Sets a custom key encoder function for the cache.
 	* This function should take a prompt and an LLM key and return a string
@@ -101,7 +88,7 @@ Object.defineProperty(exports, 'base_exports', {
     return base_exports;
   }
 });
+exports.defaultHashKeyEncoder = defaultHashKeyEncoder;
 exports.deserializeStoredGeneration = deserializeStoredGeneration;
-exports.getCacheKey = getCacheKey;
 exports.serializeGeneration = serializeGeneration;
 //# sourceMappingURL=base.cjs.map

package/dist/caches/base.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"base.cjs","names":["getCacheKey: HashKeyEncoder","insecureHash","storedGeneration: StoredGeneration","mapStoredMessageToChatMessage","generation: Generation","serializedValue: StoredGeneration","keyEncoderFn: HashKeyEncoder","map?: Map<string, T>","prompt: string","llmKey: string","value: T"],"sources":["../../src/caches/base.ts"],"sourcesContent":["import { insecureHash, type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation, ChatGeneration } from \"../outputs.js\";\nimport { mapStoredMessageToChatMessage } from \"../messages/utils.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\n\n/**\n * This cache key should be consistent across all versions of LangChain.\n * It is currently NOT consistent across versions of LangChain.\n *\n * A huge benefit of having a remote cache (like redis) is that you can\n * access the cache from different processes/machines. The allows you to\n * separate concerns and scale horizontally.\n *\n * TODO: Make cache key consistent across versions of LangChain.\n *\n * @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.\n * This function will be removed in a future version.\n */\nexport const getCacheKey: HashKeyEncoder = (...strings) =>\n  insecureHash(strings.join(\"_\"));\n\nexport function deserializeStoredGeneration(\n  storedGeneration: StoredGeneration\n) {\n  if (storedGeneration.message !== undefined) {\n    return {\n      text: storedGeneration.text,\n      message: mapStoredMessageToChatMessage(storedGeneration.message),\n    };\n  } else {\n    return { text: storedGeneration.text };\n  }\n}\n\nexport function serializeGeneration(generation: Generation) {\n  const serializedValue: StoredGeneration = {\n    text: generation.text,\n  };\n  if ((generation as ChatGeneration).message !== undefined) {\n    serializedValue.message = (generation as ChatGeneration).message.toDict();\n  }\n  return serializedValue;\n}\n\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport abstract class BaseCache<T = Generation[]> {\n  // For backwards compatibility, we use a default key encoder\n  // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning\n  // about the security implications of using SHA-1 as a cache key.\n  protected keyEncoder: HashKeyEncoder = getCacheKey;\n\n  /**\n   * Sets a custom key encoder function for the cache.\n   * This function should take a prompt and an LLM key and return a string\n   * that will be used as the cache key.\n   * @param keyEncoderFn The custom key encoder function.\n   */\n  makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void {\n    this.keyEncoder = keyEncoderFn;\n  }\n\n  abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n\n  abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n\nconst GLOBAL_MAP = new Map();\n\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n  private cache: Map<string, T>;\n\n  constructor(map?: Map<string, T>) {\n    super();\n    this.cache = map ?? new Map();\n  }\n\n  /**\n   * Retrieves data from the cache using a prompt and an LLM key. If the\n   * data is not found, it returns null.\n   * @param prompt The prompt used to find the data.\n   * @param llmKey The LLM key used to find the data.\n   * @returns The data corresponding to the prompt and LLM key, or null if not found.\n   */\n  lookup(prompt: string, llmKey: string): Promise<T | null> {\n    return Promise.resolve(\n      this.cache.get(this.keyEncoder(prompt, llmKey)) ?? null\n    );\n  }\n\n  /**\n   * Updates the cache with new data using a prompt and an LLM key.\n   * @param prompt The prompt used to store the data.\n   * @param llmKey The LLM key used to store the data.\n   * @param value The data to be stored.\n   */\n  async update(prompt: string, llmKey: string, value: T): Promise<void> {\n    this.cache.set(this.keyEncoder(prompt, llmKey), value);\n  }\n\n  /**\n   * Returns a global instance of InMemoryCache using a predefined global\n   * map as the initial cache.\n   * @returns A global instance of InMemoryCache.\n   */\n  static global(): InMemoryCache {\n    return new InMemoryCache(GLOBAL_MAP);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBA,MAAaA,cAA8B,CAAC,GAAG,YAC7CC,wCAAa,QAAQ,KAAK,IAAI,CAAC;AAEjC,SAAgB,4BACdC,kBACA;AACA,KAAI,iBAAiB,YAAY,OAC/B,QAAO;EACL,MAAM,iBAAiB;EACvB,SAASC,4CAA8B,iBAAiB,QAAQ;CACjE;KAED,QAAO,EAAE,MAAM,iBAAiB,KAAM;AAEzC;AAED,SAAgB,oBAAoBC,YAAwB;CAC1D,MAAMC,kBAAoC,EACxC,MAAM,WAAW,KAClB;AACD,KAAK,WAA8B,YAAY,QAC7C,gBAAgB,UAAW,WAA8B,QAAQ,QAAQ;AAE3E,QAAO;AACR;;;;AAKD,IAAsB,YAAtB,MAAkD;CAIhD,AAAU,aAA6B;;;;;;;CAQvC,sBAAsBC,cAAoC;EACxD,KAAK,aAAa;CACnB;AAKF;AAED,MAAM,6BAAa,IAAI;;;;AAKvB,IAAa,gBAAb,MAAa,sBAAwC,UAAa;CAChE,AAAQ;CAER,YAAYC,KAAsB;EAChC,OAAO;EACP,KAAK,QAAQ,uBAAO,IAAI;CACzB;;;;;;;;CASD,OAAOC,QAAgBC,QAAmC;AACxD,SAAO,QAAQ,QACb,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,CAAC,IAAI,KACpD;CACF;;;;;;;CAQD,MAAM,OAAOD,QAAgBC,QAAgBC,OAAyB;EACpE,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,EAAE,MAAM;CACvD;;;;;;CAOD,OAAO,SAAwB;AAC7B,SAAO,IAAI,cAAc;CAC1B;AACF"}
+{"version":3,"file":"base.cjs","names":["defaultHashKeyEncoder: HashKeyEncoder","sha256","storedGeneration: StoredGeneration","mapStoredMessageToChatMessage","generation: Generation","serializedValue: StoredGeneration","keyEncoderFn: HashKeyEncoder","map?: Map<string, T>","prompt: string","llmKey: string","value: T"],"sources":["../../src/caches/base.ts"],"sourcesContent":["import { sha256, type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation, ChatGeneration } from \"../outputs.js\";\nimport { mapStoredMessageToChatMessage } from \"../messages/utils.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\n\nexport const defaultHashKeyEncoder: HashKeyEncoder = (...strings) =>\n  sha256(strings.join(\"_\"));\n\nexport function deserializeStoredGeneration(\n  storedGeneration: StoredGeneration\n) {\n  if (storedGeneration.message !== undefined) {\n    return {\n      text: storedGeneration.text,\n      message: mapStoredMessageToChatMessage(storedGeneration.message),\n    };\n  } else {\n    return { text: storedGeneration.text };\n  }\n}\n\nexport function serializeGeneration(generation: Generation) {\n  const serializedValue: StoredGeneration = {\n    text: generation.text,\n  };\n  if ((generation as ChatGeneration).message !== undefined) {\n    serializedValue.message = (generation as ChatGeneration).message.toDict();\n  }\n  return serializedValue;\n}\n\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport abstract class BaseCache<T = Generation[]> {\n  protected keyEncoder: HashKeyEncoder = defaultHashKeyEncoder;\n\n  /**\n   * Sets a custom key encoder function for the cache.\n   * This function should take a prompt and an LLM key and return a string\n   * that will be used as the cache key.\n   * @param keyEncoderFn The custom key encoder function.\n   */\n  makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void {\n    this.keyEncoder = keyEncoderFn;\n  }\n\n  abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n\n  abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n\nconst GLOBAL_MAP = new Map();\n\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n  private cache: Map<string, T>;\n\n  constructor(map?: Map<string, T>) {\n    super();\n    this.cache = map ?? new Map();\n  }\n\n  /**\n   * Retrieves data from the cache using a prompt and an LLM key. If the\n   * data is not found, it returns null.\n   * @param prompt The prompt used to find the data.\n   * @param llmKey The LLM key used to find the data.\n   * @returns The data corresponding to the prompt and LLM key, or null if not found.\n   */\n  lookup(prompt: string, llmKey: string): Promise<T | null> {\n    return Promise.resolve(\n      this.cache.get(this.keyEncoder(prompt, llmKey)) ?? null\n    );\n  }\n\n  /**\n   * Updates the cache with new data using a prompt and an LLM key.\n   * @param prompt The prompt used to store the data.\n   * @param llmKey The LLM key used to store the data.\n   * @param value The data to be stored.\n   */\n  async update(prompt: string, llmKey: string, value: T): Promise<void> {\n    this.cache.set(this.keyEncoder(prompt, llmKey), value);\n  }\n\n  /**\n   * Returns a global instance of InMemoryCache using a predefined global\n   * map as the initial cache.\n   * @returns A global instance of InMemoryCache.\n   */\n  static global(): InMemoryCache {\n    return new InMemoryCache(GLOBAL_MAP);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAKA,MAAaA,wBAAwC,CAAC,GAAG,YACvDC,oBAAO,QAAQ,KAAK,IAAI,CAAC;AAE3B,SAAgB,4BACdC,kBACA;AACA,KAAI,iBAAiB,YAAY,OAC/B,QAAO;EACL,MAAM,iBAAiB;EACvB,SAASC,4CAA8B,iBAAiB,QAAQ;CACjE;KAED,QAAO,EAAE,MAAM,iBAAiB,KAAM;AAEzC;AAED,SAAgB,oBAAoBC,YAAwB;CAC1D,MAAMC,kBAAoC,EACxC,MAAM,WAAW,KAClB;AACD,KAAK,WAA8B,YAAY,QAC7C,gBAAgB,UAAW,WAA8B,QAAQ,QAAQ;AAE3E,QAAO;AACR;;;;AAKD,IAAsB,YAAtB,MAAkD;CAChD,AAAU,aAA6B;;;;;;;CAQvC,sBAAsBC,cAAoC;EACxD,KAAK,aAAa;CACnB;AAKF;AAED,MAAM,6BAAa,IAAI;;;;AAKvB,IAAa,gBAAb,MAAa,sBAAwC,UAAa;CAChE,AAAQ;CAER,YAAYC,KAAsB;EAChC,OAAO;EACP,KAAK,QAAQ,uBAAO,IAAI;CACzB;;;;;;;;CASD,OAAOC,QAAgBC,QAAmC;AACxD,SAAO,QAAQ,QACb,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,CAAC,IAAI,KACpD;CACF;;;;;;;CAQD,MAAM,OAAOD,QAAgBC,QAAgBC,OAAyB;EACpE,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,EAAE,MAAM;CACvD;;;;;;CAOD,OAAO,SAAwB;AAC7B,SAAO,IAAI,cAAc;CAC1B;AACF"}

package/dist/caches/base.d.cts

@@ -5,28 +5,15 @@ import { ChatMessage } from "../messages/chat.cjs";
 import { FunctionMessage } from "../messages/function.cjs";
 import { HumanMessage } from "../messages/human.cjs";
 import { SystemMessage } from "../messages/system.cjs";
+import { MessageStructure } from "../messages/message.cjs";
 import { HashKeyEncoder } from "../utils/hash.cjs";
 import { Generation } from "../outputs.cjs";
 
 //#region src/caches/base.d.ts
-
-/**
- * This cache key should be consistent across all versions of LangChain.
- * It is currently NOT consistent across versions of LangChain.
- *
- * A huge benefit of having a remote cache (like redis) is that you can
- * access the cache from different processes/machines. The allows you to
- * separate concerns and scale horizontally.
- *
- * TODO: Make cache key consistent across versions of LangChain.
- *
- * @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.
- * This function will be removed in a future version.
- */
-declare const getCacheKey: HashKeyEncoder;
+declare const defaultHashKeyEncoder: HashKeyEncoder;
 declare function deserializeStoredGeneration(storedGeneration: StoredGeneration): {
   text: string;
-  message: AIMessage | ChatMessage | FunctionMessage | HumanMessage | SystemMessage | ToolMessage;
+  message: AIMessage<MessageStructure> | ChatMessage<MessageStructure> | FunctionMessage<MessageStructure> | HumanMessage<MessageStructure> | SystemMessage<MessageStructure> | ToolMessage<MessageStructure>;
 } | {
   message?: undefined;
   text: string;
@@ -36,9 +23,6 @@ declare function serializeGeneration(generation: Generation): StoredGeneration;
  * Base class for all caches. All caches should extend this class.
  */
 declare abstract class BaseCache<T = Generation[]> {
-  // For backwards compatibility, we use a default key encoder
-  // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning
-  // about the security implications of using SHA-1 as a cache key.
   protected keyEncoder: HashKeyEncoder;
   /**
    * Sets a custom key encoder function for the cache.
@@ -79,5 +63,5 @@ declare class InMemoryCache<T = Generation[]> extends BaseCache<T> {
   static global(): InMemoryCache;
 }
 //#endregion
-export { BaseCache, InMemoryCache, deserializeStoredGeneration, getCacheKey, serializeGeneration };
+export { BaseCache, InMemoryCache, defaultHashKeyEncoder, deserializeStoredGeneration, serializeGeneration };
 //# sourceMappingURL=base.d.cts.map

package/dist/caches/base.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.cts","names":["___messages_chat_js0","___messages_function_js0","___messages_human_js0","___messages_system_js0","___messages_tool_js0","HashKeyEncoder","Generation","StoredGeneration","getCacheKey","deserializeStoredGeneration","___messages_ai_js0","AIMessage","ChatMessage","FunctionMessage","HumanMessage","SystemMessage","ToolMessage","serializeGeneration","BaseCache","T","Promise","InMemoryCache","Map"],"sources":["../../src/caches/base.d.ts"],"sourcesContent":["import { type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation } from \"../outputs.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\n/**\n * This cache key should be consistent across all versions of LangChain.\n * It is currently NOT consistent across versions of LangChain.\n *\n * A huge benefit of having a remote cache (like redis) is that you can\n * access the cache from different processes/machines. The allows you to\n * separate concerns and scale horizontally.\n *\n * TODO: Make cache key consistent across versions of LangChain.\n *\n * @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.\n * This function will be removed in a future version.\n */\nexport declare const getCacheKey: HashKeyEncoder;\nexport declare function deserializeStoredGeneration(storedGeneration: StoredGeneration): {\n    text: string;\n    message: import(\"../messages/ai.js\").AIMessage | import(\"../messages/chat.js\").ChatMessage | import(\"../messages/function.js\").FunctionMessage | import(\"../messages/human.js\").HumanMessage | import(\"../messages/system.js\").SystemMessage | import(\"../messages/tool.js\").ToolMessage;\n} | {\n    message?: undefined;\n    text: string;\n};\nexport declare function serializeGeneration(generation: Generation): StoredGeneration;\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport declare abstract class BaseCache<T = Generation[]> {\n    // For backwards compatibility, we use a default key encoder\n    // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning\n    // about the security implications of using SHA-1 as a cache key.\n    protected keyEncoder: HashKeyEncoder;\n    /**\n     * Sets a custom key encoder function for the cache.\n     * This function should take a prompt and an LLM key and return a string\n     * that will be used as the cache key.\n     * @param keyEncoderFn The custom key encoder function.\n     */\n    makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;\n    abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n    abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport declare class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n    private cache;\n    constructor(map?: Map<string, T>);\n    /**\n     * Retrieves data from the cache using a prompt and an LLM key. If the\n     * data is not found, it returns null.\n     * @param prompt The prompt used to find the data.\n     * @param llmKey The LLM key used to find the data.\n     * @returns The data corresponding to the prompt and LLM key, or null if not found.\n     */\n    lookup(prompt: string, llmKey: string): Promise<T | null>;\n    /**\n     * Updates the cache with new data using a prompt and an LLM key.\n     * @param prompt The prompt used to store the data.\n     * @param llmKey The LLM key used to store the data.\n     * @param value The data to be stored.\n     */\n    update(prompt: string, llmKey: string, value: T): Promise<void>;\n    /**\n     * Returns a global instance of InMemoryCache using a predefined global\n     * map as the initial cache.\n     * @returns A global instance of InMemoryCache.\n     */\n    static global(): InMemoryCache;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAgBA;AACA;;;;AAEkD,cAH7BQ,WAG6B,EAHhBH,cAGgB;AAA4C,iBAFtEI,2BAAAA,CAEsE,gBAAA,EAFxBF,gBAEwB,CAAA,EAAA;EAAoD,IAAA,EAAA,MAAA;EAA8C,OAAA,EAF1G,SAAA,GAEpC,WAAA,GAA4C,eAAA,GAAoD,YAAA,GAA8C,aAAA,GAAgD,WAAhD;CAAgD,GAAA;EAA4C,OAAA,CAAA,EAAA,SAAA;EAKpQU,IAAAA,EAAAA,MAAAA;CAAmB;AAAaX,iBAAhCW,mBAAAA,CAAgCX,UAAAA,EAAAA,UAAAA,CAAAA,EAAaC,gBAAbD;;AAA6B;AAIrF;AAAuC,uBAATY,SAAS,CAAA,IAAKZ,UAAL,EAAA,CAAA,CAAA;EAAA;EAAe;EAId;EAOc,UACOa,UAAAA,EARnCd,cAQmCc;EAAC;;;AACQ;AAKtE;;EAAkC,qBAAKb,CAAAA,YAAAA,EAPCD,cAODC,CAAAA,EAAAA,IAAAA;EAAU,SAAsBa,MAAAA,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,CAAAA,EANlBC,OAMkBD,CANVA,CAMUA,GAAAA,IAAAA,CAAAA;EAAC,SAEtCA,MAAAA,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAPyBA,CAOzBA,CAAAA,EAP6BC,OAO7BD,CAAAA,IAAAA,CAAAA;;;;;AAeoBC,cAjBjCC,aAiBiCD,CAAAA,IAjBfd,UAiBec,EAAAA,CAAAA,SAjBOF,SAiBPE,CAjBiBD,CAiBjBC,CAAAA,CAAAA;EAAO,QAMxCC,KAAAA;EAAa,WAvB2BH,CAAAA,GAAAA,CAAAA,EAEvCI,GAFuCJ,CAAAA,MAAAA,EAE3BC,CAF2BD,CAAAA;EAAS;;;;;;;0CAU1BE,QAAQD;;;;;;;gDAOFA,IAAIC;;;;;;mBAMjCC"}
+{"version":3,"file":"base.d.cts","names":["___messages_ai_js0","___messages_chat_js0","___messages_function_js0","___messages_human_js0","___messages_system_js0","___messages_tool_js0","HashKeyEncoder","Generation","StoredGeneration","defaultHashKeyEncoder","deserializeStoredGeneration","___messages_message_js0","MessageStructure","AIMessage","ChatMessage","FunctionMessage","HumanMessage","SystemMessage","ToolMessage","serializeGeneration","BaseCache","T","Promise","InMemoryCache","Map"],"sources":["../../src/caches/base.d.ts"],"sourcesContent":["import { type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation } from \"../outputs.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\nexport declare const defaultHashKeyEncoder: HashKeyEncoder;\nexport declare function deserializeStoredGeneration(storedGeneration: StoredGeneration): {\n    text: string;\n    message: import(\"../messages/ai.js\").AIMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/chat.js\").ChatMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/function.js\").FunctionMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/human.js\").HumanMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/system.js\").SystemMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/tool.js\").ToolMessage<import(\"../messages/message.js\").MessageStructure>;\n} | {\n    message?: undefined;\n    text: string;\n};\nexport declare function serializeGeneration(generation: Generation): StoredGeneration;\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport declare abstract class BaseCache<T = Generation[]> {\n    protected keyEncoder: HashKeyEncoder;\n    /**\n     * Sets a custom key encoder function for the cache.\n     * This function should take a prompt and an LLM key and return a string\n     * that will be used as the cache key.\n     * @param keyEncoderFn The custom key encoder function.\n     */\n    makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;\n    abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n    abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport declare class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n    private cache;\n    constructor(map?: Map<string, T>);\n    /**\n     * Retrieves data from the cache using a prompt and an LLM key. If the\n     * data is not found, it returns null.\n     * @param prompt The prompt used to find the data.\n     * @param llmKey The LLM key used to find the data.\n     * @returns The data corresponding to the prompt and LLM key, or null if not found.\n     */\n    lookup(prompt: string, llmKey: string): Promise<T | null>;\n    /**\n     * Updates the cache with new data using a prompt and an LLM key.\n     * @param prompt The prompt used to store the data.\n     * @param llmKey The LLM key used to store the data.\n     * @param value The data to be stored.\n     */\n    update(prompt: string, llmKey: string, value: T): Promise<void>;\n    /**\n     * Returns a global instance of InMemoryCache using a predefined global\n     * map as the initial cache.\n     * @returns A global instance of InMemoryCache.\n     */\n    static global(): InMemoryCache;\n}\n"],"mappings":";;;;;;;;;;;;cAGqBS,uBAAuBH;iBACpBI,2BAAAA,mBAA8CF;;WAE8B,UAFd,gBAAA,IAE6G,YAAjJ,gBAAA,IAAwP,gBAAzJ,gBAAA,IAA0P,aAAnJ,gBAAA,IAAsP,cAArJ,gBAAA,IAAoP,YAAjJ,gBAAA;;;;;iBAKpaW,mBAAAA,aAAgCZ,aAAaC;AARrE;AACA;;AAAsEA,uBAWxCY,SAXwCZ,CAAAA,IAW1BD,UAX0BC,EAAAA,CAAAA,CAAAA;EAAgB,UAAA,UAAA,EAY5DF,cAZ4D;EAEc;;;;;;EAAuS,qBAAA,CAAA,YAAA,EAiBnWA,cAjBmW,CAAA,EAAA,IAAA;EAAlD,SAAA,MAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA,EAkBpSgB,OAlBoS,CAkB5RD,CAlB4R,GAAA,IAAA,CAAA;EAAqJ,SAAA,MAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAmBnbA,CAnBmb,CAAA,EAmB/aC,OAnB+a,CAAA,IAAA,CAAA;;;AAA6C;AAK3hB;AAA2C,cAmBtBC,aAnBsB,CAAA,IAmBJhB,UAnBI,EAAA,CAAA,SAmBkBa,SAnBlB,CAmB4BC,CAnB5B,CAAA,CAAA;EAAA,QAAad,KAAAA;EAAU,WAAGC,CAAAA,GAAAA,CAAAA,EAqB/CgB,GArB+ChB,CAAAA,MAAAA,EAqBnCa,CArBmCb,CAAAA;EAAgB;AAIrF;;;;;;EAS8D,MAATc,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,CAAAA,EAgBTA,OAhBSA,CAgBDD,CAhBCC,GAAAA,IAAAA,CAAAA;EAAO;;AACU;AAKtE;;;EAAiD,MAAsBD,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAiBrBA,CAjBqBA,CAAAA,EAiBjBC,OAjBiBD,CAAAA,IAAAA,CAAAA;EAAC;;;;;EAiBrB,OAAGC,MAAAA,CAAAA,CAAAA,EAMjCC,aANiCD"}

package/dist/caches/base.d.ts

@@ -5,28 +5,15 @@ import { ChatMessage } from "../messages/chat.js";
 import { FunctionMessage } from "../messages/function.js";
 import { HumanMessage } from "../messages/human.js";
 import { SystemMessage } from "../messages/system.js";
+import { MessageStructure } from "../messages/message.js";
 import { HashKeyEncoder } from "../utils/hash.js";
 import { Generation } from "../outputs.js";
 
 //#region src/caches/base.d.ts
-
-/**
- * This cache key should be consistent across all versions of LangChain.
- * It is currently NOT consistent across versions of LangChain.
- *
- * A huge benefit of having a remote cache (like redis) is that you can
- * access the cache from different processes/machines. The allows you to
- * separate concerns and scale horizontally.
- *
- * TODO: Make cache key consistent across versions of LangChain.
- *
- * @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.
- * This function will be removed in a future version.
- */
-declare const getCacheKey: HashKeyEncoder;
+declare const defaultHashKeyEncoder: HashKeyEncoder;
 declare function deserializeStoredGeneration(storedGeneration: StoredGeneration): {
   text: string;
-  message: AIMessage | ChatMessage | FunctionMessage | HumanMessage | SystemMessage | ToolMessage;
+  message: AIMessage<MessageStructure> | ChatMessage<MessageStructure> | FunctionMessage<MessageStructure> | HumanMessage<MessageStructure> | SystemMessage<MessageStructure> | ToolMessage<MessageStructure>;
 } | {
   message?: undefined;
   text: string;
@@ -36,9 +23,6 @@ declare function serializeGeneration(generation: Generation): StoredGeneration;
  * Base class for all caches. All caches should extend this class.
  */
 declare abstract class BaseCache<T = Generation[]> {
-  // For backwards compatibility, we use a default key encoder
-  // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning
-  // about the security implications of using SHA-1 as a cache key.
   protected keyEncoder: HashKeyEncoder;
   /**
    * Sets a custom key encoder function for the cache.
@@ -79,5 +63,5 @@ declare class InMemoryCache<T = Generation[]> extends BaseCache<T> {
   static global(): InMemoryCache;
 }
 //#endregion
-export { BaseCache, InMemoryCache, deserializeStoredGeneration, getCacheKey, serializeGeneration };
+export { BaseCache, InMemoryCache, defaultHashKeyEncoder, deserializeStoredGeneration, serializeGeneration };
 //# sourceMappingURL=base.d.ts.map

package/dist/caches/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","names":["___messages_chat_js0","___messages_function_js0","___messages_human_js0","___messages_system_js0","___messages_tool_js0","HashKeyEncoder","Generation","StoredGeneration","getCacheKey","deserializeStoredGeneration","___messages_ai_js0","AIMessage","ChatMessage","FunctionMessage","HumanMessage","SystemMessage","ToolMessage","serializeGeneration","BaseCache","T","Promise","InMemoryCache","Map"],"sources":["../../src/caches/base.d.ts"],"sourcesContent":["import { type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation } from \"../outputs.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\n/**\n * This cache key should be consistent across all versions of LangChain.\n * It is currently NOT consistent across versions of LangChain.\n *\n * A huge benefit of having a remote cache (like redis) is that you can\n * access the cache from different processes/machines. The allows you to\n * separate concerns and scale horizontally.\n *\n * TODO: Make cache key consistent across versions of LangChain.\n *\n * @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.\n * This function will be removed in a future version.\n */\nexport declare const getCacheKey: HashKeyEncoder;\nexport declare function deserializeStoredGeneration(storedGeneration: StoredGeneration): {\n    text: string;\n    message: import(\"../messages/ai.js\").AIMessage | import(\"../messages/chat.js\").ChatMessage | import(\"../messages/function.js\").FunctionMessage | import(\"../messages/human.js\").HumanMessage | import(\"../messages/system.js\").SystemMessage | import(\"../messages/tool.js\").ToolMessage;\n} | {\n    message?: undefined;\n    text: string;\n};\nexport declare function serializeGeneration(generation: Generation): StoredGeneration;\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport declare abstract class BaseCache<T = Generation[]> {\n    // For backwards compatibility, we use a default key encoder\n    // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning\n    // about the security implications of using SHA-1 as a cache key.\n    protected keyEncoder: HashKeyEncoder;\n    /**\n     * Sets a custom key encoder function for the cache.\n     * This function should take a prompt and an LLM key and return a string\n     * that will be used as the cache key.\n     * @param keyEncoderFn The custom key encoder function.\n     */\n    makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;\n    abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n    abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport declare class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n    private cache;\n    constructor(map?: Map<string, T>);\n    /**\n     * Retrieves data from the cache using a prompt and an LLM key. If the\n     * data is not found, it returns null.\n     * @param prompt The prompt used to find the data.\n     * @param llmKey The LLM key used to find the data.\n     * @returns The data corresponding to the prompt and LLM key, or null if not found.\n     */\n    lookup(prompt: string, llmKey: string): Promise<T | null>;\n    /**\n     * Updates the cache with new data using a prompt and an LLM key.\n     * @param prompt The prompt used to store the data.\n     * @param llmKey The LLM key used to store the data.\n     * @param value The data to be stored.\n     */\n    update(prompt: string, llmKey: string, value: T): Promise<void>;\n    /**\n     * Returns a global instance of InMemoryCache using a predefined global\n     * map as the initial cache.\n     * @returns A global instance of InMemoryCache.\n     */\n    static global(): InMemoryCache;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAgBA;AACA;;;;AAEkD,cAH7BQ,WAG6B,EAHhBH,cAGgB;AAA4C,iBAFtEI,2BAAAA,CAEsE,gBAAA,EAFxBF,gBAEwB,CAAA,EAAA;EAAoD,IAAA,EAAA,MAAA;EAA8C,OAAA,EAF1G,SAAA,GAEpC,WAAA,GAA4C,eAAA,GAAoD,YAAA,GAA8C,aAAA,GAAgD,WAAhD;CAAgD,GAAA;EAA4C,OAAA,CAAA,EAAA,SAAA;EAKpQU,IAAAA,EAAAA,MAAAA;CAAmB;AAAaX,iBAAhCW,mBAAAA,CAAgCX,UAAAA,EAAAA,UAAAA,CAAAA,EAAaC,gBAAbD;;AAA6B;AAIrF;AAAuC,uBAATY,SAAS,CAAA,IAAKZ,UAAL,EAAA,CAAA,CAAA;EAAA;EAAe;EAId;EAOc,UACOa,UAAAA,EARnCd,cAQmCc;EAAC;;;AACQ;AAKtE;;EAAkC,qBAAKb,CAAAA,YAAAA,EAPCD,cAODC,CAAAA,EAAAA,IAAAA;EAAU,SAAsBa,MAAAA,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,CAAAA,EANlBC,OAMkBD,CANVA,CAMUA,GAAAA,IAAAA,CAAAA;EAAC,SAEtCA,MAAAA,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAPyBA,CAOzBA,CAAAA,EAP6BC,OAO7BD,CAAAA,IAAAA,CAAAA;;;;;AAeoBC,cAjBjCC,aAiBiCD,CAAAA,IAjBfd,UAiBec,EAAAA,CAAAA,SAjBOF,SAiBPE,CAjBiBD,CAiBjBC,CAAAA,CAAAA;EAAO,QAMxCC,KAAAA;EAAa,WAvB2BH,CAAAA,GAAAA,CAAAA,EAEvCI,GAFuCJ,CAAAA,MAAAA,EAE3BC,CAF2BD,CAAAA;EAAS;;;;;;;0CAU1BE,QAAQD;;;;;;;gDAOFA,IAAIC;;;;;;mBAMjCC"}
+{"version":3,"file":"base.d.ts","names":["___messages_ai_js0","___messages_chat_js0","___messages_function_js0","___messages_human_js0","___messages_system_js0","___messages_tool_js0","HashKeyEncoder","Generation","StoredGeneration","defaultHashKeyEncoder","deserializeStoredGeneration","___messages_message_js0","MessageStructure","AIMessage","ChatMessage","FunctionMessage","HumanMessage","SystemMessage","ToolMessage","serializeGeneration","BaseCache","T","Promise","InMemoryCache","Map"],"sources":["../../src/caches/base.d.ts"],"sourcesContent":["import { type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation } from \"../outputs.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\nexport declare const defaultHashKeyEncoder: HashKeyEncoder;\nexport declare function deserializeStoredGeneration(storedGeneration: StoredGeneration): {\n    text: string;\n    message: import(\"../messages/ai.js\").AIMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/chat.js\").ChatMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/function.js\").FunctionMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/human.js\").HumanMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/system.js\").SystemMessage<import(\"../messages/message.js\").MessageStructure> | import(\"../messages/tool.js\").ToolMessage<import(\"../messages/message.js\").MessageStructure>;\n} | {\n    message?: undefined;\n    text: string;\n};\nexport declare function serializeGeneration(generation: Generation): StoredGeneration;\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport declare abstract class BaseCache<T = Generation[]> {\n    protected keyEncoder: HashKeyEncoder;\n    /**\n     * Sets a custom key encoder function for the cache.\n     * This function should take a prompt and an LLM key and return a string\n     * that will be used as the cache key.\n     * @param keyEncoderFn The custom key encoder function.\n     */\n    makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void;\n    abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n    abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport declare class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n    private cache;\n    constructor(map?: Map<string, T>);\n    /**\n     * Retrieves data from the cache using a prompt and an LLM key. If the\n     * data is not found, it returns null.\n     * @param prompt The prompt used to find the data.\n     * @param llmKey The LLM key used to find the data.\n     * @returns The data corresponding to the prompt and LLM key, or null if not found.\n     */\n    lookup(prompt: string, llmKey: string): Promise<T | null>;\n    /**\n     * Updates the cache with new data using a prompt and an LLM key.\n     * @param prompt The prompt used to store the data.\n     * @param llmKey The LLM key used to store the data.\n     * @param value The data to be stored.\n     */\n    update(prompt: string, llmKey: string, value: T): Promise<void>;\n    /**\n     * Returns a global instance of InMemoryCache using a predefined global\n     * map as the initial cache.\n     * @returns A global instance of InMemoryCache.\n     */\n    static global(): InMemoryCache;\n}\n"],"mappings":";;;;;;;;;;;;cAGqBS,uBAAuBH;iBACpBI,2BAAAA,mBAA8CF;;WAE8B,UAFd,gBAAA,IAE6G,YAAjJ,gBAAA,IAAwP,gBAAzJ,gBAAA,IAA0P,aAAnJ,gBAAA,IAAsP,cAArJ,gBAAA,IAAoP,YAAjJ,gBAAA;;;;;iBAKpaW,mBAAAA,aAAgCZ,aAAaC;AARrE;AACA;;AAAsEA,uBAWxCY,SAXwCZ,CAAAA,IAW1BD,UAX0BC,EAAAA,CAAAA,CAAAA;EAAgB,UAAA,UAAA,EAY5DF,cAZ4D;EAEc;;;;;;EAAuS,qBAAA,CAAA,YAAA,EAiBnWA,cAjBmW,CAAA,EAAA,IAAA;EAAlD,SAAA,MAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA,EAkBpSgB,OAlBoS,CAkB5RD,CAlB4R,GAAA,IAAA,CAAA;EAAqJ,SAAA,MAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,KAAA,EAmBnbA,CAnBmb,CAAA,EAmB/aC,OAnB+a,CAAA,IAAA,CAAA;;;AAA6C;AAK3hB;AAA2C,cAmBtBC,aAnBsB,CAAA,IAmBJhB,UAnBI,EAAA,CAAA,SAmBkBa,SAnBlB,CAmB4BC,CAnB5B,CAAA,CAAA;EAAA,QAAad,KAAAA;EAAU,WAAGC,CAAAA,GAAAA,CAAAA,EAqB/CgB,GArB+ChB,CAAAA,MAAAA,EAqBnCa,CArBmCb,CAAAA;EAAgB;AAIrF;;;;;;EAS8D,MAATc,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,CAAAA,EAgBTA,OAhBSA,CAgBDD,CAhBCC,GAAAA,IAAAA,CAAAA;EAAO;;AACU;AAKtE;;;EAAiD,MAAsBD,CAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAiBrBA,CAjBqBA,CAAAA,EAiBjBC,OAjBiBD,CAAAA,IAAAA,CAAAA;EAAC;;;;;EAiBrB,OAAGC,MAAAA,CAAAA,CAAAA,EAMjCC,aANiCD"}

package/dist/caches/base.js

@@ -1,6 +1,6 @@
 import { __export } from "../_virtual/rolldown_runtime.js";
 import { mapStoredMessageToChatMessage } from "../messages/utils.js";
-import { insecureHash } from "../utils/js-sha1/hash.js";
+import { sha256 } from "../utils/js-sha256/hash.js";
 import "../utils/hash.js";
 
 //#region src/caches/base.ts
@@ -8,24 +8,11 @@ var base_exports = {};
 __export(base_exports, {
 	BaseCache: () => BaseCache,
 	InMemoryCache: () => InMemoryCache,
+	defaultHashKeyEncoder: () => defaultHashKeyEncoder,
 	deserializeStoredGeneration: () => deserializeStoredGeneration,
-	getCacheKey: () => getCacheKey,
 	serializeGeneration: () => serializeGeneration
 });
-/**
-* This cache key should be consistent across all versions of LangChain.
-* It is currently NOT consistent across versions of LangChain.
-*
-* A huge benefit of having a remote cache (like redis) is that you can
-* access the cache from different processes/machines. The allows you to
-* separate concerns and scale horizontally.
-*
-* TODO: Make cache key consistent across versions of LangChain.
-*
-* @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.
-* This function will be removed in a future version.
-*/
-const getCacheKey = (...strings) => insecureHash(strings.join("_"));
+const defaultHashKeyEncoder = (...strings) => sha256(strings.join("_"));
 function deserializeStoredGeneration(storedGeneration) {
 	if (storedGeneration.message !== void 0) return {
 		text: storedGeneration.text,
@@ -42,7 +29,7 @@ function serializeGeneration(generation) {
 * Base class for all caches. All caches should extend this class.
 */
 var BaseCache = class {
-	keyEncoder = getCacheKey;
+	keyEncoder = defaultHashKeyEncoder;
 	/**
 	* Sets a custom key encoder function for the cache.
 	* This function should take a prompt and an LLM key and return a string
@@ -93,5 +80,5 @@ var InMemoryCache = class InMemoryCache extends BaseCache {
 };
 
 //#endregion
-export { BaseCache, InMemoryCache, base_exports, deserializeStoredGeneration, getCacheKey, serializeGeneration };
+export { BaseCache, InMemoryCache, base_exports, defaultHashKeyEncoder, deserializeStoredGeneration, serializeGeneration };
 //# sourceMappingURL=base.js.map

package/dist/caches/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","names":["getCacheKey: HashKeyEncoder","storedGeneration: StoredGeneration","generation: Generation","serializedValue: StoredGeneration","keyEncoderFn: HashKeyEncoder","map?: Map<string, T>","prompt: string","llmKey: string","value: T"],"sources":["../../src/caches/base.ts"],"sourcesContent":["import { insecureHash, type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation, ChatGeneration } from \"../outputs.js\";\nimport { mapStoredMessageToChatMessage } from \"../messages/utils.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\n\n/**\n * This cache key should be consistent across all versions of LangChain.\n * It is currently NOT consistent across versions of LangChain.\n *\n * A huge benefit of having a remote cache (like redis) is that you can\n * access the cache from different processes/machines. The allows you to\n * separate concerns and scale horizontally.\n *\n * TODO: Make cache key consistent across versions of LangChain.\n *\n * @deprecated Use `makeDefaultKeyEncoder()` to create a custom key encoder.\n * This function will be removed in a future version.\n */\nexport const getCacheKey: HashKeyEncoder = (...strings) =>\n  insecureHash(strings.join(\"_\"));\n\nexport function deserializeStoredGeneration(\n  storedGeneration: StoredGeneration\n) {\n  if (storedGeneration.message !== undefined) {\n    return {\n      text: storedGeneration.text,\n      message: mapStoredMessageToChatMessage(storedGeneration.message),\n    };\n  } else {\n    return { text: storedGeneration.text };\n  }\n}\n\nexport function serializeGeneration(generation: Generation) {\n  const serializedValue: StoredGeneration = {\n    text: generation.text,\n  };\n  if ((generation as ChatGeneration).message !== undefined) {\n    serializedValue.message = (generation as ChatGeneration).message.toDict();\n  }\n  return serializedValue;\n}\n\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport abstract class BaseCache<T = Generation[]> {\n  // For backwards compatibility, we use a default key encoder\n  // that uses SHA-1 to hash the prompt and LLM key. This will also print a warning\n  // about the security implications of using SHA-1 as a cache key.\n  protected keyEncoder: HashKeyEncoder = getCacheKey;\n\n  /**\n   * Sets a custom key encoder function for the cache.\n   * This function should take a prompt and an LLM key and return a string\n   * that will be used as the cache key.\n   * @param keyEncoderFn The custom key encoder function.\n   */\n  makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void {\n    this.keyEncoder = keyEncoderFn;\n  }\n\n  abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n\n  abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n\nconst GLOBAL_MAP = new Map();\n\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n  private cache: Map<string, T>;\n\n  constructor(map?: Map<string, T>) {\n    super();\n    this.cache = map ?? new Map();\n  }\n\n  /**\n   * Retrieves data from the cache using a prompt and an LLM key. If the\n   * data is not found, it returns null.\n   * @param prompt The prompt used to find the data.\n   * @param llmKey The LLM key used to find the data.\n   * @returns The data corresponding to the prompt and LLM key, or null if not found.\n   */\n  lookup(prompt: string, llmKey: string): Promise<T | null> {\n    return Promise.resolve(\n      this.cache.get(this.keyEncoder(prompt, llmKey)) ?? null\n    );\n  }\n\n  /**\n   * Updates the cache with new data using a prompt and an LLM key.\n   * @param prompt The prompt used to store the data.\n   * @param llmKey The LLM key used to store the data.\n   * @param value The data to be stored.\n   */\n  async update(prompt: string, llmKey: string, value: T): Promise<void> {\n    this.cache.set(this.keyEncoder(prompt, llmKey), value);\n  }\n\n  /**\n   * Returns a global instance of InMemoryCache using a predefined global\n   * map as the initial cache.\n   * @returns A global instance of InMemoryCache.\n   */\n  static global(): InMemoryCache {\n    return new InMemoryCache(GLOBAL_MAP);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBA,MAAaA,cAA8B,CAAC,GAAG,YAC7C,aAAa,QAAQ,KAAK,IAAI,CAAC;AAEjC,SAAgB,4BACdC,kBACA;AACA,KAAI,iBAAiB,YAAY,OAC/B,QAAO;EACL,MAAM,iBAAiB;EACvB,SAAS,8BAA8B,iBAAiB,QAAQ;CACjE;KAED,QAAO,EAAE,MAAM,iBAAiB,KAAM;AAEzC;AAED,SAAgB,oBAAoBC,YAAwB;CAC1D,MAAMC,kBAAoC,EACxC,MAAM,WAAW,KAClB;AACD,KAAK,WAA8B,YAAY,QAC7C,gBAAgB,UAAW,WAA8B,QAAQ,QAAQ;AAE3E,QAAO;AACR;;;;AAKD,IAAsB,YAAtB,MAAkD;CAIhD,AAAU,aAA6B;;;;;;;CAQvC,sBAAsBC,cAAoC;EACxD,KAAK,aAAa;CACnB;AAKF;AAED,MAAM,6BAAa,IAAI;;;;AAKvB,IAAa,gBAAb,MAAa,sBAAwC,UAAa;CAChE,AAAQ;CAER,YAAYC,KAAsB;EAChC,OAAO;EACP,KAAK,QAAQ,uBAAO,IAAI;CACzB;;;;;;;;CASD,OAAOC,QAAgBC,QAAmC;AACxD,SAAO,QAAQ,QACb,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,CAAC,IAAI,KACpD;CACF;;;;;;;CAQD,MAAM,OAAOD,QAAgBC,QAAgBC,OAAyB;EACpE,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,EAAE,MAAM;CACvD;;;;;;CAOD,OAAO,SAAwB;AAC7B,SAAO,IAAI,cAAc;CAC1B;AACF"}
+{"version":3,"file":"base.js","names":["defaultHashKeyEncoder: HashKeyEncoder","storedGeneration: StoredGeneration","generation: Generation","serializedValue: StoredGeneration","keyEncoderFn: HashKeyEncoder","map?: Map<string, T>","prompt: string","llmKey: string","value: T"],"sources":["../../src/caches/base.ts"],"sourcesContent":["import { sha256, type HashKeyEncoder } from \"../utils/hash.js\";\nimport type { Generation, ChatGeneration } from \"../outputs.js\";\nimport { mapStoredMessageToChatMessage } from \"../messages/utils.js\";\nimport { type StoredGeneration } from \"../messages/base.js\";\n\nexport const defaultHashKeyEncoder: HashKeyEncoder = (...strings) =>\n  sha256(strings.join(\"_\"));\n\nexport function deserializeStoredGeneration(\n  storedGeneration: StoredGeneration\n) {\n  if (storedGeneration.message !== undefined) {\n    return {\n      text: storedGeneration.text,\n      message: mapStoredMessageToChatMessage(storedGeneration.message),\n    };\n  } else {\n    return { text: storedGeneration.text };\n  }\n}\n\nexport function serializeGeneration(generation: Generation) {\n  const serializedValue: StoredGeneration = {\n    text: generation.text,\n  };\n  if ((generation as ChatGeneration).message !== undefined) {\n    serializedValue.message = (generation as ChatGeneration).message.toDict();\n  }\n  return serializedValue;\n}\n\n/**\n * Base class for all caches. All caches should extend this class.\n */\nexport abstract class BaseCache<T = Generation[]> {\n  protected keyEncoder: HashKeyEncoder = defaultHashKeyEncoder;\n\n  /**\n   * Sets a custom key encoder function for the cache.\n   * This function should take a prompt and an LLM key and return a string\n   * that will be used as the cache key.\n   * @param keyEncoderFn The custom key encoder function.\n   */\n  makeDefaultKeyEncoder(keyEncoderFn: HashKeyEncoder): void {\n    this.keyEncoder = keyEncoderFn;\n  }\n\n  abstract lookup(prompt: string, llmKey: string): Promise<T | null>;\n\n  abstract update(prompt: string, llmKey: string, value: T): Promise<void>;\n}\n\nconst GLOBAL_MAP = new Map();\n\n/**\n * A cache for storing LLM generations that stores data in memory.\n */\nexport class InMemoryCache<T = Generation[]> extends BaseCache<T> {\n  private cache: Map<string, T>;\n\n  constructor(map?: Map<string, T>) {\n    super();\n    this.cache = map ?? new Map();\n  }\n\n  /**\n   * Retrieves data from the cache using a prompt and an LLM key. If the\n   * data is not found, it returns null.\n   * @param prompt The prompt used to find the data.\n   * @param llmKey The LLM key used to find the data.\n   * @returns The data corresponding to the prompt and LLM key, or null if not found.\n   */\n  lookup(prompt: string, llmKey: string): Promise<T | null> {\n    return Promise.resolve(\n      this.cache.get(this.keyEncoder(prompt, llmKey)) ?? null\n    );\n  }\n\n  /**\n   * Updates the cache with new data using a prompt and an LLM key.\n   * @param prompt The prompt used to store the data.\n   * @param llmKey The LLM key used to store the data.\n   * @param value The data to be stored.\n   */\n  async update(prompt: string, llmKey: string, value: T): Promise<void> {\n    this.cache.set(this.keyEncoder(prompt, llmKey), value);\n  }\n\n  /**\n   * Returns a global instance of InMemoryCache using a predefined global\n   * map as the initial cache.\n   * @returns A global instance of InMemoryCache.\n   */\n  static global(): InMemoryCache {\n    return new InMemoryCache(GLOBAL_MAP);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAKA,MAAaA,wBAAwC,CAAC,GAAG,YACvD,OAAO,QAAQ,KAAK,IAAI,CAAC;AAE3B,SAAgB,4BACdC,kBACA;AACA,KAAI,iBAAiB,YAAY,OAC/B,QAAO;EACL,MAAM,iBAAiB;EACvB,SAAS,8BAA8B,iBAAiB,QAAQ;CACjE;KAED,QAAO,EAAE,MAAM,iBAAiB,KAAM;AAEzC;AAED,SAAgB,oBAAoBC,YAAwB;CAC1D,MAAMC,kBAAoC,EACxC,MAAM,WAAW,KAClB;AACD,KAAK,WAA8B,YAAY,QAC7C,gBAAgB,UAAW,WAA8B,QAAQ,QAAQ;AAE3E,QAAO;AACR;;;;AAKD,IAAsB,YAAtB,MAAkD;CAChD,AAAU,aAA6B;;;;;;;CAQvC,sBAAsBC,cAAoC;EACxD,KAAK,aAAa;CACnB;AAKF;AAED,MAAM,6BAAa,IAAI;;;;AAKvB,IAAa,gBAAb,MAAa,sBAAwC,UAAa;CAChE,AAAQ;CAER,YAAYC,KAAsB;EAChC,OAAO;EACP,KAAK,QAAQ,uBAAO,IAAI;CACzB;;;;;;;;CASD,OAAOC,QAAgBC,QAAmC;AACxD,SAAO,QAAQ,QACb,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,CAAC,IAAI,KACpD;CACF;;;;;;;CAQD,MAAM,OAAOD,QAAgBC,QAAgBC,OAAyB;EACpE,KAAK,MAAM,IAAI,KAAK,WAAW,QAAQ,OAAO,EAAE,MAAM;CACvD;;;;;;CAOD,OAAO,SAAwB;AAC7B,SAAO,IAAI,cAAc;CAC1B;AACF"}

package/dist/callbacks/base.d.cts

@@ -1,9 +1,10 @@
 import { AgentAction, AgentFinish } from "../agents.cjs";
 import { SerializedFields } from "../load/map_keys.cjs";
 import { Serializable, Serialized, SerializedNotImplemented } from "../load/serializable.cjs";
-import { ChainValues } from "../utils/types/index.cjs";
 import { BaseMessage } from "../messages/base.cjs";
+import { MessageStructure, MessageType } from "../messages/message.cjs";
 import { ChatGenerationChunk, GenerationChunk, LLMResult } from "../outputs.cjs";
+import { ChainValues } from "../utils/types/index.cjs";
 import { DocumentInterface } from "../documents/document.cjs";
 
 //#region src/callbacks/base.d.ts
@@ -236,7 +237,7 @@ declare abstract class BaseCallbackHandler extends BaseCallbackHandlerMethodsCla
      * Called at the start of a Chat Model run, with the prompt(s)
      * and the run ID.
      */
-    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;
+    handleChatModelStart?(llm: Serialized, messages: BaseMessage<MessageStructure, MessageType>[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;
     /**
      * Called at the start of a Chain run, with the chain name and inputs
      * and the run ID.

package/dist/callbacks/base.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.cts","names":["ChainValues","BaseMessage","AgentAction","AgentFinish","ChatGenerationChunk","GenerationChunk","LLMResult","Serializable","Serialized","SerializedNotImplemented","SerializedFields","DocumentInterface","Error","BaseCallbackHandlerInput","NewTokenIndices","HandleLLMNewTokenCallbackFields","BaseCallbackHandlerMethodsClass","Record","Promise","CallbackHandlerMethods","CallbackHandlerPrefersStreaming","callbackHandlerPrefersStreaming","BaseCallbackHandler","isBaseCallbackHandler"],"sources":["../../src/callbacks/base.d.ts"],"sourcesContent":["import type { ChainValues } from \"../utils/types/index.js\";\nimport type { BaseMessage } from \"../messages/base.js\";\nimport type { AgentAction, AgentFinish } from \"../agents.js\";\nimport type { ChatGenerationChunk, GenerationChunk, LLMResult } from \"../outputs.js\";\nimport { Serializable, Serialized, SerializedNotImplemented } from \"../load/serializable.js\";\nimport type { SerializedFields } from \"../load/map_keys.js\";\nimport type { DocumentInterface } from \"../documents/document.js\";\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Error = any;\n/**\n * Interface for the input parameters of the BaseCallbackHandler class. It\n * allows to specify which types of events should be ignored by the\n * callback handler.\n */\nexport interface BaseCallbackHandlerInput {\n    ignoreLLM?: boolean;\n    ignoreChain?: boolean;\n    ignoreAgent?: boolean;\n    ignoreRetriever?: boolean;\n    ignoreCustomEvent?: boolean;\n    _awaitHandler?: boolean;\n    raiseError?: boolean;\n}\n/**\n * Interface for the indices of a new token produced by an LLM or Chat\n * Model in streaming mode.\n */\nexport interface NewTokenIndices {\n    prompt: number;\n    completion: number;\n}\n// TODO: Add all additional callback fields here\nexport type HandleLLMNewTokenCallbackFields = {\n    chunk?: GenerationChunk | ChatGenerationChunk;\n};\n/**\n * Abstract class that provides a set of optional methods that can be\n * overridden in derived classes to handle various events during the\n * execution of a LangChain application.\n */\ndeclare abstract class BaseCallbackHandlerMethodsClass {\n    /**\n     * Called at the start of an LLM or Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called when an LLM/ChatModel in `streaming` mode produces a new token\n     */\n    handleLLMNewToken?(token: string, \n    /**\n     * idx.prompt is the index of the prompt that produced the token\n     *   (if there are multiple prompts)\n     * idx.completion is the index of the completion that produced the token\n     *   (if multiple completions per prompt are requested)\n     */\n    idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if an LLM/ChatModel run encounters an error\n     */\n    handleLLMError?(err: Error, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n     */\n    handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chain run, with the chain name and inputs\n     * and the run ID.\n     */\n    handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Chain run encounters an error\n     */\n    handleChainError?(err: Error, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Chain run, with the outputs and the run ID.\n     */\n    handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Tool run, with the tool name and input\n     * and the run ID.\n     */\n    handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Tool run encounters an error\n     */\n    handleToolError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Tool run, with the tool output and the run ID.\n     */\n    handleToolEnd?(\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    output: any, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent is about to execute an action,\n     * with the action and the run ID.\n     */\n    handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent finishes execution, before it exits.\n     * with the final output and the run ID.\n     */\n    handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverEnd?(documents: DocumentInterface[], runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleCustomEvent?(eventName: string, \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    data: any, runId: string, tags?: string[], \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    metadata?: Record<string, any>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n}\n/**\n * Base interface for callbacks. All methods are optional. If a method is not\n * implemented, it will be ignored. If a method is implemented, it will be\n * called at the appropriate time. All methods are called with the run ID of\n * the LLM/ChatModel/Chain that is running, which is generated by the\n * CallbackManager.\n *\n * @interface\n */\nexport type CallbackHandlerMethods = BaseCallbackHandlerMethodsClass;\n/**\n * Interface for handlers that can indicate a preference for streaming responses.\n * When implemented, this allows the handler to signal whether it prefers to receive\n * streaming responses from language models rather than complete responses.\n */\nexport interface CallbackHandlerPrefersStreaming {\n    readonly lc_prefer_streaming: boolean;\n}\nexport declare function callbackHandlerPrefersStreaming(x: BaseCallbackHandler): unknown;\n/**\n * Abstract base class for creating callback handlers in the LangChain\n * framework. It provides a set of optional methods that can be overridden\n * in derived classes to handle various events during the execution of a\n * LangChain application.\n */\nexport declare abstract class BaseCallbackHandler extends BaseCallbackHandlerMethodsClass implements BaseCallbackHandlerInput, Serializable {\n    lc_serializable: boolean;\n    get lc_namespace(): [\"langchain_core\", \"callbacks\", string];\n    get lc_secrets(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_attributes(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_aliases(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_serializable_keys(): string[] | undefined;\n    /**\n     * The name of the serializable. Override to provide an alias or\n     * to preserve the serialized module name in minified environments.\n     *\n     * Implemented as a static method to support loading logic.\n     */\n    static lc_name(): string;\n    /**\n     * The final serialized identifier for the module.\n     */\n    get lc_id(): string[];\n    lc_kwargs: SerializedFields;\n    abstract name: string;\n    ignoreLLM: boolean;\n    ignoreChain: boolean;\n    ignoreAgent: boolean;\n    ignoreRetriever: boolean;\n    ignoreCustomEvent: boolean;\n    raiseError: boolean;\n    awaitHandlers: boolean;\n    constructor(input?: BaseCallbackHandlerInput);\n    copy(): BaseCallbackHandler;\n    toJSON(): Serialized;\n    toJSONNotImplemented(): SerializedNotImplemented;\n    static fromMethods(methods: CallbackHandlerMethods): {\n        /**\n         * Called at the start of an LLM or Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called when an LLM/ChatModel in `streaming` mode produces a new token\n         */\n        handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, fields?: HandleLLMNewTokenCallbackFields | undefined): any;\n        /**\n         * Called if an LLM/ChatModel run encounters an error\n         */\n        handleLLMError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n         */\n        handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the start of a Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called at the start of a Chain run, with the chain name and inputs\n         * and the run ID.\n         */\n        handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runType?: string | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Chain run encounters an error\n         */\n        handleChainError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the end of a Chain run, with the outputs and the run ID.\n         */\n        handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the start of a Tool run, with the tool name and input\n         * and the run ID.\n         */\n        handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Tool run encounters an error\n         */\n        handleToolError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        /**\n         * Called at the end of a Tool run, with the tool output and the run ID.\n         */\n        handleToolEnd?(output: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleText?(text: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent is about to execute an action,\n         * with the action and the run ID.\n         */\n        handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent finishes execution, before it exits.\n         * with the final output and the run ID.\n         */\n        handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, name?: string | undefined): any;\n        handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleRetrieverError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[] | undefined, metadata?: Record<string, any> | undefined): any;\n        lc_serializable: boolean;\n        readonly lc_namespace: [\"langchain_core\", \"callbacks\", string];\n        readonly lc_secrets: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_attributes: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_aliases: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_serializable_keys: string[] | undefined;\n        /**\n         * The final serialized identifier for the module.\n         */\n        readonly lc_id: string[];\n        lc_kwargs: SerializedFields;\n        ignoreLLM: boolean;\n        ignoreChain: boolean;\n        ignoreAgent: boolean;\n        ignoreRetriever: boolean;\n        ignoreCustomEvent: boolean;\n        raiseError: boolean;\n        awaitHandlers: boolean;\n        copy(): BaseCallbackHandler;\n        toJSON(): Serialized;\n        toJSONNotImplemented(): SerializedNotImplemented;\n        name: string;\n    };\n}\nexport declare const isBaseCallbackHandler: (x: unknown) => boolean;\nexport {};\n"],"mappings":";;;;;;;;;;KAQKY,KAAAA;AAF6D;AAQlE;AAaA;AAKA;;AACYP,UAnBKQ,wBAAAA,CAmBLR;EAAe,SAAGD,CAAAA,EAAAA,OAAAA;EAAmB,WAAA,CAAA,EAAA,OAAA;EAO1BY,WAAAA,CAAAA,EAAAA,OAAAA;EAA+B,eAAA,CAAA,EAAA,OAAA;EAAA,iBAK7BR,CAAAA,EAAAA,OAAAA;EAAU,aAAwES,CAAAA,EAAAA,OAAAA;EAAM,UAA+CA,CAAAA,EAAAA,OAAAA;;;;;;AAiB5DA,UAnCnFH,eAAAA,CAmCmFG;EAAM,MACtGC,EAAAA,MAAAA;EAAO,UAIeZ,EAAAA,MAAAA;;;AAMKE,KAzCnBO,+BAAAA,GAyCmBP;EAAU,KAAYP,CAAAA,EAxCzCI,eAwCyCJ,GAxCvBG,mBAwCuBH;CAAW;;;;;;uBAjCzCe,+BAAAA,CAwCnBE;EAAO;;;;EAW6B,cACvBD,CAAAA,CAAAA,GAAAA,EA/CQT,UA+CRS,EAAAA,OAAAA,EAAAA,MAAAA,EAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EA/C0FA,MA+C1FA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA/C+IA,MA+C/IA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EA9CbC,OAgDAA,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAO;;;EAMA,iBAIeN,CAAAA,CAAAA,KAAAA,EAAAA,MAAAA;EAAK;;;;;;EAmBQ,GAAyDM,EAlEvFJ,eAkEuFI,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAAA,CAAAA,EAlEPH,+BAkEOG,CAAAA;EAAAA;EAjE5FA,OAkEiCV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAEK,cAChDU,CAAAA,CAAAA,GAAAA,EAjEqBN,KAiErBM,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,WAAAA,CAAAA,EAjEgGD,MAiEhGC,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;EAAAA;EAhEAA,OAiE2BN,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAK;;;EAOzB,YAAA,CAAA,CAAA,MAAA,EApEeN,SAoEf,EAAA,KAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EAAA,MAAA,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,EAAA,WAAA,CAAA,EApE8FW,MAoE9F,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;EAAA;EAnEPC,OA8EQC,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAMKC;AAGjB;AAOA;;EAAiD,oBAwBlCV,CAAAA,CAAAA,GAAAA,EAjHgBF,UAiHhBE,EAAAA,QAAAA,EAjHsCT,WAiHtCS,EAAAA,EAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAjH0GO,MAiH1GP,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAjH+JO,MAiH/JP,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAhHXQ,OAyHoBL,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAwB;;;;EAIM,gBAKzBL,CAAAA,CAAAA,KAAAA,EA7HAA,UA6HAA,EAAAA,MAAAA,EA7HoBR,WA6HpBQ,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA7HkGS,MA6HlGT,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EA5HzBU,OA4HuHD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAIqD,gBAIxDA,CAAAA,CAAAA,GAAAA,EAhInGL,KAgImGK,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAIvF,CAJuFA,EAAAA;IAIhGX,MAAAA,CAAAA,EAnIbW,MAmIaX,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAS,CAAA,CAAA;EAA8FW;EAjIjIC,OAsI+BV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAA+K,cAK3LA,CAAAA,CAAAA,OAAAA,EAvIJR,WAuIIQ,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAA+B,CAA/BA,EAAAA;IAAoBR,MAAAA,CAAAA,EAtIpCiB,MAsIoCjB,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAW,CAAA,CAAA;EAA2FiB;EApIvJC,OAyIiBD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;;EAY8H,eASjCC,CAAAA,CAAAA,IAAAA,EAzJ7FV,UAyJ6FU,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAzJDD,MAyJCC,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAxJpHA,OA6J+BhB,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAW;;;EAK4F,eACjGM,CAAAA,CAAAA,GAAAA,EA/JfI,KA+JeJ,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EA9JrCU,OA8JyJD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAG7C,aAiBnGP,CAAAA;EAAgB;EAQA,MACjBF,EAAAA,GAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EApLdU,OAqL4BT,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAwB,UAnIEO,CAAAA,CAAAA,IAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAjD2BE,OAiD3BF,CAAAA,IAAAA,CAAAA,GAAAA,IAAAA;EAA+B;;AAAkD;AAuI3I;6BAnL+Bd,oEAAoEgB;;;;;0BAKvEf,oEAAoEe;mCAC3DV,4FAA4FS;;EAC7HC;iCAC+BP;;EAC/BO;6BAC2BN;;EAC3BM;;;;;aAKWD;;EACXC;;;;;;;;;;;KAWQC,sBAAAA,GAAyBH;;;;;;UAMpBI,+BAAAA;;;iBAGOC,+BAAAA,IAAmCC;;;;;;;uBAO7BA,mBAAAA,SAA4BN,+BAAAA,YAA2CH,0BAA0BN;;;;;;;;;;;;;;;;;;;;;;;;aAwBhHG;;;;;;;;;sBASSG;UACZS;YACEd;0BACcC;8BACIU;;;;;yBAKHX,8FAA8FS,6EAA6EA;;;;2CAIzJH,wGAAwGC;;;;0HAIzBE;;;;0BAIhGX,uGAAuGW;;;;;+BAKlGT,sBAAsBP,gFAAgFgB,6EAA6EA;;;;;6BAKrLT,oBAAoBR,sGAAsGiB;;;;;eAKtIA;;;;;6BAKYjB;eACZiB;;;;;;2BAMUT,oHAAoHS;;;;;;;;;oHAS3BC;;;;;+BAKrFhB,mGAAmGgB;;;;;4BAKtGf,mGAAmGe;qCAC1FV,oHAAoHS;mCACtHN,kBAAkBM;;4GAEuDA;;;;;;;;;;;;;;;;;eAiB7FP;;;;;;;;YAQHY;cACEd;4BACcC;;;;cAIXc"}
+{"version":3,"file":"base.d.cts","names":["ChainValues","BaseMessage","AgentAction","AgentFinish","ChatGenerationChunk","GenerationChunk","LLMResult","Serializable","Serialized","SerializedNotImplemented","SerializedFields","DocumentInterface","Error","BaseCallbackHandlerInput","NewTokenIndices","HandleLLMNewTokenCallbackFields","BaseCallbackHandlerMethodsClass","Record","Promise","CallbackHandlerMethods","CallbackHandlerPrefersStreaming","callbackHandlerPrefersStreaming","BaseCallbackHandler","___messages_message_js5","MessageStructure","MessageType","isBaseCallbackHandler"],"sources":["../../src/callbacks/base.d.ts"],"sourcesContent":["import type { ChainValues } from \"../utils/types/index.js\";\nimport type { BaseMessage } from \"../messages/base.js\";\nimport type { AgentAction, AgentFinish } from \"../agents.js\";\nimport type { ChatGenerationChunk, GenerationChunk, LLMResult } from \"../outputs.js\";\nimport { Serializable, Serialized, SerializedNotImplemented } from \"../load/serializable.js\";\nimport type { SerializedFields } from \"../load/map_keys.js\";\nimport type { DocumentInterface } from \"../documents/document.js\";\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype Error = any;\n/**\n * Interface for the input parameters of the BaseCallbackHandler class. It\n * allows to specify which types of events should be ignored by the\n * callback handler.\n */\nexport interface BaseCallbackHandlerInput {\n    ignoreLLM?: boolean;\n    ignoreChain?: boolean;\n    ignoreAgent?: boolean;\n    ignoreRetriever?: boolean;\n    ignoreCustomEvent?: boolean;\n    _awaitHandler?: boolean;\n    raiseError?: boolean;\n}\n/**\n * Interface for the indices of a new token produced by an LLM or Chat\n * Model in streaming mode.\n */\nexport interface NewTokenIndices {\n    prompt: number;\n    completion: number;\n}\n// TODO: Add all additional callback fields here\nexport type HandleLLMNewTokenCallbackFields = {\n    chunk?: GenerationChunk | ChatGenerationChunk;\n};\n/**\n * Abstract class that provides a set of optional methods that can be\n * overridden in derived classes to handle various events during the\n * execution of a LangChain application.\n */\ndeclare abstract class BaseCallbackHandlerMethodsClass {\n    /**\n     * Called at the start of an LLM or Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called when an LLM/ChatModel in `streaming` mode produces a new token\n     */\n    handleLLMNewToken?(token: string, \n    /**\n     * idx.prompt is the index of the prompt that produced the token\n     *   (if there are multiple prompts)\n     * idx.completion is the index of the completion that produced the token\n     *   (if multiple completions per prompt are requested)\n     */\n    idx: NewTokenIndices, runId: string, parentRunId?: string, tags?: string[], fields?: HandleLLMNewTokenCallbackFields): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if an LLM/ChatModel run encounters an error\n     */\n    handleLLMError?(err: Error, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n     */\n    handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string, tags?: string[], extraParams?: Record<string, unknown>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chat Model run, with the prompt(s)\n     * and the run ID.\n     */\n    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string, extraParams?: Record<string, unknown>, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Chain run, with the chain name and inputs\n     * and the run ID.\n     */\n    handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runType?: string, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Chain run encounters an error\n     */\n    handleChainError?(err: Error, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Chain run, with the outputs and the run ID.\n     */\n    handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string, tags?: string[], kwargs?: {\n        inputs?: Record<string, unknown>;\n    }): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the start of a Tool run, with the tool name and input\n     * and the run ID.\n     */\n    handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, runName?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called if a Tool run encounters an error\n     */\n    handleToolError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    /**\n     * Called at the end of a Tool run, with the tool output and the run ID.\n     */\n    handleToolEnd?(\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    output: any, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleText?(text: string, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent is about to execute an action,\n     * with the action and the run ID.\n     */\n    handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    /**\n     * Called when an agent finishes execution, before it exits.\n     * with the final output and the run ID.\n     */\n    handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string, tags?: string[]): Promise<void> | void;\n    handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string, tags?: string[], metadata?: Record<string, unknown>, name?: string): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverEnd?(documents: DocumentInterface[], runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleRetrieverError?(err: Error, runId: string, parentRunId?: string, tags?: string[]): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n    handleCustomEvent?(eventName: string, \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    data: any, runId: string, tags?: string[], \n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    metadata?: Record<string, any>): // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    Promise<any> | any;\n}\n/**\n * Base interface for callbacks. All methods are optional. If a method is not\n * implemented, it will be ignored. If a method is implemented, it will be\n * called at the appropriate time. All methods are called with the run ID of\n * the LLM/ChatModel/Chain that is running, which is generated by the\n * CallbackManager.\n *\n * @interface\n */\nexport type CallbackHandlerMethods = BaseCallbackHandlerMethodsClass;\n/**\n * Interface for handlers that can indicate a preference for streaming responses.\n * When implemented, this allows the handler to signal whether it prefers to receive\n * streaming responses from language models rather than complete responses.\n */\nexport interface CallbackHandlerPrefersStreaming {\n    readonly lc_prefer_streaming: boolean;\n}\nexport declare function callbackHandlerPrefersStreaming(x: BaseCallbackHandler): unknown;\n/**\n * Abstract base class for creating callback handlers in the LangChain\n * framework. It provides a set of optional methods that can be overridden\n * in derived classes to handle various events during the execution of a\n * LangChain application.\n */\nexport declare abstract class BaseCallbackHandler extends BaseCallbackHandlerMethodsClass implements BaseCallbackHandlerInput, Serializable {\n    lc_serializable: boolean;\n    get lc_namespace(): [\"langchain_core\", \"callbacks\", string];\n    get lc_secrets(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_attributes(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_aliases(): {\n        [key: string]: string;\n    } | undefined;\n    get lc_serializable_keys(): string[] | undefined;\n    /**\n     * The name of the serializable. Override to provide an alias or\n     * to preserve the serialized module name in minified environments.\n     *\n     * Implemented as a static method to support loading logic.\n     */\n    static lc_name(): string;\n    /**\n     * The final serialized identifier for the module.\n     */\n    get lc_id(): string[];\n    lc_kwargs: SerializedFields;\n    abstract name: string;\n    ignoreLLM: boolean;\n    ignoreChain: boolean;\n    ignoreAgent: boolean;\n    ignoreRetriever: boolean;\n    ignoreCustomEvent: boolean;\n    raiseError: boolean;\n    awaitHandlers: boolean;\n    constructor(input?: BaseCallbackHandlerInput);\n    copy(): BaseCallbackHandler;\n    toJSON(): Serialized;\n    toJSONNotImplemented(): SerializedNotImplemented;\n    static fromMethods(methods: CallbackHandlerMethods): {\n        /**\n         * Called at the start of an LLM or Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleLLMStart?(llm: Serialized, prompts: string[], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called when an LLM/ChatModel in `streaming` mode produces a new token\n         */\n        handleLLMNewToken?(token: string, idx: NewTokenIndices, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, fields?: HandleLLMNewTokenCallbackFields | undefined): any;\n        /**\n         * Called if an LLM/ChatModel run encounters an error\n         */\n        handleLLMError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the end of an LLM/ChatModel run, with the output and the run ID.\n         */\n        handleLLMEnd?(output: LLMResult, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, extraParams?: Record<string, unknown> | undefined): any;\n        /**\n         * Called at the start of a Chat Model run, with the prompt(s)\n         * and the run ID.\n         */\n        handleChatModelStart?(llm: Serialized, messages: BaseMessage<import(\"../messages/message.js\").MessageStructure, import(\"../messages/message.js\").MessageType>[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called at the start of a Chain run, with the chain name and inputs\n         * and the run ID.\n         */\n        handleChainStart?(chain: Serialized, inputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runType?: string | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Chain run encounters an error\n         */\n        handleChainError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the end of a Chain run, with the outputs and the run ID.\n         */\n        handleChainEnd?(outputs: ChainValues, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, kwargs?: {\n            inputs?: Record<string, unknown> | undefined;\n        } | undefined): any;\n        /**\n         * Called at the start of a Tool run, with the tool name and input\n         * and the run ID.\n         */\n        handleToolStart?(tool: Serialized, input: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;\n        /**\n         * Called if a Tool run encounters an error\n         */\n        handleToolError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        /**\n         * Called at the end of a Tool run, with the tool output and the run ID.\n         */\n        handleToolEnd?(output: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleText?(text: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent is about to execute an action,\n         * with the action and the run ID.\n         */\n        handleAgentAction?(action: AgentAction, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        /**\n         * Called when an agent finishes execution, before it exits.\n         * with the final output and the run ID.\n         */\n        handleAgentEnd?(action: AgentFinish, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): void | Promise<void>;\n        handleRetrieverStart?(retriever: Serialized, query: string, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, name?: string | undefined): any;\n        handleRetrieverEnd?(documents: DocumentInterface<Record<string, any>>[], runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleRetrieverError?(err: any, runId: string, parentRunId?: string | undefined, tags?: string[] | undefined): any;\n        handleCustomEvent?(eventName: string, data: any, runId: string, tags?: string[] | undefined, metadata?: Record<string, any> | undefined): any;\n        lc_serializable: boolean;\n        readonly lc_namespace: [\"langchain_core\", \"callbacks\", string];\n        readonly lc_secrets: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_attributes: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_aliases: {\n            [key: string]: string;\n        } | undefined;\n        readonly lc_serializable_keys: string[] | undefined;\n        /**\n         * The final serialized identifier for the module.\n         */\n        readonly lc_id: string[];\n        lc_kwargs: SerializedFields;\n        ignoreLLM: boolean;\n        ignoreChain: boolean;\n        ignoreAgent: boolean;\n        ignoreRetriever: boolean;\n        ignoreCustomEvent: boolean;\n        raiseError: boolean;\n        awaitHandlers: boolean;\n        copy(): BaseCallbackHandler;\n        toJSON(): Serialized;\n        toJSONNotImplemented(): SerializedNotImplemented;\n        name: string;\n    };\n}\nexport declare const isBaseCallbackHandler: (x: unknown) => boolean;\nexport {};\n"],"mappings":";;;;;;;;;;;KAQKY,KAAAA;;AAF6D;AAQlE;AAaA;AAKA;AAA2C,UAlB1BC,wBAAAA,CAkB0B;EAAA,SAC/BR,CAAAA,EAAAA,OAAAA;EAAe,WAAGD,CAAAA,EAAAA,OAAAA;EAAmB,WAAA,CAAA,EAAA,OAAA;EAO1BY,eAAAA,CAAAA,EAAAA,OAAAA;EAA+B,iBAAA,CAAA,EAAA,OAAA;EAAA,aAK7BR,CAAAA,EAAAA,OAAAA;EAAU,UAAwES,CAAAA,EAAAA,OAAAA;;;;;;AAiBlFL,UAnCRE,eAAAA,CAmCQF;EAAK,MAAsEK,EAAAA,MAAAA;EAAM,UACtGC,EAAAA,MAAAA;;;AAKAA,KApCQH,+BAAAA,GAoCRG;EAAO,KAKoBV,CAAAA,EAxCnBH,eAwCmBG,GAxCDJ,mBAwCCI;CAAU;;;;;;uBAjClBQ,+BAAAA,CAuCwGC;EAAM;;;;EAQ1H,cAIkBjB,CAAAA,CAAAA,GAAAA,EA9CJQ,UA8CIR,EAAAA,OAAAA,EAAAA,MAAAA,EAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EA9C8EiB,MA8C9EjB,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA9CmIiB,MA8CnIjB,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EA7CzBkB,OA8CaD,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAOsG,iBACzHC,CAAAA,CAAAA,KAAAA,EAAAA,MAAAA;EAAO;;;;;;EAkB+F,GAK9Ef,EAlEnBW,eAkEmBX,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAAA,CAAAA,EAlE6DY,+BAkE7DZ,CAAAA;EAAAA;EAjExBe,OAiE4FA,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAO;;;EAE5F,cACwBP,CAAAA,CAAAA,GAAAA,EAhEVC,KAgEUD,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,WAAAA,CAAAA,EAhEiEM,MAgEjEN,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;EAAAA;EA/D/BO,OAgEAA,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAO;;;EAOU,YACjBA,CAAAA,CAAAA,MAAAA,EApEsBZ,SAoEtBY,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,WAAAA,CAAAA,EApEqGD,MAoErGC,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,CAAAA;EAAAA;EAnEAA,OAmEO,CAAA,GAAA,CAAA,GAAA,GAAA;EAWCC;AAMZ;AAGA;AAOA;EAAiD,oBAAA,CAAA,CAAA,GAAA,EAzFlBX,UAyFkB,EAAA,QAAA,EAzFIP,WAyFJ,EAAA,EAAA,EAAA,KAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EAAA,MAAA,EAAA,WAAA,CAAA,EAzFwEgB,MAyFxE,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,EAAA,QAAA,CAAA,EAzF6HA,MAyF7H,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,OAAA,CAAA,EAAA,MAAA,CAAA;EAAA;EAxF7CC,OAgHWR,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAgB;;;;EAYqB,gBACpBS,CAAAA,CAAAA,KAAAA,EAxHHX,UAwHGW,EAAAA,MAAAA,EAxHiBnB,WAwHjBmB,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EAxH+FF,MAwH/FE,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAvH5BD,OA4HyBV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAIuB,gBAAyFO,CAAAA,CAAAA,GAAAA,EA5H5HH,KA4H4HG,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAInB,CAJmBA,EAAAA;IAIzBE,MAAAA,CAAAA,EA/H7GA,MA+H6GA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAM,CAAA,CAAA;EAItGX;EAjI1BY,OAiIiID,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAM;;;EAKyB,cAA3GhB,CAAAA,CAAAA,OAAAA,EAlI5BD,WAkI4BC,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,MAAuL,CAAvLA,EAAAA;IAAiLgB,MAAAA,CAAAA,EAjIzNA,MAiIyNA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;EAAM,CAAA,CAAA;EAAuEA;EA/HnTC,OAoI6BV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;;EAUC,eACvBS,CAAAA,CAAAA,IAAAA,EA1IMT,UA0INS,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,EAAAA,QAAAA,CAAAA,EA1IkGA,MA0IlGA,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA,EAAAA,OAAAA,CAAAA,EAAAA,MAAAA,CAAAA;EAAAA;EAzIjBC,OA+I2BV,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAU;;;EAcK,eAAwFU,CAAAA,CAAAA,GAAAA,EAzJ5GN,KAyJ4GM,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EAxJlIA,OA6J4Bf,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAW;;;EACwH,aAC1Gc,CAAAA;EAAM;EAAP,MAEwDA,EAAAA,GAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA;EAAAA;EA1J5GC,OA2KeR,CAAAA,GAAAA,CAAAA,GAAAA,GAAAA;EAAgB,UAQnBY,CAAAA,CAAAA,IAAAA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EAlLqEJ,OAkLrEI,CAAAA,IAAAA,CAAAA,GAAAA,IAAAA;EAAmB;;;;EAjI0F,iBAAEf,CAAAA,CAAAA,MAAAA,EA5ChGL,WA4CgGK,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,WAAAA,CAAAA,EAAAA,MAAAA,EAAAA,IAAAA,CAAAA,EAAAA,MAAAA,EAAAA,CAAAA,EA5C5BW,OA4C4BX,CAAAA,IAAAA,CAAAA,GAAAA,IAAAA;EAAY;AAuI3I;;;0BA9K4BJ,oEAAoEe;mCAC3DV,4FAA4FS;;EAC7HC;iCAC+BP;;EAC/BO;6BAC2BN;;EAC3BM;;;;;aAKWD;;EACXC;;;;;;;;;;;KAWQC,sBAAAA,GAAyBH;;;;;;UAMpBI,+BAAAA;;;iBAGOC,+BAAAA,IAAmCC;;;;;;;uBAO7BA,mBAAAA,SAA4BN,+BAAAA,YAA2CH,0BAA0BN;;;;;;;;;;;;;;;;;;;;;;;;aAwBhHG;;;;;;;;;sBASSG;UACZS;YACEd;0BACcC;8BACIU;;;;;yBAKHX,8FAA8FS,6EAA6EA;;;;2CAIzJH,wGAAwGC;;;;0HAIzBE;;;;0BAIhGX,uGAAuGW;;;;;+BAKlGT,sBAAsBP,YAAZ,gBAAA,EAAyE,WAAA,sEAAoHgB,6EAA6EA;;;;;6BAKtRT,oBAAoBR,sGAAsGiB;;;;;eAKtIA;;;;;6BAKYjB;eACZiB;;;;;;2BAMUT,oHAAoHS;;;;;;;;;oHAS3BC;;;;;+BAKrFhB,mGAAmGgB;;;;;4BAKtGf,mGAAmGe;qCAC1FV,oHAAoHS;mCACtHN,kBAAkBM;;4GAEuDA;;;;;;;;;;;;;;;;;eAiB7FP;;;;;;;;YAQHY;cACEd;4BACcC;;;;cAIXiB"}

package/dist/callbacks/base.d.ts

@@ -1,9 +1,10 @@
 import { AgentAction, AgentFinish } from "../agents.js";
 import { SerializedFields } from "../load/map_keys.js";
 import { Serializable, Serialized, SerializedNotImplemented } from "../load/serializable.js";
-import { ChainValues } from "../utils/types/index.js";
 import { BaseMessage } from "../messages/base.js";
+import { MessageStructure, MessageType } from "../messages/message.js";
 import { ChatGenerationChunk, GenerationChunk, LLMResult } from "../outputs.js";
+import { ChainValues } from "../utils/types/index.js";
 import { DocumentInterface } from "../documents/document.js";
 
 //#region src/callbacks/base.d.ts
@@ -236,7 +237,7 @@ declare abstract class BaseCallbackHandler extends BaseCallbackHandlerMethodsCla
      * Called at the start of a Chat Model run, with the prompt(s)
      * and the run ID.
      */
-    handleChatModelStart?(llm: Serialized, messages: BaseMessage[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;
+    handleChatModelStart?(llm: Serialized, messages: BaseMessage<MessageStructure, MessageType>[][], runId: string, parentRunId?: string | undefined, extraParams?: Record<string, unknown> | undefined, tags?: string[] | undefined, metadata?: Record<string, unknown> | undefined, runName?: string | undefined): any;
     /**
      * Called at the start of a Chain run, with the chain name and inputs
      * and the run ID.