langchain 0.0.192 → 0.0.194

package/dist/agents/structured_chat/outputParser.d.ts

@@ -45,6 +45,18 @@ export interface StructuredChatOutputParserArgs {
  * and `OutputFixingParser` classes. It extends the
  * `AgentActionOutputParser` class and allows for retrying the output
  * parsing using the `OutputFixingParser` if it is provided.
+ * @example
+ * ```typescript
+ * const outputParser = new StructuredChatOutputParserWithRetries.fromLLM(
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   {
+ *     toolNames: ["calculator", "random-number-generator"],
+ *   },
+ * );
+ * const result = await outputParser.parse(
+ *  "What is a random number between 5 and 10 raised to the second power?"
+ * );
+ * ```
  */
 export declare class StructuredChatOutputParserWithRetries extends AgentActionOutputParser {
     lc_namespace: string[];

package/dist/agents/structured_chat/outputParser.js

@@ -68,6 +68,18 @@ export class StructuredChatOutputParser extends AgentActionOutputParser {
  * and `OutputFixingParser` classes. It extends the
  * `AgentActionOutputParser` class and allows for retrying the output
  * parsing using the `OutputFixingParser` if it is provided.
+ * @example
+ * ```typescript
+ * const outputParser = new StructuredChatOutputParserWithRetries.fromLLM(
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   {
+ *     toolNames: ["calculator", "random-number-generator"],
+ *   },
+ * );
+ * const result = await outputParser.parse(
+ *  "What is a random number between 5 and 10 raised to the second power?"
+ * );
+ * ```
  */
 export class StructuredChatOutputParserWithRetries extends AgentActionOutputParser {
     constructor(fields) {

package/dist/agents/toolkits/aws_sfn.cjs

@@ -23,6 +23,26 @@ Thought: I should look at state machines within AWS Step Functions to see what a
  * Class representing a toolkit for interacting with AWS Step Functions.
  * It initializes the AWS Step Functions tools and provides them as tools
  * for the agent.
+ * @example
+ * ```typescript
+ *
+ * const toolkit = new AWSSfnToolkit({
+ *   name: "onboard-new-client-workflow",
+ *   description:
+ *     "Onboard new client workflow. Can also be used to get status of any executing workflow or state machine.",
+ *   stateMachineArn:
+ *     "arn:aws:states:us-east-1:1234567890:stateMachine:my-state-machine",
+ *   region: "<your Sfn's region>",
+ *   accessKeyId: "<your access key id>",
+ *   secretAccessKey: "<your secret access key>",
+ * });
+ *
+ *
+ * const result = await toolkit.invoke({
+ *   input: "Onboard john doe (john@example.com) as a new client.",
+ * });
+ *
+ * ```
  */
 class AWSSfnToolkit extends base_js_1.Toolkit {
     constructor(args) {

package/dist/agents/toolkits/aws_sfn.d.ts

@@ -23,6 +23,26 @@ export interface AWSSfnToolkitArgs {
  * Class representing a toolkit for interacting with AWS Step Functions.
  * It initializes the AWS Step Functions tools and provides them as tools
  * for the agent.
+ * @example
+ * ```typescript
+ *
+ * const toolkit = new AWSSfnToolkit({
+ *   name: "onboard-new-client-workflow",
+ *   description:
+ *     "Onboard new client workflow. Can also be used to get status of any executing workflow or state machine.",
+ *   stateMachineArn:
+ *     "arn:aws:states:us-east-1:1234567890:stateMachine:my-state-machine",
+ *   region: "<your Sfn's region>",
+ *   accessKeyId: "<your access key id>",
+ *   secretAccessKey: "<your secret access key>",
+ * });
+ *
+ *
+ * const result = await toolkit.invoke({
+ *   input: "Onboard john doe (john@example.com) as a new client.",
+ * });
+ *
+ * ```
  */
 export declare class AWSSfnToolkit extends Toolkit {
     tools: Tool[];

package/dist/agents/toolkits/aws_sfn.js

@@ -20,6 +20,26 @@ Thought: I should look at state machines within AWS Step Functions to see what a
  * Class representing a toolkit for interacting with AWS Step Functions.
  * It initializes the AWS Step Functions tools and provides them as tools
  * for the agent.
+ * @example
+ * ```typescript
+ *
+ * const toolkit = new AWSSfnToolkit({
+ *   name: "onboard-new-client-workflow",
+ *   description:
+ *     "Onboard new client workflow. Can also be used to get status of any executing workflow or state machine.",
+ *   stateMachineArn:
+ *     "arn:aws:states:us-east-1:1234567890:stateMachine:my-state-machine",
+ *   region: "<your Sfn's region>",
+ *   accessKeyId: "<your access key id>",
+ *   secretAccessKey: "<your secret access key>",
+ * });
+ *
+ *
+ * const result = await toolkit.invoke({
+ *   input: "Onboard john doe (john@example.com) as a new client.",
+ * });
+ *
+ * ```
  */
 export class AWSSfnToolkit extends Toolkit {
     constructor(args) {

package/dist/agents/toolkits/json/json.cjs

@@ -10,6 +10,14 @@ const executor_js_1 = require("../../executor.cjs");
 /**
  * Represents a toolkit for working with JSON data. It initializes the
  * JSON tools based on the provided JSON specification.
+ * @example
+ * ```typescript
+ * const toolkit = new JsonToolkit(new JsonSpec());
+ * const executor = createJsonAgent(model, toolkit);
+ * const result = await executor.invoke({
+ *   input: 'What are the required parameters in the request body to the /completions endpoint?'
+ * });
+ * ```
  */
 class JsonToolkit extends base_js_1.Toolkit {
     constructor(jsonSpec) {

package/dist/agents/toolkits/json/json.d.ts

@@ -7,6 +7,14 @@ import { AgentExecutor } from "../../executor.js";
 /**
  * Represents a toolkit for working with JSON data. It initializes the
  * JSON tools based on the provided JSON specification.
+ * @example
+ * ```typescript
+ * const toolkit = new JsonToolkit(new JsonSpec());
+ * const executor = createJsonAgent(model, toolkit);
+ * const result = await executor.invoke({
+ *   input: 'What are the required parameters in the request body to the /completions endpoint?'
+ * });
+ * ```
  */
 export declare class JsonToolkit extends Toolkit {
     jsonSpec: JsonSpec;

package/dist/agents/toolkits/json/json.js

@@ -7,6 +7,14 @@ import { AgentExecutor } from "../../executor.js";
 /**
  * Represents a toolkit for working with JSON data. It initializes the
  * JSON tools based on the provided JSON specification.
+ * @example
+ * ```typescript
+ * const toolkit = new JsonToolkit(new JsonSpec());
+ * const executor = createJsonAgent(model, toolkit);
+ * const result = await executor.invoke({
+ *   input: 'What are the required parameters in the request body to the /completions endpoint?'
+ * });
+ * ```
  */
 export class JsonToolkit extends Toolkit {
     constructor(jsonSpec) {

package/dist/agents/toolkits/openapi/openapi.cjs

@@ -31,6 +31,24 @@ exports.RequestsToolkit = RequestsToolkit;
  * exploring JSON data. It creates a JSON agent using the `JsonToolkit`
  * and the provided language model, and adds the JSON explorer tool to the
  * toolkit.
+ * @example
+ * ```typescript
+ * const toolkit = new OpenApiToolkit(
+ *   new JsonSpec({
+ *   }),
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   {
+ *     "Content-Type": "application/json",
+ *     Authorization: `Bearer ${process.env.OPENAI_API_KEY}`,
+ *   },
+ * );
+ *
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "Make a POST request to openai /completions. The prompt should be 'tell me a joke.'",
+ * });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 class OpenApiToolkit extends RequestsToolkit {
     constructor(jsonSpec, llm, headers) {

package/dist/agents/toolkits/openapi/openapi.d.ts

@@ -18,6 +18,24 @@ export declare class RequestsToolkit extends Toolkit {
  * exploring JSON data. It creates a JSON agent using the `JsonToolkit`
  * and the provided language model, and adds the JSON explorer tool to the
  * toolkit.
+ * @example
+ * ```typescript
+ * const toolkit = new OpenApiToolkit(
+ *   new JsonSpec({
+ *   }),
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   {
+ *     "Content-Type": "application/json",
+ *     Authorization: `Bearer ${process.env.OPENAI_API_KEY}`,
+ *   },
+ * );
+ *
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "Make a POST request to openai /completions. The prompt should be 'tell me a joke.'",
+ * });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 export declare class OpenApiToolkit extends RequestsToolkit {
     constructor(jsonSpec: JsonSpec, llm: BaseLanguageModel, headers?: Headers);

package/dist/agents/toolkits/openapi/openapi.js

@@ -27,6 +27,24 @@ export class RequestsToolkit extends Toolkit {
  * exploring JSON data. It creates a JSON agent using the `JsonToolkit`
  * and the provided language model, and adds the JSON explorer tool to the
  * toolkit.
+ * @example
+ * ```typescript
+ * const toolkit = new OpenApiToolkit(
+ *   new JsonSpec({
+ *   }),
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   {
+ *     "Content-Type": "application/json",
+ *     Authorization: `Bearer ${process.env.OPENAI_API_KEY}`,
+ *   },
+ * );
+ *
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "Make a POST request to openai /completions. The prompt should be 'tell me a joke.'",
+ * });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 export class OpenApiToolkit extends RequestsToolkit {
     constructor(jsonSpec, llm, headers) {

package/dist/agents/toolkits/sql/sql.cjs

@@ -11,6 +11,14 @@ const executor_js_1 = require("../../executor.cjs");
 /**
  * Class that represents a toolkit for working with SQL databases. It
  * initializes SQL tools based on the provided SQL database.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({});
+ * const toolkit = new SqlToolkit(sqlDb, model);
+ * const executor = createSqlAgent(model, toolkit);
+ * const result = await executor.invoke({ input: 'List the total sales per country. Which country's customers spent the most?' });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 class SqlToolkit extends base_js_1.Toolkit {
     constructor(db, llm) {

package/dist/agents/toolkits/sql/sql.d.ts

@@ -15,6 +15,14 @@ export interface SqlCreatePromptArgs extends ZeroShotCreatePromptArgs {
 /**
  * Class that represents a toolkit for working with SQL databases. It
  * initializes SQL tools based on the provided SQL database.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({});
+ * const toolkit = new SqlToolkit(sqlDb, model);
+ * const executor = createSqlAgent(model, toolkit);
+ * const result = await executor.invoke({ input: 'List the total sales per country. Which country's customers spent the most?' });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 export declare class SqlToolkit extends Toolkit {
     tools: Tool[];

package/dist/agents/toolkits/sql/sql.js

@@ -8,6 +8,14 @@ import { AgentExecutor } from "../../executor.js";
 /**
  * Class that represents a toolkit for working with SQL databases. It
  * initializes SQL tools based on the provided SQL database.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({});
+ * const toolkit = new SqlToolkit(sqlDb, model);
+ * const executor = createSqlAgent(model, toolkit);
+ * const result = await executor.invoke({ input: 'List the total sales per country. Which country's customers spent the most?' });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 export class SqlToolkit extends Toolkit {
     constructor(db, llm) {

package/dist/agents/toolkits/vectorstore/vectorstore.cjs

@@ -12,6 +12,22 @@ const executor_js_1 = require("../../executor.cjs");
  * Class representing a toolkit for working with a single vector store. It
  * initializes the vector store QA tool based on the provided vector store
  * information and language model.
+ * @example
+ * ```typescript
+ * const toolkit = new VectorStoreToolkit(
+ *   {
+ *     name: "state_of_union_address",
+ *     description: "the most recent state of the Union address",
+ *     vectorStore: new HNSWLib(),
+ *   },
+ *   new ChatOpenAI({ temperature: 0 }),
+ * );
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "What did biden say about Ketanji Brown Jackson in the state of the union address?",
+ * });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 class VectorStoreToolkit extends base_js_1.Toolkit {
     constructor(vectorStoreInfo, llm) {

package/dist/agents/toolkits/vectorstore/vectorstore.d.ts

@@ -17,6 +17,22 @@ export interface VectorStoreInfo {
  * Class representing a toolkit for working with a single vector store. It
  * initializes the vector store QA tool based on the provided vector store
  * information and language model.
+ * @example
+ * ```typescript
+ * const toolkit = new VectorStoreToolkit(
+ *   {
+ *     name: "state_of_union_address",
+ *     description: "the most recent state of the Union address",
+ *     vectorStore: new HNSWLib(),
+ *   },
+ *   new ChatOpenAI({ temperature: 0 }),
+ * );
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "What did biden say about Ketanji Brown Jackson in the state of the union address?",
+ * });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 export declare class VectorStoreToolkit extends Toolkit {
     tools: Tool[];

package/dist/agents/toolkits/vectorstore/vectorstore.js

@@ -9,6 +9,22 @@ import { AgentExecutor } from "../../executor.js";
  * Class representing a toolkit for working with a single vector store. It
  * initializes the vector store QA tool based on the provided vector store
  * information and language model.
+ * @example
+ * ```typescript
+ * const toolkit = new VectorStoreToolkit(
+ *   {
+ *     name: "state_of_union_address",
+ *     description: "the most recent state of the Union address",
+ *     vectorStore: new HNSWLib(),
+ *   },
+ *   new ChatOpenAI({ temperature: 0 }),
+ * );
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "What did biden say about Ketanji Brown Jackson in the state of the union address?",
+ * });
+ * console.log(`Got output ${result.output}`);
+ * ```
  */
 export class VectorStoreToolkit extends Toolkit {
     constructor(vectorStoreInfo, llm) {

package/dist/agents/toolkits/zapier/zapier.cjs

@@ -6,6 +6,16 @@ const zapier_js_1 = require("../../../tools/zapier.cjs");
 /**
  * Represents a toolkit for working with Zapier actions. It extends the
  * Toolkit class and provides functionality for managing Zapier tools.
+ * @example
+ * ```typescript
+ * const toolkit = await ZapierToolKit.fromZapierNLAWrapper(
+ *   new ZapierNLAWrapper(),
+ * );
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "Summarize the last email I received regarding Silicon Valley Bank. Send the summary to the #test-zapier Slack channel.",
+ * });
+ * ```
  */
 class ZapierToolKit extends base_js_1.Toolkit {
     constructor() {

package/dist/agents/toolkits/zapier/zapier.d.ts

@@ -4,6 +4,16 @@ import { ZapierNLAWrapper } from "../../../tools/zapier.js";
 /**
  * Represents a toolkit for working with Zapier actions. It extends the
  * Toolkit class and provides functionality for managing Zapier tools.
+ * @example
+ * ```typescript
+ * const toolkit = await ZapierToolKit.fromZapierNLAWrapper(
+ *   new ZapierNLAWrapper(),
+ * );
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "Summarize the last email I received regarding Silicon Valley Bank. Send the summary to the #test-zapier Slack channel.",
+ * });
+ * ```
  */
 export declare class ZapierToolKit extends Toolkit {
     tools: Tool[];

package/dist/agents/toolkits/zapier/zapier.js

@@ -3,6 +3,16 @@ import { ZapierNLARunAction } from "../../../tools/zapier.js";
 /**
  * Represents a toolkit for working with Zapier actions. It extends the
  * Toolkit class and provides functionality for managing Zapier tools.
+ * @example
+ * ```typescript
+ * const toolkit = await ZapierToolKit.fromZapierNLAWrapper(
+ *   new ZapierNLAWrapper(),
+ * );
+ * const result = await toolkit.invoke({
+ *   input:
+ *     "Summarize the last email I received regarding Silicon Valley Bank. Send the summary to the #test-zapier Slack channel.",
+ * });
+ * ```
  */
 export class ZapierToolKit extends Toolkit {
     constructor() {

package/dist/agents/xml/output_parser.cjs

@@ -3,6 +3,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.XMLAgentOutputParser = void 0;
 const output_parser_js_1 = require("../../schema/output_parser.cjs");
 const types_js_1 = require("../types.cjs");
+/**
+ * @example
+ * ```typescript
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   HumanMessagePromptTemplate.fromTemplate(AGENT_INSTRUCTIONS),
+ *   new MessagesPlaceholder("agent_scratchpad"),
+ * ]);
+ * const runnableAgent = RunnableSequence.from([
+ *   ...rest of runnable
+ *   prompt,
+ *   new ChatAnthropic({ modelName: "claude-2", temperature: 0 }).bind({
+ *     stop: ["</tool_input>", "</final_answer>"],
+ *   }),
+ *   new XMLAgentOutputParser(),
+ * ]);
+ * const result = await executor.invoke({
+ *   input: "What is the weather in Honolulu?",
+ *   tools: [],
+ * });
+ * ```
+ */
 class XMLAgentOutputParser extends types_js_1.AgentActionOutputParser {
     constructor() {
         super(...arguments);

package/dist/agents/xml/output_parser.d.ts

@@ -1,5 +1,26 @@
 import { AgentAction, AgentFinish } from "../../schema/index.js";
 import { AgentActionOutputParser } from "../types.js";
+/**
+ * @example
+ * ```typescript
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   HumanMessagePromptTemplate.fromTemplate(AGENT_INSTRUCTIONS),
+ *   new MessagesPlaceholder("agent_scratchpad"),
+ * ]);
+ * const runnableAgent = RunnableSequence.from([
+ *   ...rest of runnable
+ *   prompt,
+ *   new ChatAnthropic({ modelName: "claude-2", temperature: 0 }).bind({
+ *     stop: ["</tool_input>", "</final_answer>"],
+ *   }),
+ *   new XMLAgentOutputParser(),
+ * ]);
+ * const result = await executor.invoke({
+ *   input: "What is the weather in Honolulu?",
+ *   tools: [],
+ * });
+ * ```
+ */
 export declare class XMLAgentOutputParser extends AgentActionOutputParser {
     lc_namespace: string[];
     static lc_name(): string;

package/dist/agents/xml/output_parser.js

@@ -1,5 +1,26 @@
 import { OutputParserException } from "../../schema/output_parser.js";
 import { AgentActionOutputParser } from "../types.js";
+/**
+ * @example
+ * ```typescript
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   HumanMessagePromptTemplate.fromTemplate(AGENT_INSTRUCTIONS),
+ *   new MessagesPlaceholder("agent_scratchpad"),
+ * ]);
+ * const runnableAgent = RunnableSequence.from([
+ *   ...rest of runnable
+ *   prompt,
+ *   new ChatAnthropic({ modelName: "claude-2", temperature: 0 }).bind({
+ *     stop: ["</tool_input>", "</final_answer>"],
+ *   }),
+ *   new XMLAgentOutputParser(),
+ * ]);
+ * const result = await executor.invoke({
+ *   input: "What is the weather in Honolulu?",
+ *   tools: [],
+ * });
+ * ```
+ */
 export class XMLAgentOutputParser extends AgentActionOutputParser {
     constructor() {
         super(...arguments);

package/dist/cache/cloudflare_kv.cjs

@@ -7,6 +7,19 @@ const base_js_1 = require("./base.cjs");
  * Represents a specific implementation of a caching mechanism using Cloudflare KV
  * as the underlying storage system. It extends the `BaseCache` class and
  * overrides its methods to provide the Cloudflare KV-specific logic.
+ * @example
+ * ```typescript
+ * // Example of using OpenAI with Cloudflare KV as cache in a Cloudflare Worker
+ * const cache = new CloudflareKVCache(env.KV_NAMESPACE);
+ * const model = new ChatAnthropic({
+ *   cache,
+ * });
+ * const response = await model.invoke("How are you today?");
+ * return new Response(JSON.stringify(response), {
+ *   headers: { "content-type": "application/json" },
+ * });
+ *
+ * ```
  */
 class CloudflareKVCache extends index_js_1.BaseCache {
     constructor(binding) {

package/dist/cache/cloudflare_kv.d.ts

@@ -4,6 +4,19 @@ import { BaseCache, Generation } from "../schema/index.js";
  * Represents a specific implementation of a caching mechanism using Cloudflare KV
  * as the underlying storage system. It extends the `BaseCache` class and
  * overrides its methods to provide the Cloudflare KV-specific logic.
+ * @example
+ * ```typescript
+ * // Example of using OpenAI with Cloudflare KV as cache in a Cloudflare Worker
+ * const cache = new CloudflareKVCache(env.KV_NAMESPACE);
+ * const model = new ChatAnthropic({
+ *   cache,
+ * });
+ * const response = await model.invoke("How are you today?");
+ * return new Response(JSON.stringify(response), {
+ *   headers: { "content-type": "application/json" },
+ * });
+ *
+ * ```
  */
 export declare class CloudflareKVCache extends BaseCache {
     private binding;

package/dist/cache/cloudflare_kv.js

@@ -4,6 +4,19 @@ import { getCacheKey, serializeGeneration, deserializeStoredGeneration, } from "
  * Represents a specific implementation of a caching mechanism using Cloudflare KV
  * as the underlying storage system. It extends the `BaseCache` class and
  * overrides its methods to provide the Cloudflare KV-specific logic.
+ * @example
+ * ```typescript
+ * // Example of using OpenAI with Cloudflare KV as cache in a Cloudflare Worker
+ * const cache = new CloudflareKVCache(env.KV_NAMESPACE);
+ * const model = new ChatAnthropic({
+ *   cache,
+ * });
+ * const response = await model.invoke("How are you today?");
+ * return new Response(JSON.stringify(response), {
+ *   headers: { "content-type": "application/json" },
+ * });
+ *
+ * ```
  */
 export class CloudflareKVCache extends BaseCache {
     constructor(binding) {

package/dist/cache/ioredis.cjs

@@ -5,6 +5,19 @@ const index_js_1 = require("../schema/index.cjs");
 const base_js_1 = require("./base.cjs");
 /**
  * Cache LLM results using Redis.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({
+ *   cache: new RedisCache(new Redis(), { ttl: 60 }),
+ * });
+ *
+ * // Invoke the model with a prompt
+ * const response = await model.invoke("Do something random!");
+ * console.log(response);
+ *
+ * // Remember to disconnect the Redis client when done
+ * await redisClient.disconnect();
+ * ```
  */
 class RedisCache extends index_js_1.BaseCache {
     constructor(redisClient, config) {

package/dist/cache/ioredis.d.ts

@@ -2,6 +2,19 @@ import { Redis } from "ioredis";
 import { BaseCache, Generation } from "../schema/index.js";
 /**
  * Cache LLM results using Redis.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({
+ *   cache: new RedisCache(new Redis(), { ttl: 60 }),
+ * });
+ *
+ * // Invoke the model with a prompt
+ * const response = await model.invoke("Do something random!");
+ * console.log(response);
+ *
+ * // Remember to disconnect the Redis client when done
+ * await redisClient.disconnect();
+ * ```
  */
 export declare class RedisCache extends BaseCache {
     protected redisClient: Redis;

package/dist/cache/ioredis.js

@@ -2,6 +2,19 @@ import { BaseCache } from "../schema/index.js";
 import { serializeGeneration, deserializeStoredGeneration, getCacheKey, } from "./base.js";
 /**
  * Cache LLM results using Redis.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({
+ *   cache: new RedisCache(new Redis(), { ttl: 60 }),
+ * });
+ *
+ * // Invoke the model with a prompt
+ * const response = await model.invoke("Do something random!");
+ * console.log(response);
+ *
+ * // Remember to disconnect the Redis client when done
+ * await redisClient.disconnect();
+ * ```
  */
 export class RedisCache extends BaseCache {
     constructor(redisClient, config) {

package/dist/cache/momento.cjs

@@ -9,6 +9,25 @@ const momento_js_1 = require("../util/momento.cjs");
 /**
  * A cache that uses Momento as the backing store.
  * See https://gomomento.com.
+ * @example
+ * ```typescript
+ * const cache = new MomentoCache({
+ *   client: new CacheClient({
+ *     configuration: Configurations.Laptop.v1(),
+ *     credentialProvider: CredentialProvider.fromEnvironmentVariable({
+ *       environmentVariableName: "MOMENTO_API_KEY",
+ *     }),
+ *     defaultTtlSeconds: 60 * 60 * 24, // Cache TTL set to 24 hours.
+ *   }),
+ *   cacheName: "langchain",
+ * });
+ * // Initialize the OpenAI model with Momento cache for caching responses
+ * const model = new ChatOpenAI({
+ *   cache,
+ * });
+ * await model.invoke("How are you today?");
+ * const cachedValues = await cache.lookup("How are you today?", "llmKey");
+ * ```
  */
 class MomentoCache extends index_js_1.BaseCache {
     constructor(props) {