langchain 0.0.71 → 0.0.73

package/dist/chains/router/multi_retrieval_qa.cjs

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiRetrievalQAChain = void 0;
+const zod_1 = require("zod");
+const multi_route_js_1 = require("./multi_route.cjs");
+const template_js_1 = require("../../prompts/template.cjs");
+const prompt_js_1 = require("../../prompts/prompt.cjs");
+const llm_router_js_1 = require("./llm_router.cjs");
+const conversation_js_1 = require("../../chains/conversation.cjs");
+const multi_retrieval_prompt_js_1 = require("./multi_retrieval_prompt.cjs");
+const utils_js_1 = require("./utils.cjs");
+const retrieval_qa_js_1 = require("../../chains/retrieval_qa.cjs");
+const router_js_1 = require("../../output_parsers/router.cjs");
+class MultiRetrievalQAChain extends multi_route_js_1.MultiRouteChain {
+    get outputKeys() {
+        return ["result"];
+    }
+    static fromRetrievers(llm, retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, options) {
+        const { defaultRetriever, defaultPrompt, defaultChain } = defaults ?? {};
+        if (defaultPrompt && !defaultRetriever) {
+            throw new Error("`default_retriever` must be specified if `default_prompt` is \nprovided. Received only `default_prompt`.");
+        }
+        const destinations = (0, utils_js_1.zipEntries)(retrieverNames, retrieverDescriptions).map(([name, desc]) => `${name}: ${desc}`);
+        const structuredOutputParserSchema = zod_1.z.object({
+            destination: zod_1.z
+                .string()
+                .optional()
+                .describe('name of the question answering system to use or "DEFAULT"'),
+            next_inputs: zod_1.z
+                .object({
+                query: zod_1.z
+                    .string()
+                    .describe("a potentially modified version of the original input"),
+            })
+                .describe("input to be fed to the next model"),
+        });
+        const outputParser = new router_js_1.RouterOutputParser(structuredOutputParserSchema);
+        const destinationsStr = destinations.join("\n");
+        const routerTemplate = (0, template_js_1.interpolateFString)((0, multi_retrieval_prompt_js_1.STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE)(outputParser.getFormatInstructions({ interpolationDepth: 4 })), {
+            destinations: destinationsStr,
+        });
+        const routerPrompt = new prompt_js_1.PromptTemplate({
+            template: routerTemplate,
+            inputVariables: ["input"],
+            outputParser,
+        });
+        const routerChain = llm_router_js_1.LLMRouterChain.fromLLM(llm, routerPrompt);
+        const prompts = retrieverPrompts ?? retrievers.map(() => null);
+        const destinationChains = (0, utils_js_1.zipEntries)(retrieverNames, retrievers, prompts).reduce((acc, [name, retriever, prompt]) => {
+            let opt;
+            if (prompt) {
+                opt = { prompt };
+            }
+            acc[name] = retrieval_qa_js_1.RetrievalQAChain.fromLLM(llm, retriever, opt);
+            return acc;
+        }, {});
+        let _defaultChain;
+        if (defaultChain) {
+            _defaultChain = defaultChain;
+        }
+        else if (defaultRetriever) {
+            _defaultChain = retrieval_qa_js_1.RetrievalQAChain.fromLLM(llm, defaultRetriever, {
+                prompt: defaultPrompt,
+            });
+        }
+        else {
+            const promptTemplate = conversation_js_1.DEFAULT_TEMPLATE.replace("input", "query");
+            const prompt = new prompt_js_1.PromptTemplate({
+                template: promptTemplate,
+                inputVariables: ["history", "query"],
+            });
+            _defaultChain = new conversation_js_1.ConversationChain({
+                llm,
+                prompt,
+                outputKey: "result",
+            });
+        }
+        return new MultiRetrievalQAChain({
+            routerChain,
+            destinationChains,
+            defaultChain: _defaultChain,
+            ...options,
+        });
+    }
+    _chainType() {
+        return "multi_retrieval_qa_chain";
+    }
+}
+exports.MultiRetrievalQAChain = MultiRetrievalQAChain;

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

@@ -0,0 +1,15 @@
+import { BaseLanguageModel } from "../../base_language/index.js";
+import { MultiRouteChain, MultiRouteChainInput } from "./multi_route.js";
+import { BaseChain } from "../../chains/base.js";
+import { PromptTemplate } from "../../prompts/prompt.js";
+import { BaseRetriever } from "../../schema/index.js";
+export type MultiRetrievalDefaults = {
+    defaultRetriever?: BaseRetriever;
+    defaultPrompt?: PromptTemplate;
+    defaultChain?: BaseChain;
+};
+export declare class MultiRetrievalQAChain extends MultiRouteChain {
+    get outputKeys(): string[];
+    static fromRetrievers(llm: BaseLanguageModel, retrieverNames: string[], retrieverDescriptions: string[], retrievers: BaseRetriever[], retrieverPrompts?: PromptTemplate[], defaults?: MultiRetrievalDefaults, options?: Omit<MultiRouteChainInput, "defaultChain">): MultiRetrievalQAChain;
+    _chainType(): string;
+}

package/dist/chains/router/multi_retrieval_qa.js

@@ -0,0 +1,85 @@
+import { z } from "zod";
+import { MultiRouteChain } from "./multi_route.js";
+import { interpolateFString } from "../../prompts/template.js";
+import { PromptTemplate } from "../../prompts/prompt.js";
+import { LLMRouterChain } from "./llm_router.js";
+import { ConversationChain, DEFAULT_TEMPLATE, } from "../../chains/conversation.js";
+import { STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE } from "./multi_retrieval_prompt.js";
+import { zipEntries } from "./utils.js";
+import { RetrievalQAChain } from "../../chains/retrieval_qa.js";
+import { RouterOutputParser } from "../../output_parsers/router.js";
+export class MultiRetrievalQAChain extends MultiRouteChain {
+    get outputKeys() {
+        return ["result"];
+    }
+    static fromRetrievers(llm, retrieverNames, retrieverDescriptions, retrievers, retrieverPrompts, defaults, options) {
+        const { defaultRetriever, defaultPrompt, defaultChain } = defaults ?? {};
+        if (defaultPrompt && !defaultRetriever) {
+            throw new Error("`default_retriever` must be specified if `default_prompt` is \nprovided. Received only `default_prompt`.");
+        }
+        const destinations = zipEntries(retrieverNames, retrieverDescriptions).map(([name, desc]) => `${name}: ${desc}`);
+        const structuredOutputParserSchema = z.object({
+            destination: z
+                .string()
+                .optional()
+                .describe('name of the question answering system to use or "DEFAULT"'),
+            next_inputs: z
+                .object({
+                query: z
+                    .string()
+                    .describe("a potentially modified version of the original input"),
+            })
+                .describe("input to be fed to the next model"),
+        });
+        const outputParser = new RouterOutputParser(structuredOutputParserSchema);
+        const destinationsStr = destinations.join("\n");
+        const routerTemplate = interpolateFString(STRUCTURED_MULTI_RETRIEVAL_ROUTER_TEMPLATE(outputParser.getFormatInstructions({ interpolationDepth: 4 })), {
+            destinations: destinationsStr,
+        });
+        const routerPrompt = new PromptTemplate({
+            template: routerTemplate,
+            inputVariables: ["input"],
+            outputParser,
+        });
+        const routerChain = LLMRouterChain.fromLLM(llm, routerPrompt);
+        const prompts = retrieverPrompts ?? retrievers.map(() => null);
+        const destinationChains = zipEntries(retrieverNames, retrievers, prompts).reduce((acc, [name, retriever, prompt]) => {
+            let opt;
+            if (prompt) {
+                opt = { prompt };
+            }
+            acc[name] = RetrievalQAChain.fromLLM(llm, retriever, opt);
+            return acc;
+        }, {});
+        let _defaultChain;
+        if (defaultChain) {
+            _defaultChain = defaultChain;
+        }
+        else if (defaultRetriever) {
+            _defaultChain = RetrievalQAChain.fromLLM(llm, defaultRetriever, {
+                prompt: defaultPrompt,
+            });
+        }
+        else {
+            const promptTemplate = DEFAULT_TEMPLATE.replace("input", "query");
+            const prompt = new PromptTemplate({
+                template: promptTemplate,
+                inputVariables: ["history", "query"],
+            });
+            _defaultChain = new ConversationChain({
+                llm,
+                prompt,
+                outputKey: "result",
+            });
+        }
+        return new MultiRetrievalQAChain({
+            routerChain,
+            destinationChains,
+            defaultChain: _defaultChain,
+            ...options,
+        });
+    }
+    _chainType() {
+        return "multi_retrieval_qa_chain";
+    }
+}

package/dist/chains/router/multi_route.cjs

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultiRouteChain = exports.RouterChain = void 0;
+const base_js_1 = require("../../chains/base.cjs");
+class RouterChain extends base_js_1.BaseChain {
+    get outputKeys() {
+        return ["destination", "next_inputs"];
+    }
+    async route(inputs, callbacks) {
+        const result = await this.call(inputs, callbacks);
+        return {
+            destination: result.destination,
+            nextInputs: result.next_inputs,
+        };
+    }
+}
+exports.RouterChain = RouterChain;
+class MultiRouteChain extends base_js_1.BaseChain {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "routerChain", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "destinationChains", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "defaultChain", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "silentErrors", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        this.routerChain = fields.routerChain;
+        this.destinationChains = fields.destinationChains;
+        this.defaultChain = fields.defaultChain;
+        this.silentErrors = fields.silentErrors ?? this.silentErrors;
+    }
+    get inputKeys() {
+        return this.routerChain.inputKeys;
+    }
+    get outputKeys() {
+        return [];
+    }
+    async _call(values, runManager) {
+        const { destination, nextInputs } = await this.routerChain.route(values, runManager?.getChild());
+        await runManager?.handleText(`${destination}: ${JSON.stringify(nextInputs)}`);
+        if (!destination) {
+            return this.defaultChain
+                .call(nextInputs, runManager?.getChild())
+                .catch((err) => {
+                throw new Error(`Error in default chain: ${err}`);
+            });
+        }
+        if (destination in this.destinationChains) {
+            return this.destinationChains[destination]
+                .call(nextInputs, runManager?.getChild())
+                .catch((err) => {
+                throw new Error(`Error in ${destination} chain: ${err}`);
+            });
+        }
+        if (this.silentErrors) {
+            return this.defaultChain
+                .call(nextInputs, runManager?.getChild())
+                .catch((err) => {
+                throw new Error(`Error in default chain: ${err}`);
+            });
+        }
+        throw new Error(`Destination ${destination} not found in destination chains with keys ${Object.keys(this.destinationChains)}`);
+    }
+    _chainType() {
+        return "multi_route_chain";
+    }
+}
+exports.MultiRouteChain = MultiRouteChain;

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

@@ -0,0 +1,38 @@
+import { CallbackManagerForChainRun, Callbacks } from "../../callbacks/manager.js";
+import { BaseChain, ChainInputs } from "../../chains/base.js";
+import { ChainValues } from "../../schema/index.js";
+type Inputs = {
+    [key: string]: Inputs | Inputs[] | string | string[] | number | number[];
+};
+export interface Route {
+    destination?: string;
+    nextInputs: {
+        [key: string]: Inputs;
+    };
+}
+export interface MultiRouteChainInput extends ChainInputs {
+    routerChain: RouterChain;
+    destinationChains: {
+        [name: string]: BaseChain;
+    };
+    defaultChain: BaseChain;
+    silentErrors?: boolean;
+}
+export declare abstract class RouterChain extends BaseChain {
+    get outputKeys(): string[];
+    route(inputs: ChainValues, callbacks?: Callbacks): Promise<Route>;
+}
+export declare class MultiRouteChain extends BaseChain {
+    routerChain: RouterChain;
+    destinationChains: {
+        [name: string]: BaseChain;
+    };
+    defaultChain: BaseChain;
+    silentErrors: boolean;
+    constructor(fields: MultiRouteChainInput);
+    get inputKeys(): string[];
+    get outputKeys(): string[];
+    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
+    _chainType(): string;
+}
+export {};

package/dist/chains/router/multi_route.js

@@ -0,0 +1,81 @@
+import { BaseChain } from "../../chains/base.js";
+export class RouterChain extends BaseChain {
+    get outputKeys() {
+        return ["destination", "next_inputs"];
+    }
+    async route(inputs, callbacks) {
+        const result = await this.call(inputs, callbacks);
+        return {
+            destination: result.destination,
+            nextInputs: result.next_inputs,
+        };
+    }
+}
+export class MultiRouteChain extends BaseChain {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "routerChain", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "destinationChains", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "defaultChain", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "silentErrors", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        this.routerChain = fields.routerChain;
+        this.destinationChains = fields.destinationChains;
+        this.defaultChain = fields.defaultChain;
+        this.silentErrors = fields.silentErrors ?? this.silentErrors;
+    }
+    get inputKeys() {
+        return this.routerChain.inputKeys;
+    }
+    get outputKeys() {
+        return [];
+    }
+    async _call(values, runManager) {
+        const { destination, nextInputs } = await this.routerChain.route(values, runManager?.getChild());
+        await runManager?.handleText(`${destination}: ${JSON.stringify(nextInputs)}`);
+        if (!destination) {
+            return this.defaultChain
+                .call(nextInputs, runManager?.getChild())
+                .catch((err) => {
+                throw new Error(`Error in default chain: ${err}`);
+            });
+        }
+        if (destination in this.destinationChains) {
+            return this.destinationChains[destination]
+                .call(nextInputs, runManager?.getChild())
+                .catch((err) => {
+                throw new Error(`Error in ${destination} chain: ${err}`);
+            });
+        }
+        if (this.silentErrors) {
+            return this.defaultChain
+                .call(nextInputs, runManager?.getChild())
+                .catch((err) => {
+                throw new Error(`Error in default chain: ${err}`);
+            });
+        }
+        throw new Error(`Destination ${destination} not found in destination chains with keys ${Object.keys(this.destinationChains)}`);
+    }
+    _chainType() {
+        return "multi_route_chain";
+    }
+}

package/dist/chains/router/utils.cjs

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zipEntries = void 0;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function zipEntries(...arrays) {
+    // Check for empty input
+    if (arrays.length === 0) {
+        return [];
+    }
+    // Find the length of the first input array
+    const firstArrayLength = arrays[0].length;
+    // Ensure all input arrays have the same length
+    for (const array of arrays) {
+        if (array.length !== firstArrayLength) {
+            throw new Error("All input arrays must have the same length.");
+        }
+    }
+    // Create an empty array to store the zipped arrays
+    const zipped = [];
+    // Iterate through each element of the first input array
+    for (let i = 0; i < firstArrayLength; i += 1) {
+        // Create an array to store the zipped elements at the current index
+        const zippedElement = [];
+        // Iterate through each input array
+        for (const array of arrays) {
+            // Add the element at the current index to the zipped element array
+            zippedElement.push(array[i]);
+        }
+        // Add the zipped element array to the zipped array
+        zipped.push(zippedElement);
+    }
+    return zipped;
+}
+exports.zipEntries = zipEntries;

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

@@ -0,0 +1,3 @@
+export declare function zipEntries<T extends any[]>(...arrays: {
+    [P in keyof T]: T[P][];
+}): T[];

package/dist/chains/router/utils.js

@@ -0,0 +1,30 @@
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function zipEntries(...arrays) {
+    // Check for empty input
+    if (arrays.length === 0) {
+        return [];
+    }
+    // Find the length of the first input array
+    const firstArrayLength = arrays[0].length;
+    // Ensure all input arrays have the same length
+    for (const array of arrays) {
+        if (array.length !== firstArrayLength) {
+            throw new Error("All input arrays must have the same length.");
+        }
+    }
+    // Create an empty array to store the zipped arrays
+    const zipped = [];
+    // Iterate through each element of the first input array
+    for (let i = 0; i < firstArrayLength; i += 1) {
+        // Create an array to store the zipped elements at the current index
+        const zippedElement = [];
+        // Iterate through each input array
+        for (const array of arrays) {
+            // Add the element at the current index to the zipped element array
+            zippedElement.push(array[i]);
+        }
+        // Add the zipped element array to the zipped array
+        zipped.push(zippedElement);
+    }
+    return zipped;
+}

package/dist/chat_models/openai.cjs

@@ -281,6 +281,7 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
             ? await new Promise((resolve, reject) => {
                 let response;
                 let rejected = false;
+                let resolved = false;
                 this.completionWithRetry({
                     ...params,
                     messages: messagesMapped,
@@ -290,6 +291,10 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
                     responseType: "stream",
                     onmessage: (event) => {
                         if (event.data?.trim?.() === "[DONE]") {
+                            if (resolved) {
+                                return;
+                            }
+                            resolved = true;
                             resolve(response);
                         }
                         else {
@@ -305,26 +310,35 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
                                 };
                             }
                             // on all messages, update choice
-                            const part = message.choices[0];
-                            if (part != null) {
-                                let choice = response.choices.find((c) => c.index === part.index);
-                                if (!choice) {
-                                    choice = {
-                                        index: part.index,
-                                        finish_reason: part.finish_reason ?? undefined,
-                                    };
-                                    response.choices.push(choice);
-                                }
-                                if (!choice.message) {
-                                    choice.message = {
-                                        role: part.delta
-                                            ?.role,
-                                        content: part.delta?.content ?? "",
-                                    };
+                            for (const part of message.choices) {
+                                if (part != null) {
+                                    let choice = response.choices.find((c) => c.index === part.index);
+                                    if (!choice) {
+                                        choice = {
+                                            index: part.index,
+                                            finish_reason: part.finish_reason ?? undefined,
+                                        };
+                                        response.choices[part.index] = choice;
+                                    }
+                                    if (!choice.message) {
+                                        choice.message = {
+                                            role: part.delta
+                                                ?.role,
+                                            content: part.delta?.content ?? "",
+                                        };
+                                    }
+                                    choice.message.content += part.delta?.content ?? "";
+                                    // TODO this should pass part.index to the callback
+                                    // when that's supported there
+                                    // eslint-disable-next-line no-void
+                                    void runManager?.handleLLMNewToken(part.delta?.content ?? "");
                                 }
-                                choice.message.content += part.delta?.content ?? "";
-                                // eslint-disable-next-line no-void
-                                void runManager?.handleLLMNewToken(part.delta?.content ?? "");
+                            }
+                            // when all messages are finished, resolve
+                            if (!resolved &&
+                                message.choices.every((c) => c.finish_reason != null)) {
+                                resolved = true;
+                                resolve(response);
                             }
                         }
                     },

package/dist/chat_models/openai.d.ts

@@ -1,5 +1,5 @@
 import { CreateChatCompletionRequest, ConfigurationParameters, CreateChatCompletionResponse } from "openai";
-import { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput } from "../types/open-ai-types.js";
+import { AzureOpenAIInput, OpenAICallOptions, OpenAIChatInput } from "../types/openai-types.js";
 import type { StreamingAxiosConfiguration } from "../util/axios-types.js";
 import { BaseChatModel, BaseChatModelParams } from "./base.js";
 import { BaseChatMessage, ChatResult } from "../schema/index.js";

package/dist/chat_models/openai.js

@@ -275,6 +275,7 @@ export class ChatOpenAI extends BaseChatModel {
             ? await new Promise((resolve, reject) => {
                 let response;
                 let rejected = false;
+                let resolved = false;
                 this.completionWithRetry({
                     ...params,
                     messages: messagesMapped,
@@ -284,6 +285,10 @@ export class ChatOpenAI extends BaseChatModel {
                     responseType: "stream",
                     onmessage: (event) => {
                         if (event.data?.trim?.() === "[DONE]") {
+                            if (resolved) {
+                                return;
+                            }
+                            resolved = true;
                             resolve(response);
                         }
                         else {
@@ -299,26 +304,35 @@ export class ChatOpenAI extends BaseChatModel {
                                 };
                             }
                             // on all messages, update choice
-                            const part = message.choices[0];
-                            if (part != null) {
-                                let choice = response.choices.find((c) => c.index === part.index);
-                                if (!choice) {
-                                    choice = {
-                                        index: part.index,
-                                        finish_reason: part.finish_reason ?? undefined,
-                                    };
-                                    response.choices.push(choice);
-                                }
-                                if (!choice.message) {
-                                    choice.message = {
-                                        role: part.delta
-                                            ?.role,
-                                        content: part.delta?.content ?? "",
-                                    };
+                            for (const part of message.choices) {
+                                if (part != null) {
+                                    let choice = response.choices.find((c) => c.index === part.index);
+                                    if (!choice) {
+                                        choice = {
+                                            index: part.index,
+                                            finish_reason: part.finish_reason ?? undefined,
+                                        };
+                                        response.choices[part.index] = choice;
+                                    }
+                                    if (!choice.message) {
+                                        choice.message = {
+                                            role: part.delta
+                                                ?.role,
+                                            content: part.delta?.content ?? "",
+                                        };
+                                    }
+                                    choice.message.content += part.delta?.content ?? "";
+                                    // TODO this should pass part.index to the callback
+                                    // when that's supported there
+                                    // eslint-disable-next-line no-void
+                                    void runManager?.handleLLMNewToken(part.delta?.content ?? "");
                                 }
-                                choice.message.content += part.delta?.content ?? "";
-                                // eslint-disable-next-line no-void
-                                void runManager?.handleLLMNewToken(part.delta?.content ?? "");
+                            }
+                            // when all messages are finished, resolve
+                            if (!resolved &&
+                                message.choices.every((c) => c.finish_reason != null)) {
+                                resolved = true;
+                                resolve(response);
                             }
                         }
                     },

package/dist/embeddings/openai.d.ts

@@ -1,5 +1,5 @@
 import { ConfigurationParameters } from "openai";
-import { AzureOpenAIInput } from "../types/open-ai-types.js";
+import { AzureOpenAIInput } from "../types/openai-types.js";
 import { Embeddings, EmbeddingsParams } from "./base.js";
 export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
     /** Model name to use */