@langchain/classic 1.0.0-alpha.1

package/dist/chains/vector_db_qa.d.ts

@@ -0,0 +1,58 @@
+import { SerializedVectorDBQAChain } from "./serde.js";
+import { BaseChain, ChainInputs } from "./base.js";
+import { BaseLanguageModelInterface } from "@langchain/core/language_models/base";
+import { CallbackManagerForChainRun } from "@langchain/core/callbacks/manager";
+import { ChainValues } from "@langchain/core/utils/types";
+import { VectorStoreInterface } from "@langchain/core/vectorstores";
+
+//#region src/chains/vector_db_qa.d.ts
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type LoadValues = Record<string, any>;
+/**
+ * Interface that extends the `ChainInputs` interface and defines the
+ * input fields required for a VectorDBQAChain. It includes properties
+ * such as `vectorstore`, `combineDocumentsChain`,
+ * `returnSourceDocuments`, `k`, and `inputKey`.
+ */
+interface VectorDBQAChainInput extends Omit<ChainInputs, "memory"> {
+  vectorstore: VectorStoreInterface;
+  combineDocumentsChain: BaseChain;
+  returnSourceDocuments?: boolean;
+  k?: number;
+  inputKey?: string;
+}
+/**
+ * Class that represents a VectorDBQAChain. It extends the `BaseChain`
+ * class and implements the `VectorDBQAChainInput` interface. It performs
+ * a similarity search using a vector store and combines the search
+ * results using a specified combine documents chain.
+ */
+declare class VectorDBQAChain extends BaseChain implements VectorDBQAChainInput {
+  static lc_name(): string;
+  k: number;
+  inputKey: string;
+  get inputKeys(): string[];
+  get outputKeys(): string[];
+  vectorstore: VectorStoreInterface;
+  combineDocumentsChain: BaseChain;
+  returnSourceDocuments: boolean;
+  constructor(fields: VectorDBQAChainInput);
+  /** @ignore */
+  _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
+  _chainType(): "vector_db_qa";
+  static deserialize(data: SerializedVectorDBQAChain, values: LoadValues): Promise<VectorDBQAChain>;
+  serialize(): SerializedVectorDBQAChain;
+  /**
+   * Static method that creates a VectorDBQAChain instance from a
+   * BaseLanguageModel and a vector store. It also accepts optional options
+   * to customize the chain.
+   * @param llm The BaseLanguageModel instance.
+   * @param vectorstore The vector store used for similarity search.
+   * @param options Optional options to customize the chain.
+   * @returns A new instance of VectorDBQAChain.
+   */
+  static fromLLM(llm: BaseLanguageModelInterface, vectorstore: VectorStoreInterface, options?: Partial<Omit<VectorDBQAChainInput, "combineDocumentsChain" | "vectorstore">>): VectorDBQAChain;
+}
+//#endregion
+export { VectorDBQAChain, VectorDBQAChainInput };
+//# sourceMappingURL=vector_db_qa.d.ts.map

package/dist/chains/vector_db_qa.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector_db_qa.d.ts","names":["BaseLanguageModelInterface","VectorStoreInterface","CallbackManagerForChainRun","ChainValues","BaseChain","ChainInputs","SerializedVectorDBQAChain","LoadValues","Record","VectorDBQAChainInput","Omit","VectorDBQAChain","Promise","Partial"],"sources":["../../src/chains/vector_db_qa.d.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BaseChain, ChainInputs } from \"./base.js\";\nimport { SerializedVectorDBQAChain } from \"./serde.js\";\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type LoadValues = Record<string, any>;\n/**\n * Interface that extends the `ChainInputs` interface and defines the\n * input fields required for a VectorDBQAChain. It includes properties\n * such as `vectorstore`, `combineDocumentsChain`,\n * `returnSourceDocuments`, `k`, and `inputKey`.\n */\nexport interface VectorDBQAChainInput extends Omit<ChainInputs, \"memory\"> {\n    vectorstore: VectorStoreInterface;\n    combineDocumentsChain: BaseChain;\n    returnSourceDocuments?: boolean;\n    k?: number;\n    inputKey?: string;\n}\n/**\n * Class that represents a VectorDBQAChain. It extends the `BaseChain`\n * class and implements the `VectorDBQAChainInput` interface. It performs\n * a similarity search using a vector store and combines the search\n * results using a specified combine documents chain.\n */\nexport declare class VectorDBQAChain extends BaseChain implements VectorDBQAChainInput {\n    static lc_name(): string;\n    k: number;\n    inputKey: string;\n    get inputKeys(): string[];\n    get outputKeys(): string[];\n    vectorstore: VectorStoreInterface;\n    combineDocumentsChain: BaseChain;\n    returnSourceDocuments: boolean;\n    constructor(fields: VectorDBQAChainInput);\n    /** @ignore */\n    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;\n    _chainType(): \"vector_db_qa\";\n    static deserialize(data: SerializedVectorDBQAChain, values: LoadValues): Promise<VectorDBQAChain>;\n    serialize(): SerializedVectorDBQAChain;\n    /**\n     * Static method that creates a VectorDBQAChain instance from a\n     * BaseLanguageModel and a vector store. It also accepts optional options\n     * to customize the chain.\n     * @param llm The BaseLanguageModel instance.\n     * @param vectorstore The vector store used for similarity search.\n     * @param options Optional options to customize the chain.\n     * @returns A new instance of VectorDBQAChain.\n     */\n    static fromLLM(llm: BaseLanguageModelInterface, vectorstore: VectorStoreInterface, options?: Partial<Omit<VectorDBQAChainInput, \"combineDocumentsChain\" | \"vectorstore\">>): VectorDBQAChain;\n}\n"],"mappings":";;;;;;;;;KAOYO,UAAAA,GAAaC;AAAzB;AAOA;;;;;AAA8CE,UAA7BD,oBAAAA,SAA6BC,IAAAA,CAAKL,WAALK,EAAAA,QAAAA,CAAAA,CAAAA;EAAI,WAAA,EACjCT,oBADiC;EAa7BU,qBAAe,EAXTP,SAWS;EAAA,qBAAA,CAAA,EAAA,OAAA;EAAA,CAAA,CAAA,EAMnBH,MAAAA;EAAoB,QACVG,CAAAA,EAAAA,MAAAA;;;;;;;;AAM0DO,cAbhEA,eAAAA,SAAwBP,SAAAA,YAAqBK,oBAamBE,CAAAA;EAAe,OAAvBC,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAO,CAAA,EACnEN,MAAAA;EAAyB,QAUlBN,EAAAA,MAAAA;EAA0B,IAAeC,SAAAA,CAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAoB,IAAyBQ,UAAAA,CAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAoB,WAAzBC,EAlBxFT,oBAkBwFS;EAAI,qBAAZG,EAjBtET,SAiBsES;EAAO,qBAAwEF,EAAAA,OAAAA;EAAe,WAxBlJP,CAAAA,MAAAA,EASrBK,oBATqBL;EAAS;EAAgC,KAAA,CAAA,MAAA,EAWpED,WAXoE,EAAA,UAAA,CAAA,EAW1CD,0BAX0C,CAAA,EAWbU,OAXa,CAWLT,WAXK,CAAA;;2BAazDG,mCAAmCC,aAAaK,QAAQD;eACpEL;;;;;;;;;;sBAUON,yCAAyCC,gCAAgCY,QAAQH,KAAKD,kEAAkEE"}

package/dist/chains/vector_db_qa.js

@@ -0,0 +1,91 @@
+import { BaseChain } from "./base.js";
+import { loadQAStuffChain } from "./question_answering/load.js";
+
+//#region src/chains/vector_db_qa.ts
+/**
+* Class that represents a VectorDBQAChain. It extends the `BaseChain`
+* class and implements the `VectorDBQAChainInput` interface. It performs
+* a similarity search using a vector store and combines the search
+* results using a specified combine documents chain.
+*/
+var VectorDBQAChain = class VectorDBQAChain extends BaseChain {
+	static lc_name() {
+		return "VectorDBQAChain";
+	}
+	k = 4;
+	inputKey = "query";
+	get inputKeys() {
+		return [this.inputKey];
+	}
+	get outputKeys() {
+		return this.combineDocumentsChain.outputKeys.concat(this.returnSourceDocuments ? ["sourceDocuments"] : []);
+	}
+	vectorstore;
+	combineDocumentsChain;
+	returnSourceDocuments = false;
+	constructor(fields) {
+		super(fields);
+		this.vectorstore = fields.vectorstore;
+		this.combineDocumentsChain = fields.combineDocumentsChain;
+		this.inputKey = fields.inputKey ?? this.inputKey;
+		this.k = fields.k ?? this.k;
+		this.returnSourceDocuments = fields.returnSourceDocuments ?? this.returnSourceDocuments;
+	}
+	/** @ignore */
+	async _call(values, runManager) {
+		if (!(this.inputKey in values)) throw new Error(`Question key ${this.inputKey} not found.`);
+		const question = values[this.inputKey];
+		const docs = await this.vectorstore.similaritySearch(question, this.k, values.filter, runManager?.getChild("vectorstore"));
+		const inputs = {
+			question,
+			input_documents: docs
+		};
+		const result = await this.combineDocumentsChain.call(inputs, runManager?.getChild("combine_documents"));
+		if (this.returnSourceDocuments) return {
+			...result,
+			sourceDocuments: docs
+		};
+		return result;
+	}
+	_chainType() {
+		return "vector_db_qa";
+	}
+	static async deserialize(data, values) {
+		if (!("vectorstore" in values)) throw new Error(`Need to pass in a vectorstore to deserialize VectorDBQAChain`);
+		const { vectorstore } = values;
+		if (!data.combine_documents_chain) throw new Error(`VectorDBQAChain must have combine_documents_chain in serialized data`);
+		return new VectorDBQAChain({
+			combineDocumentsChain: await BaseChain.deserialize(data.combine_documents_chain),
+			k: data.k,
+			vectorstore
+		});
+	}
+	serialize() {
+		return {
+			_type: this._chainType(),
+			combine_documents_chain: this.combineDocumentsChain.serialize(),
+			k: this.k
+		};
+	}
+	/**
+	* Static method that creates a VectorDBQAChain instance from a
+	* BaseLanguageModel and a vector store. It also accepts optional options
+	* to customize the chain.
+	* @param llm The BaseLanguageModel instance.
+	* @param vectorstore The vector store used for similarity search.
+	* @param options Optional options to customize the chain.
+	* @returns A new instance of VectorDBQAChain.
+	*/
+	static fromLLM(llm, vectorstore, options) {
+		const qaChain = loadQAStuffChain(llm);
+		return new this({
+			vectorstore,
+			combineDocumentsChain: qaChain,
+			...options
+		});
+	}
+};
+
+//#endregion
+export { VectorDBQAChain };
+//# sourceMappingURL=vector_db_qa.js.map

package/dist/chains/vector_db_qa.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector_db_qa.js","names":["fields: VectorDBQAChainInput","values: ChainValues","runManager?: CallbackManagerForChainRun","question: string","data: SerializedVectorDBQAChain","values: LoadValues","llm: BaseLanguageModelInterface","vectorstore: VectorStoreInterface","options?: Partial<\n      Omit<VectorDBQAChainInput, \"combineDocumentsChain\" | \"vectorstore\">\n    >"],"sources":["../../src/chains/vector_db_qa.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BaseChain, ChainInputs } from \"./base.js\";\nimport { SerializedVectorDBQAChain } from \"./serde.js\";\nimport { loadQAStuffChain } from \"./question_answering/load.js\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type LoadValues = Record<string, any>;\n\n/**\n * Interface that extends the `ChainInputs` interface and defines the\n * input fields required for a VectorDBQAChain. It includes properties\n * such as `vectorstore`, `combineDocumentsChain`,\n * `returnSourceDocuments`, `k`, and `inputKey`.\n */\nexport interface VectorDBQAChainInput extends Omit<ChainInputs, \"memory\"> {\n  vectorstore: VectorStoreInterface;\n  combineDocumentsChain: BaseChain;\n  returnSourceDocuments?: boolean;\n  k?: number;\n  inputKey?: string;\n}\n\n/**\n * Class that represents a VectorDBQAChain. It extends the `BaseChain`\n * class and implements the `VectorDBQAChainInput` interface. It performs\n * a similarity search using a vector store and combines the search\n * results using a specified combine documents chain.\n */\nexport class VectorDBQAChain extends BaseChain implements VectorDBQAChainInput {\n  static lc_name() {\n    return \"VectorDBQAChain\";\n  }\n\n  k = 4;\n\n  inputKey = \"query\";\n\n  get inputKeys() {\n    return [this.inputKey];\n  }\n\n  get outputKeys() {\n    return this.combineDocumentsChain.outputKeys.concat(\n      this.returnSourceDocuments ? [\"sourceDocuments\"] : []\n    );\n  }\n\n  vectorstore: VectorStoreInterface;\n\n  combineDocumentsChain: BaseChain;\n\n  returnSourceDocuments = false;\n\n  constructor(fields: VectorDBQAChainInput) {\n    super(fields);\n    this.vectorstore = fields.vectorstore;\n    this.combineDocumentsChain = fields.combineDocumentsChain;\n    this.inputKey = fields.inputKey ?? this.inputKey;\n    this.k = fields.k ?? this.k;\n    this.returnSourceDocuments =\n      fields.returnSourceDocuments ?? this.returnSourceDocuments;\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    if (!(this.inputKey in values)) {\n      throw new Error(`Question key ${this.inputKey} not found.`);\n    }\n    const question: string = values[this.inputKey];\n    const docs = await this.vectorstore.similaritySearch(\n      question,\n      this.k,\n      values.filter,\n      runManager?.getChild(\"vectorstore\")\n    );\n    const inputs = { question, input_documents: docs };\n    const result = await this.combineDocumentsChain.call(\n      inputs,\n      runManager?.getChild(\"combine_documents\")\n    );\n    if (this.returnSourceDocuments) {\n      return {\n        ...result,\n        sourceDocuments: docs,\n      };\n    }\n    return result;\n  }\n\n  _chainType() {\n    return \"vector_db_qa\" as const;\n  }\n\n  static async deserialize(\n    data: SerializedVectorDBQAChain,\n    values: LoadValues\n  ) {\n    if (!(\"vectorstore\" in values)) {\n      throw new Error(\n        `Need to pass in a vectorstore to deserialize VectorDBQAChain`\n      );\n    }\n    const { vectorstore } = values;\n    if (!data.combine_documents_chain) {\n      throw new Error(\n        `VectorDBQAChain must have combine_documents_chain in serialized data`\n      );\n    }\n\n    return new VectorDBQAChain({\n      combineDocumentsChain: await BaseChain.deserialize(\n        data.combine_documents_chain\n      ),\n      k: data.k,\n      vectorstore,\n    });\n  }\n\n  serialize(): SerializedVectorDBQAChain {\n    return {\n      _type: this._chainType(),\n      combine_documents_chain: this.combineDocumentsChain.serialize(),\n      k: this.k,\n    };\n  }\n\n  /**\n   * Static method that creates a VectorDBQAChain instance from a\n   * BaseLanguageModel and a vector store. It also accepts optional options\n   * to customize the chain.\n   * @param llm The BaseLanguageModel instance.\n   * @param vectorstore The vector store used for similarity search.\n   * @param options Optional options to customize the chain.\n   * @returns A new instance of VectorDBQAChain.\n   */\n  static fromLLM(\n    llm: BaseLanguageModelInterface,\n    vectorstore: VectorStoreInterface,\n    options?: Partial<\n      Omit<VectorDBQAChainInput, \"combineDocumentsChain\" | \"vectorstore\">\n    >\n  ): VectorDBQAChain {\n    const qaChain = loadQAStuffChain(llm);\n    return new this({\n      vectorstore,\n      combineDocumentsChain: qaChain,\n      ...options,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;AA+BA,IAAa,kBAAb,MAAa,wBAAwB,UAA0C;CAC7E,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI;CAEJ,WAAW;CAEX,IAAI,YAAY;AACd,SAAO,CAAC,KAAK,QAAS;CACvB;CAED,IAAI,aAAa;AACf,SAAO,KAAK,sBAAsB,WAAW,OAC3C,KAAK,wBAAwB,CAAC,iBAAkB,IAAG,CAAE,EACtD;CACF;CAED;CAEA;CAEA,wBAAwB;CAExB,YAAYA,QAA8B;EACxC,MAAM,OAAO;EACb,KAAK,cAAc,OAAO;EAC1B,KAAK,wBAAwB,OAAO;EACpC,KAAK,WAAW,OAAO,YAAY,KAAK;EACxC,KAAK,IAAI,OAAO,KAAK,KAAK;EAC1B,KAAK,wBACH,OAAO,yBAAyB,KAAK;CACxC;;CAGD,MAAM,MACJC,QACAC,YACsB;AACtB,MAAI,EAAE,KAAK,YAAY,QACrB,OAAM,IAAI,MAAM,CAAC,aAAa,EAAE,KAAK,SAAS,WAAW,CAAC;EAE5D,MAAMC,WAAmB,OAAO,KAAK;EACrC,MAAM,OAAO,MAAM,KAAK,YAAY,iBAClC,UACA,KAAK,GACL,OAAO,QACP,YAAY,SAAS,cAAc,CACpC;EACD,MAAM,SAAS;GAAE;GAAU,iBAAiB;EAAM;EAClD,MAAM,SAAS,MAAM,KAAK,sBAAsB,KAC9C,QACA,YAAY,SAAS,oBAAoB,CAC1C;AACD,MAAI,KAAK,sBACP,QAAO;GACL,GAAG;GACH,iBAAiB;EAClB;AAEH,SAAO;CACR;CAED,aAAa;AACX,SAAO;CACR;CAED,aAAa,YACXC,MACAC,QACA;AACA,MAAI,EAAE,iBAAiB,QACrB,OAAM,IAAI,MACR,CAAC,4DAA4D,CAAC;EAGlE,MAAM,EAAE,aAAa,GAAG;AACxB,MAAI,CAAC,KAAK,wBACR,OAAM,IAAI,MACR,CAAC,oEAAoE,CAAC;AAI1E,SAAO,IAAI,gBAAgB;GACzB,uBAAuB,MAAM,UAAU,YACrC,KAAK,wBACN;GACD,GAAG,KAAK;GACR;EACD;CACF;CAED,YAAuC;AACrC,SAAO;GACL,OAAO,KAAK,YAAY;GACxB,yBAAyB,KAAK,sBAAsB,WAAW;GAC/D,GAAG,KAAK;EACT;CACF;;;;;;;;;;CAWD,OAAO,QACLC,KACAC,aACAC,SAGiB;EACjB,MAAM,UAAU,iBAAiB,IAAI;AACrC,SAAO,IAAI,KAAK;GACd;GACA,uBAAuB;GACvB,GAAG;EACJ;CACF;AACF"}