langchain 0.0.192 → 0.0.194

package/dist/chains/conversation.cjs

@@ -13,6 +13,19 @@ AI:`;
 /**
  * A class for conducting conversations between a human and an AI. It
  * extends the {@link LLMChain} class.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({});
+ * const chain = new ConversationChain({ llm: model });
+ *
+ * // Sending a greeting to the conversation chain
+ * const res1 = await chain.call({ input: "Hi! I'm Jim." });
+ * console.log({ res1 });
+ *
+ * // Following up with a question in the conversation
+ * const res2 = await chain.call({ input: "What's my name?" });
+ * console.log({ res2 });
+ * ```
  */
 class ConversationChain extends llm_chain_js_1.LLMChain {
     static lc_name() {

package/dist/chains/conversation.d.ts

@@ -4,6 +4,19 @@ export declare const DEFAULT_TEMPLATE = "The following is a friendly conversatio
 /**
  * A class for conducting conversations between a human and an AI. It
  * extends the {@link LLMChain} class.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({});
+ * const chain = new ConversationChain({ llm: model });
+ *
+ * // Sending a greeting to the conversation chain
+ * const res1 = await chain.call({ input: "Hi! I'm Jim." });
+ * console.log({ res1 });
+ *
+ * // Following up with a question in the conversation
+ * const res2 = await chain.call({ input: "What's my name?" });
+ * console.log({ res2 });
+ * ```
  */
 export declare class ConversationChain extends LLMChain {
     static lc_name(): string;

package/dist/chains/conversation.js

@@ -10,6 +10,19 @@ AI:`;
 /**
  * A class for conducting conversations between a human and an AI. It
  * extends the {@link LLMChain} class.
+ * @example
+ * ```typescript
+ * const model = new ChatOpenAI({});
+ * const chain = new ConversationChain({ llm: model });
+ *
+ * // Sending a greeting to the conversation chain
+ * const res1 = await chain.call({ input: "Hi! I'm Jim." });
+ * console.log({ res1 });
+ *
+ * // Following up with a question in the conversation
+ * const res2 = await chain.call({ input: "What's my name?" });
+ * console.log({ res2 });
+ * ```
  */
 export class ConversationChain extends LLMChain {
     static lc_name() {

package/dist/chains/conversational_retrieval_chain.cjs

@@ -16,6 +16,35 @@ Standalone question:`;
  * Class for conducting conversational question-answering tasks with a
  * retrieval component. Extends the BaseChain class and implements the
  * ConversationalRetrievalQAChainInput interface.
+ * @example
+ * ```typescript
+ * const model = new ChatAnthropic({});
+ *
+ * const text = fs.readFileSync("state_of_the_union.txt", "utf8");
+ *
+ * const textSplitter = new RecursiveCharacterTextSplitter({ chunkSize: 1000 });
+ * const docs = await textSplitter.createDocuments([text]);
+ *
+ * const vectorStore = await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings());
+ *
+ * const chain = ConversationalRetrievalQAChain.fromLLM(
+ *   model,
+ *   vectorStore.asRetriever(),
+ * );
+ *
+ * const question = "What did the president say about Justice Breyer?";
+ *
+ * const res = await chain.call({ question, chat_history: "" });
+ * console.log(res);
+ *
+ * const chatHistory = `${question}\n${res.text}`;
+ * const followUpRes = await chain.call({
+ *   question: "Was that nice?",
+ *   chat_history: chatHistory,
+ * });
+ * console.log(followUpRes);
+ *
+ * ```
  */
 class ConversationalRetrievalQAChain extends base_js_1.BaseChain {
     static lc_name() {

package/dist/chains/conversational_retrieval_chain.d.ts

@@ -22,6 +22,35 @@ export interface ConversationalRetrievalQAChainInput extends ChainInputs {
  * Class for conducting conversational question-answering tasks with a
  * retrieval component. Extends the BaseChain class and implements the
  * ConversationalRetrievalQAChainInput interface.
+ * @example
+ * ```typescript
+ * const model = new ChatAnthropic({});
+ *
+ * const text = fs.readFileSync("state_of_the_union.txt", "utf8");
+ *
+ * const textSplitter = new RecursiveCharacterTextSplitter({ chunkSize: 1000 });
+ * const docs = await textSplitter.createDocuments([text]);
+ *
+ * const vectorStore = await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings());
+ *
+ * const chain = ConversationalRetrievalQAChain.fromLLM(
+ *   model,
+ *   vectorStore.asRetriever(),
+ * );
+ *
+ * const question = "What did the president say about Justice Breyer?";
+ *
+ * const res = await chain.call({ question, chat_history: "" });
+ * console.log(res);
+ *
+ * const chatHistory = `${question}\n${res.text}`;
+ * const followUpRes = await chain.call({
+ *   question: "Was that nice?",
+ *   chat_history: chatHistory,
+ * });
+ * console.log(followUpRes);
+ *
+ * ```
  */
 export declare class ConversationalRetrievalQAChain extends BaseChain implements ConversationalRetrievalQAChainInput {
     static lc_name(): string;

package/dist/chains/conversational_retrieval_chain.js

@@ -13,6 +13,35 @@ Standalone question:`;
  * Class for conducting conversational question-answering tasks with a
  * retrieval component. Extends the BaseChain class and implements the
  * ConversationalRetrievalQAChainInput interface.
+ * @example
+ * ```typescript
+ * const model = new ChatAnthropic({});
+ *
+ * const text = fs.readFileSync("state_of_the_union.txt", "utf8");
+ *
+ * const textSplitter = new RecursiveCharacterTextSplitter({ chunkSize: 1000 });
+ * const docs = await textSplitter.createDocuments([text]);
+ *
+ * const vectorStore = await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings());
+ *
+ * const chain = ConversationalRetrievalQAChain.fromLLM(
+ *   model,
+ *   vectorStore.asRetriever(),
+ * );
+ *
+ * const question = "What did the president say about Justice Breyer?";
+ *
+ * const res = await chain.call({ question, chat_history: "" });
+ * console.log(res);
+ *
+ * const chatHistory = `${question}\n${res.text}`;
+ * const followUpRes = await chain.call({
+ *   question: "Was that nice?",
+ *   chat_history: chatHistory,
+ * });
+ * console.log(followUpRes);
+ *
+ * ```
  */
 export class ConversationalRetrievalQAChain extends BaseChain {
     static lc_name() {

package/dist/chains/graph_qa/cypher.cjs

@@ -5,6 +5,16 @@ const llm_chain_js_1 = require("../../chains/llm_chain.cjs");
 const base_js_1 = require("../base.cjs");
 const prompts_js_1 = require("./prompts.cjs");
 exports.INTERMEDIATE_STEPS_KEY = "intermediateSteps";
+/**
+ * @example
+ * ```typescript
+ * const chain = new GraphCypherQAChain({
+ *   llm: new ChatOpenAI({ temperature: 0 }),
+ *   graph: new Neo4jGraph(),
+ * });
+ * const res = await chain.run("Who played in Pulp Fiction?");
+ * ```
+ */
 class GraphCypherQAChain extends base_js_1.BaseChain {
     constructor(props) {
         super(props);

package/dist/chains/graph_qa/cypher.d.ts

@@ -26,6 +26,16 @@ export interface FromLLMInput {
     returnIntermediateSteps?: boolean;
     returnDirect?: boolean;
 }
+/**
+ * @example
+ * ```typescript
+ * const chain = new GraphCypherQAChain({
+ *   llm: new ChatOpenAI({ temperature: 0 }),
+ *   graph: new Neo4jGraph(),
+ * });
+ * const res = await chain.run("Who played in Pulp Fiction?");
+ * ```
+ */
 export declare class GraphCypherQAChain extends BaseChain {
     private graph;
     private cypherGenerationChain;

package/dist/chains/graph_qa/cypher.js

@@ -2,6 +2,16 @@ import { LLMChain } from "../../chains/llm_chain.js";
 import { BaseChain } from "../base.js";
 import { CYPHER_GENERATION_PROMPT, CYPHER_QA_PROMPT } from "./prompts.js";
 export const INTERMEDIATE_STEPS_KEY = "intermediateSteps";
+/**
+ * @example
+ * ```typescript
+ * const chain = new GraphCypherQAChain({
+ *   llm: new ChatOpenAI({ temperature: 0 }),
+ *   graph: new Neo4jGraph(),
+ * });
+ * const res = await chain.run("Who played in Pulp Fiction?");
+ * ```
+ */
 export class GraphCypherQAChain extends BaseChain {
     constructor(props) {
         super(props);

package/dist/chains/openai_moderation.cjs

@@ -9,6 +9,34 @@ const env_js_1 = require("../util/env.cjs");
  * Class representing a chain for moderating text using the OpenAI
  * Moderation API. It extends the BaseChain class and implements the
  * OpenAIModerationChainInput interface.
+ * @example
+ * ```typescript
+ * const moderation = new ChatOpenAIModerationChain({ throwError: true });
+ *
+ * const badString = "Bad naughty words from user";
+ *
+ * try {
+ *   const { output: moderatedContent, results } = await moderation.call({
+ *     input: badString,
+ *   });
+ *
+ *   if (results[0].category_scores["harassment/threatening"] > 0.01) {
+ *     throw new Error("Harassment detected!");
+ *   }
+ *
+ *   const model = new OpenAI({ temperature: 0 });
+ *   const promptTemplate = "Hello, how are you today {person}?";
+ *   const prompt = new PromptTemplate({
+ *     template: promptTemplate,
+ *     inputVariables: ["person"],
+ *   });
+ *   const chain = new LLMChain({ llm: model, prompt });
+ *   const response = await chain.call({ person: moderatedContent });
+ *   console.log({ response });
+ * } catch (error) {
+ *   console.error("Naughty words detected!");
+ * }
+ * ```
  */
 class OpenAIModerationChain extends base_js_1.BaseChain {
     static lc_name() {

package/dist/chains/openai_moderation.d.ts

@@ -15,6 +15,34 @@ export interface OpenAIModerationChainInput extends ChainInputs, AsyncCallerPara
  * Class representing a chain for moderating text using the OpenAI
  * Moderation API. It extends the BaseChain class and implements the
  * OpenAIModerationChainInput interface.
+ * @example
+ * ```typescript
+ * const moderation = new ChatOpenAIModerationChain({ throwError: true });
+ *
+ * const badString = "Bad naughty words from user";
+ *
+ * try {
+ *   const { output: moderatedContent, results } = await moderation.call({
+ *     input: badString,
+ *   });
+ *
+ *   if (results[0].category_scores["harassment/threatening"] > 0.01) {
+ *     throw new Error("Harassment detected!");
+ *   }
+ *
+ *   const model = new OpenAI({ temperature: 0 });
+ *   const promptTemplate = "Hello, how are you today {person}?";
+ *   const prompt = new PromptTemplate({
+ *     template: promptTemplate,
+ *     inputVariables: ["person"],
+ *   });
+ *   const chain = new LLMChain({ llm: model, prompt });
+ *   const response = await chain.call({ person: moderatedContent });
+ *   console.log({ response });
+ * } catch (error) {
+ *   console.error("Naughty words detected!");
+ * }
+ * ```
  */
 export declare class OpenAIModerationChain extends BaseChain implements OpenAIModerationChainInput {
     static lc_name(): string;

package/dist/chains/openai_moderation.js

@@ -6,6 +6,34 @@ import { getEnvironmentVariable } from "../util/env.js";
  * Class representing a chain for moderating text using the OpenAI
  * Moderation API. It extends the BaseChain class and implements the
  * OpenAIModerationChainInput interface.
+ * @example
+ * ```typescript
+ * const moderation = new ChatOpenAIModerationChain({ throwError: true });
+ *
+ * const badString = "Bad naughty words from user";
+ *
+ * try {
+ *   const { output: moderatedContent, results } = await moderation.call({
+ *     input: badString,
+ *   });
+ *
+ *   if (results[0].category_scores["harassment/threatening"] > 0.01) {
+ *     throw new Error("Harassment detected!");
+ *   }
+ *
+ *   const model = new OpenAI({ temperature: 0 });
+ *   const promptTemplate = "Hello, how are you today {person}?";
+ *   const prompt = new PromptTemplate({
+ *     template: promptTemplate,
+ *     inputVariables: ["person"],
+ *   });
+ *   const chain = new LLMChain({ llm: model, prompt });
+ *   const response = await chain.call({ person: moderatedContent });
+ *   console.log({ response });
+ * } catch (error) {
+ *   console.error("Naughty words detected!");
+ * }
+ * ```
  */
 export class OpenAIModerationChain extends BaseChain {
     static lc_name() {

package/dist/chains/retrieval_qa.cjs

@@ -6,6 +6,27 @@ const load_js_1 = require("./question_answering/load.cjs");
 /**
  * Class representing a chain for performing question-answering tasks with
  * a retrieval component.
+ * @example
+ * ```typescript
+ * // Initialize the OpenAI model and the remote retriever with the specified configuration
+ * const model = new ChatOpenAI({});
+ * const retriever = new RemoteLangChainRetriever({
+ *   url: "http://example.com/api",
+ *   auth: { bearer: "foo" },
+ *   inputKey: "message",
+ *   responseKey: "response",
+ * });
+ *
+ * // Create a RetrievalQAChain using the model and retriever
+ * const chain = RetrievalQAChain.fromLLM(model, retriever);
+ *
+ * // Execute the chain with a query and log the result
+ * const res = await chain.call({
+ *   query: "What did the president say about Justice Breyer?",
+ * });
+ * console.log({ res });
+ *
+ * ```
  */
 class RetrievalQAChain extends base_js_1.BaseChain {
     static lc_name() {

package/dist/chains/retrieval_qa.d.ts

@@ -18,6 +18,27 @@ export interface RetrievalQAChainInput extends Omit<ChainInputs, "memory"> {
 /**
  * Class representing a chain for performing question-answering tasks with
  * a retrieval component.
+ * @example
+ * ```typescript
+ * // Initialize the OpenAI model and the remote retriever with the specified configuration
+ * const model = new ChatOpenAI({});
+ * const retriever = new RemoteLangChainRetriever({
+ *   url: "http://example.com/api",
+ *   auth: { bearer: "foo" },
+ *   inputKey: "message",
+ *   responseKey: "response",
+ * });
+ *
+ * // Create a RetrievalQAChain using the model and retriever
+ * const chain = RetrievalQAChain.fromLLM(model, retriever);
+ *
+ * // Execute the chain with a query and log the result
+ * const res = await chain.call({
+ *   query: "What did the president say about Justice Breyer?",
+ * });
+ * console.log({ res });
+ *
+ * ```
  */
 export declare class RetrievalQAChain extends BaseChain implements RetrievalQAChainInput {
     static lc_name(): string;

package/dist/chains/retrieval_qa.js

@@ -3,6 +3,27 @@ import { loadQAStuffChain, } from "./question_answering/load.js";
 /**
  * Class representing a chain for performing question-answering tasks with
  * a retrieval component.
+ * @example
+ * ```typescript
+ * // Initialize the OpenAI model and the remote retriever with the specified configuration
+ * const model = new ChatOpenAI({});
+ * const retriever = new RemoteLangChainRetriever({
+ *   url: "http://example.com/api",
+ *   auth: { bearer: "foo" },
+ *   inputKey: "message",
+ *   responseKey: "response",
+ * });
+ *
+ * // Create a RetrievalQAChain using the model and retriever
+ * const chain = RetrievalQAChain.fromLLM(model, retriever);
+ *
+ * // Execute the chain with a query and log the result
+ * const res = await chain.call({
+ *   query: "What did the president say about Justice Breyer?",
+ * });
+ * console.log({ res });
+ *
+ * ```
  */
 export class RetrievalQAChain extends BaseChain {
     static lc_name() {

package/dist/chains/router/multi_prompt.cjs

@@ -15,6 +15,25 @@ const router_js_1 = require("../../output_parsers/router.cjs");
  * A class that represents a multi-prompt chain in the LangChain
  * framework. It extends the MultiRouteChain class and provides additional
  * functionality specific to multi-prompt chains.
+ * @example
+ * ```typescript
+ * const multiPromptChain = MultiPromptChain.fromLLMAndPrompts(new ChatOpenAI(), {
+ *   promptNames: ["physics", "math", "history"],
+ *   promptDescriptions: [
+ *     "Good for answering questions about physics",
+ *     "Good for answering math questions",
+ *     "Good for answering questions about history",
+ *   ],
+ *   promptTemplates: [
+ *     `You are a very smart physics professor. Here is a question:\n{input}\n`,
+ *     `You are a very good mathematician. Here is a question:\n{input}\n`,
+ *     `You are a very smart history professor. Here is a question:\n{input}\n`,
+ *   ],
+ * });
+ * const result = await multiPromptChain.call({
+ *   input: "What is the speed of light?",
+ * });
+ * ```
  */
 class MultiPromptChain extends multi_route_js_1.MultiRouteChain {
     /**

package/dist/chains/router/multi_prompt.d.ts

@@ -7,6 +7,25 @@ import { PromptTemplate } from "../../prompts/prompt.js";
  * A class that represents a multi-prompt chain in the LangChain
  * framework. It extends the MultiRouteChain class and provides additional
  * functionality specific to multi-prompt chains.
+ * @example
+ * ```typescript
+ * const multiPromptChain = MultiPromptChain.fromLLMAndPrompts(new ChatOpenAI(), {
+ *   promptNames: ["physics", "math", "history"],
+ *   promptDescriptions: [
+ *     "Good for answering questions about physics",
+ *     "Good for answering math questions",
+ *     "Good for answering questions about history",
+ *   ],
+ *   promptTemplates: [
+ *     `You are a very smart physics professor. Here is a question:\n{input}\n`,
+ *     `You are a very good mathematician. Here is a question:\n{input}\n`,
+ *     `You are a very smart history professor. Here is a question:\n{input}\n`,
+ *   ],
+ * });
+ * const result = await multiPromptChain.call({
+ *   input: "What is the speed of light?",
+ * });
+ * ```
  */
 export declare class MultiPromptChain extends MultiRouteChain {
     /**

package/dist/chains/router/multi_prompt.js

@@ -12,6 +12,25 @@ import { RouterOutputParser } from "../../output_parsers/router.js";
  * A class that represents a multi-prompt chain in the LangChain
  * framework. It extends the MultiRouteChain class and provides additional
  * functionality specific to multi-prompt chains.
+ * @example
+ * ```typescript
+ * const multiPromptChain = MultiPromptChain.fromLLMAndPrompts(new ChatOpenAI(), {
+ *   promptNames: ["physics", "math", "history"],
+ *   promptDescriptions: [
+ *     "Good for answering questions about physics",
+ *     "Good for answering math questions",
+ *     "Good for answering questions about history",
+ *   ],
+ *   promptTemplates: [
+ *     `You are a very smart physics professor. Here is a question:\n{input}\n`,
+ *     `You are a very good mathematician. Here is a question:\n{input}\n`,
+ *     `You are a very smart history professor. Here is a question:\n{input}\n`,
+ *   ],
+ * });
+ * const result = await multiPromptChain.call({
+ *   input: "What is the speed of light?",
+ * });
+ * ```
  */
 export class MultiPromptChain extends MultiRouteChain {
     /**

package/dist/chains/router/multi_retrieval_qa.cjs

@@ -16,6 +16,35 @@ const router_js_1 = require("../../output_parsers/router.cjs");
  * the LangChain framework. It extends the MultiRouteChain class and
  * provides additional functionality specific to multi-retrieval QA
  * chains.
+ * @example
+ * ```typescript
+ * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
+ *   new ChatOpenAI(),
+ *   {
+ *     retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
+ *     retrieverDescriptions: [
+ *       "Good for answering questions about Aqua Teen Hunger Force theme song",
+ *       "Good for answering questions about Mystery Science Theater 3000 theme song",
+ *       "Good for answering questions about Animaniacs theme song",
+ *     ],
+ *     retrievers: [
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *     ],
+ *     retrievalQAChainOpts: {
+ *       returnSourceDocuments: true,
+ *     },
+ *   },
+ * );
+ *
+ * const result = await multiRetrievalQAChain.call({
+ *   input:
+ *     "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
+ * });
+ *
+ * console.log(result.sourceDocuments, result.text);
+ * ```
  */
 class MultiRetrievalQAChain extends multi_route_js_1.MultiRouteChain {
     get outputKeys() {

package/dist/chains/router/multi_retrieval_qa.d.ts

@@ -19,6 +19,35 @@ export type MultiRetrievalDefaults = {
  * the LangChain framework. It extends the MultiRouteChain class and
  * provides additional functionality specific to multi-retrieval QA
  * chains.
+ * @example
+ * ```typescript
+ * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
+ *   new ChatOpenAI(),
+ *   {
+ *     retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
+ *     retrieverDescriptions: [
+ *       "Good for answering questions about Aqua Teen Hunger Force theme song",
+ *       "Good for answering questions about Mystery Science Theater 3000 theme song",
+ *       "Good for answering questions about Animaniacs theme song",
+ *     ],
+ *     retrievers: [
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *     ],
+ *     retrievalQAChainOpts: {
+ *       returnSourceDocuments: true,
+ *     },
+ *   },
+ * );
+ *
+ * const result = await multiRetrievalQAChain.call({
+ *   input:
+ *     "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
+ * });
+ *
+ * console.log(result.sourceDocuments, result.text);
+ * ```
  */
 export declare class MultiRetrievalQAChain extends MultiRouteChain {
     get outputKeys(): string[];

package/dist/chains/router/multi_retrieval_qa.js

@@ -13,6 +13,35 @@ import { RouterOutputParser } from "../../output_parsers/router.js";
  * the LangChain framework. It extends the MultiRouteChain class and
  * provides additional functionality specific to multi-retrieval QA
  * chains.
+ * @example
+ * ```typescript
+ * const multiRetrievalQAChain = MultiRetrievalQAChain.fromLLMAndRetrievers(
+ *   new ChatOpenAI(),
+ *   {
+ *     retrieverNames: ["aqua teen", "mst3k", "animaniacs"],
+ *     retrieverDescriptions: [
+ *       "Good for answering questions about Aqua Teen Hunger Force theme song",
+ *       "Good for answering questions about Mystery Science Theater 3000 theme song",
+ *       "Good for answering questions about Animaniacs theme song",
+ *     ],
+ *     retrievers: [
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *       new MemoryVectorStore().asRetriever(3),
+ *     ],
+ *     retrievalQAChainOpts: {
+ *       returnSourceDocuments: true,
+ *     },
+ *   },
+ * );
+ *
+ * const result = await multiRetrievalQAChain.call({
+ *   input:
+ *     "In the Aqua Teen Hunger Force theme song, who calls himself the mike rula?",
+ * });
+ *
+ * console.log(result.sourceDocuments, result.text);
+ * ```
  */
 export class MultiRetrievalQAChain extends MultiRouteChain {
     get outputKeys() {

package/dist/chains/sequential_chain.cjs

@@ -10,6 +10,49 @@ function formatSet(input) {
 }
 /**
  * Chain where the outputs of one chain feed directly into next.
+ * @example
+ * ```typescript
+ * const promptTemplate = new PromptTemplate({
+ *   template: `You are a playwright. Given the title of play and the era it is set in, it is your job to write a synopsis for that title.
+ * Title: {title}
+ * Era: {era}
+ * Playwright: This is a synopsis for the above play:`,
+ *   inputVariables: ["title", "era"],
+ * });
+
+ * const reviewPromptTemplate = new PromptTemplate({
+ *   template: `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.
+ *
+ *     Play Synopsis:
+ *     {synopsis}
+ *     Review from a New York Times play critic of the above play:`,
+ *   inputVariables: ["synopsis"],
+ * });
+
+ * const overallChain = new SequentialChain({
+ *   chains: [
+ *     new LLMChain({
+ *       llm: new ChatOpenAI({ temperature: 0 }),
+ *       prompt: promptTemplate,
+ *       outputKey: "synopsis",
+ *     }),
+ *     new LLMChain({
+ *       llm: new OpenAI({ temperature: 0 }),
+ *       prompt: reviewPromptTemplate,
+ *       outputKey: "review",
+ *     }),
+ *   ],
+ *   inputVariables: ["era", "title"],
+ *   outputVariables: ["synopsis", "review"],
+ *   verbose: true,
+ * });
+
+ * const chainExecutionResult = await overallChain.call({
+ *   title: "Tragedy at sunset on the beach",
+ *   era: "Victorian England",
+ * });
+ * console.log(chainExecutionResult);
+ * ```
  */
 class SequentialChain extends base_js_1.BaseChain {
     static lc_name() {