langchain 0.0.146 → 0.0.148

package/dist/retrievers/multi_query.d.ts

@@ -0,0 +1,33 @@
+import { LLMChain } from "../chains/llm_chain.js";
+import { Document } from "../document.js";
+import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
+import { CallbackManagerForRetrieverRun } from "../callbacks/index.js";
+import { BaseLanguageModel } from "../base_language/index.js";
+import { BasePromptTemplate } from "../prompts/base.js";
+interface LineList {
+    lines: string[];
+}
+export interface MultiQueryRetrieverInput extends BaseRetrieverInput {
+    retriever: BaseRetriever;
+    llmChain: LLMChain<LineList>;
+    queryCount?: number;
+    parserKey?: string;
+}
+export declare class MultiQueryRetriever extends BaseRetriever {
+    static lc_name(): string;
+    lc_namespace: string[];
+    private retriever;
+    private llmChain;
+    private queryCount;
+    private parserKey;
+    constructor(fields: MultiQueryRetrieverInput);
+    static fromLLM(fields: Omit<MultiQueryRetrieverInput, "llmChain"> & {
+        llm: BaseLanguageModel;
+        prompt?: BasePromptTemplate;
+    }): MultiQueryRetriever;
+    private _generateQueries;
+    private _retrieveDocuments;
+    private _uniqueUnion;
+    _getRelevantDocuments(question: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
+}
+export {};

package/dist/retrievers/multi_query.js

@@ -0,0 +1,136 @@
+import { LLMChain } from "../chains/llm_chain.js";
+import { PromptTemplate } from "../prompts/prompt.js";
+import { BaseOutputParser } from "../schema/output_parser.js";
+import { BaseRetriever } from "../schema/retriever.js";
+class LineListOutputParser extends BaseOutputParser {
+    constructor() {
+        super(...arguments);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "retrievers", "multiquery"]
+        });
+    }
+    static lc_name() {
+        return "LineListOutputParser";
+    }
+    async parse(text) {
+        const startKeyIndex = text.indexOf("<questions>");
+        const endKeyIndex = text.indexOf("</questions>");
+        const questionsStartIndex = startKeyIndex === -1 ? 0 : startKeyIndex + "<questions>".length;
+        const questionsEndIndex = endKeyIndex === -1 ? text.length : endKeyIndex;
+        const lines = text
+            .slice(questionsStartIndex, questionsEndIndex)
+            .trim()
+            .split("\n")
+            .filter((line) => line.trim() !== "");
+        return { lines };
+    }
+    getFormatInstructions() {
+        throw new Error("Not implemented.");
+    }
+}
+// Create template
+const DEFAULT_QUERY_PROMPT = /* #__PURE__ */ new PromptTemplate({
+    inputVariables: ["question", "queryCount"],
+    template: `You are an AI language model assistant. Your task is
+to generate {queryCount} different versions of the given user
+question to retrieve relevant documents from a vector database.
+By generating multiple perspectives on the user question,
+your goal is to help the user overcome some of the limitations
+of distance-based similarity search.
+
+Provide these alternative questions separated by newlines between XML tags. For example:
+
+<questions>
+Question 1
+Question 2
+Question 3
+</questions>
+
+Original question: {question}`,
+});
+// Export class
+export class MultiQueryRetriever extends BaseRetriever {
+    static lc_name() {
+        return "MultiQueryRetriever";
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_namespace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ["langchain", "retrievers", "multiquery"]
+        });
+        Object.defineProperty(this, "retriever", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "llmChain", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "queryCount", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 3
+        });
+        Object.defineProperty(this, "parserKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "lines"
+        });
+        this.retriever = fields.retriever;
+        this.llmChain = fields.llmChain;
+        this.queryCount = fields.queryCount ?? this.queryCount;
+        this.parserKey = fields.parserKey ?? this.parserKey;
+    }
+    static fromLLM(fields) {
+        const { retriever, llm, prompt = DEFAULT_QUERY_PROMPT, queryCount, parserKey, ...rest } = fields;
+        const outputParser = new LineListOutputParser();
+        const llmChain = new LLMChain({ llm, prompt, outputParser });
+        return new this({ retriever, llmChain, queryCount, parserKey, ...rest });
+    }
+    // Generate the different queries for each retrieval, using our llmChain
+    async _generateQueries(question, runManager) {
+        const response = await this.llmChain.call({ question, queryCount: this.queryCount }, runManager?.getChild());
+        const lines = response.text[this.parserKey] || [];
+        if (this.verbose) {
+            console.log(`Generated queries: ${lines}`);
+        }
+        return lines;
+    }
+    // Retrieve documents using the original retriever
+    async _retrieveDocuments(queries, runManager) {
+        const documents = [];
+        for (const query of queries) {
+            const docs = await this.retriever.getRelevantDocuments(query, runManager?.getChild());
+            documents.push(...docs);
+        }
+        return documents;
+    }
+    // Deduplicate the documents that were returned in multiple retrievals
+    _uniqueUnion(documents) {
+        const uniqueDocumentsDict = {};
+        for (const doc of documents) {
+            const key = `${doc.pageContent}:${JSON.stringify(Object.entries(doc.metadata).sort())}`;
+            uniqueDocumentsDict[key] = doc;
+        }
+        const uniqueDocuments = Object.values(uniqueDocumentsDict);
+        return uniqueDocuments;
+    }
+    async _getRelevantDocuments(question, runManager) {
+        const queries = await this._generateQueries(question, runManager);
+        const documents = await this._retrieveDocuments(queries, runManager);
+        const uniqueDocuments = this._uniqueUnion(documents);
+        return uniqueDocuments;
+    }
+}

package/dist/schema/document.cjs

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MappingDocumentTransformer = exports.BaseDocumentTransformer = void 0;
-const runnable_js_1 = require("./runnable.cjs");
+const index_js_1 = require("./runnable/index.cjs");
 /**
  * Abstract base class for document transformation systems.
  *
@@ -12,7 +12,7 @@ const runnable_js_1 = require("./runnable.cjs");
  * One example of this is a text splitter that splits a large document into
  * many smaller documents.
  */
-class BaseDocumentTransformer extends runnable_js_1.Runnable {
+class BaseDocumentTransformer extends index_js_1.Runnable {
     constructor() {
         super(...arguments);
         Object.defineProperty(this, "lc_namespace", {

package/dist/schema/document.d.ts

@@ -1,6 +1,6 @@
 import { BaseCallbackConfig } from "../callbacks/manager.js";
 import { Document } from "../document.js";
-import { Runnable } from "./runnable.js";
+import { Runnable } from "./runnable/index.js";
 /**
  * Abstract base class for document transformation systems.
  *

package/dist/schema/document.js

@@ -1,4 +1,4 @@
-import { Runnable } from "./runnable.js";
+import { Runnable } from "./runnable/index.js";
 /**
  * Abstract base class for document transformation systems.
  *

package/dist/schema/output_parser.cjs

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutputParserException = exports.BytesOutputParser = exports.StringOutputParser = exports.BaseTransformOutputParser = exports.BaseOutputParser = exports.BaseLLMOutputParser = void 0;
-const runnable_js_1 = require("./runnable.cjs");
+const index_js_1 = require("./runnable/index.cjs");
 /**
  * Abstract base class for parsing the output of a Large Language Model
  * (LLM) call. It provides methods for parsing the result of an LLM call
  * and invoking the parser with a given input.
  */
-class BaseLLMOutputParser extends runnable_js_1.Runnable {
+class BaseLLMOutputParser extends index_js_1.Runnable {
     /**
      * Parses the result of an LLM call with a given prompt. By default, it
      * simply calls `parseResult`.

package/dist/schema/output_parser.d.ts

@@ -1,6 +1,7 @@
 import { BaseCallbackConfig, Callbacks } from "../callbacks/manager.js";
 import { BasePromptValue, Generation, ChatGeneration, BaseMessage } from "./index.js";
-import { Runnable, RunnableConfig } from "./runnable.js";
+import { Runnable } from "./runnable/index.js";
+import { RunnableConfig } from "./runnable/config.js";
 /**
  * Options for formatting instructions.
  */

package/dist/schema/output_parser.js

@@ -1,4 +1,4 @@
-import { Runnable } from "./runnable.js";
+import { Runnable } from "./runnable/index.js";
 /**
  * Abstract base class for parsing the output of a Large Language Model
  * (LLM) call. It provides methods for parsing the result of an LLM call

package/dist/schema/retriever.cjs

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseRetriever = void 0;
 const manager_js_1 = require("../callbacks/manager.cjs");
-const runnable_js_1 = require("./runnable.cjs");
+const index_js_1 = require("./runnable/index.cjs");
 /**
  * Abstract base class for a Document retrieval system. A retrieval system
  * is defined as something that can take string queries and return the
  * most 'relevant' Documents from some source.
  */
-class BaseRetriever extends runnable_js_1.Runnable {
+class BaseRetriever extends index_js_1.Runnable {
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "callbacks", {

package/dist/schema/retriever.d.ts

@@ -1,6 +1,7 @@
 import { BaseCallbackConfig, CallbackManagerForRetrieverRun, Callbacks } from "../callbacks/manager.js";
 import { Document } from "../document.js";
-import { Runnable, RunnableConfig } from "./runnable.js";
+import { Runnable } from "./runnable/index.js";
+import { RunnableConfig } from "./runnable/config.js";
 /**
  * Base Retriever class. All indexes should extend this class.
  */

package/dist/schema/retriever.js

@@ -1,5 +1,5 @@
 import { CallbackManager, parseCallbackConfigArg, } from "../callbacks/manager.js";
-import { Runnable } from "./runnable.js";
+import { Runnable } from "./runnable/index.js";
 /**
  * Abstract base class for a Document retrieval system. A retrieval system
  * is defined as something that can take string queries and return the

package/dist/schema/runnable/config.cjs

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCallbackMangerForConfig = void 0;
+const manager_js_1 = require("../../callbacks/manager.cjs");
+async function getCallbackMangerForConfig(config) {
+    return manager_js_1.CallbackManager.configure(config?.callbacks, undefined, config?.tags, undefined, config?.metadata);
+}
+exports.getCallbackMangerForConfig = getCallbackMangerForConfig;

package/dist/schema/runnable/config.d.ts

@@ -0,0 +1,3 @@
+import { BaseCallbackConfig, CallbackManager } from "../../callbacks/manager.js";
+export type RunnableConfig = BaseCallbackConfig;
+export declare function getCallbackMangerForConfig(config?: RunnableConfig): Promise<CallbackManager | undefined>;

package/dist/schema/runnable/config.js

@@ -0,0 +1,4 @@
+import { CallbackManager, } from "../../callbacks/manager.js";
+export async function getCallbackMangerForConfig(config) {
+    return CallbackManager.configure(config?.callbacks, undefined, config?.tags, undefined, config?.metadata);
+}