@langchain/classic 1.0.0-alpha.1

package/dist/retrievers/parent_document.js

@@ -0,0 +1,131 @@
+import { __export } from "../_virtual/rolldown_runtime.js";
+import { MultiVectorRetriever } from "./multi_vector.js";
+import { Document } from "@langchain/core/documents";
+import * as uuid from "uuid";
+
+//#region src/retrievers/parent_document.ts
+var parent_document_exports = {};
+__export(parent_document_exports, { ParentDocumentRetriever: () => ParentDocumentRetriever });
+/**
+* A type of document retriever that splits input documents into smaller chunks
+* while separately storing and preserving the original documents.
+* The small chunks are embedded, then on retrieval, the original
+* "parent" documents are retrieved.
+*
+* This strikes a balance between better targeted retrieval with small documents
+* and the more context-rich larger documents.
+* @example
+* ```typescript
+* const retriever = new ParentDocumentRetriever({
+*   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),
+*   byteStore: new InMemoryStore<Uint8Array>(),
+*   parentSplitter: new RecursiveCharacterTextSplitter({
+*     chunkOverlap: 0,
+*     chunkSize: 500,
+*   }),
+*   childSplitter: new RecursiveCharacterTextSplitter({
+*     chunkOverlap: 0,
+*     chunkSize: 50,
+*   }),
+*   childK: 20,
+*   parentK: 5,
+* });
+*
+* const parentDocuments = await getDocuments();
+* await retriever.addDocuments(parentDocuments);
+* const retrievedDocs = await retriever.invoke("justice breyer");
+* ```
+*/
+var ParentDocumentRetriever = class extends MultiVectorRetriever {
+	static lc_name() {
+		return "ParentDocumentRetriever";
+	}
+	lc_namespace = [
+		"langchain",
+		"retrievers",
+		"parent_document"
+	];
+	vectorstore;
+	childSplitter;
+	parentSplitter;
+	idKey = "doc_id";
+	childK;
+	parentK;
+	childDocumentRetriever;
+	documentCompressor;
+	documentCompressorFilteringFn;
+	constructor(fields) {
+		super(fields);
+		this.vectorstore = fields.vectorstore;
+		this.childSplitter = fields.childSplitter;
+		this.parentSplitter = fields.parentSplitter;
+		this.idKey = fields.idKey ?? this.idKey;
+		this.childK = fields.childK;
+		this.parentK = fields.parentK;
+		this.childDocumentRetriever = fields.childDocumentRetriever;
+		this.documentCompressor = fields.documentCompressor;
+		this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;
+	}
+	async _getRelevantDocuments(query) {
+		let subDocs = [];
+		if (this.childDocumentRetriever) subDocs = await this.childDocumentRetriever.invoke(query);
+		else subDocs = await this.vectorstore.similaritySearch(query, this.childK);
+		if (this.documentCompressor && subDocs.length) {
+			subDocs = await this.documentCompressor.compressDocuments(subDocs, query);
+			if (this.documentCompressorFilteringFn) subDocs = this.documentCompressorFilteringFn(subDocs);
+		}
+		const parentDocIds = [];
+		for (const doc of subDocs) if (!parentDocIds.includes(doc.metadata[this.idKey])) parentDocIds.push(doc.metadata[this.idKey]);
+		const parentDocs = [];
+		const storedParentDocs = await this.docstore.mget(parentDocIds);
+		const retrievedDocs = storedParentDocs.filter((doc) => doc !== void 0);
+		parentDocs.push(...retrievedDocs);
+		return parentDocs.slice(0, this.parentK);
+	}
+	async _storeDocuments(parentDoc, childDocs, addToDocstore) {
+		if (this.childDocumentRetriever) await this.childDocumentRetriever.addDocuments(childDocs);
+		else await this.vectorstore.addDocuments(childDocs);
+		if (addToDocstore) await this.docstore.mset(Object.entries(parentDoc));
+	}
+	/**
+	* Adds documents to the docstore and vectorstores.
+	* If a retriever is provided, it will be used to add documents instead of the vectorstore.
+	* @param docs The documents to add
+	* @param config.ids Optional list of ids for documents. If provided should be the same
+	*   length as the list of documents. Can provided if parent documents
+	*   are already in the document store and you don't want to re-add
+	*   to the docstore. If not provided, random UUIDs will be used as ids.
+	* @param config.addToDocstore Boolean of whether to add documents to docstore.
+	* This can be false if and only if `ids` are provided. You may want
+	*   to set this to False if the documents are already in the docstore
+	*   and you don't want to re-add them.
+	* @param config.chunkHeaderOptions Object with options for adding Contextual chunk headers
+	*/
+	async addDocuments(docs, config) {
+		const { ids, addToDocstore = true, childDocChunkHeaderOptions = {} } = config ?? {};
+		const parentDocs = this.parentSplitter ? await this.parentSplitter.splitDocuments(docs) : docs;
+		let parentDocIds;
+		if (ids === void 0) {
+			if (!addToDocstore) throw new Error(`If ids are not passed in, "config.addToDocstore" MUST be true`);
+			parentDocIds = parentDocs.map((_doc) => uuid.v4());
+		} else parentDocIds = ids;
+		if (parentDocs.length !== parentDocIds.length) throw new Error(`Got uneven list of documents and ids.\nIf "ids" is provided, should be same length as "documents".`);
+		for (let i = 0; i < parentDocs.length; i += 1) {
+			const parentDoc = parentDocs[i];
+			const parentDocId = parentDocIds[i];
+			const subDocs = await this.childSplitter.splitDocuments([parentDoc], childDocChunkHeaderOptions);
+			const taggedSubDocs = subDocs.map((subDoc) => new Document({
+				pageContent: subDoc.pageContent,
+				metadata: {
+					...subDoc.metadata,
+					[this.idKey]: parentDocId
+				}
+			}));
+			await this._storeDocuments({ [parentDocId]: parentDoc }, taggedSubDocs, addToDocstore);
+		}
+	}
+};
+
+//#endregion
+export { ParentDocumentRetriever, parent_document_exports };
+//# sourceMappingURL=parent_document.js.map

package/dist/retrievers/parent_document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parent_document.js","names":["fields: ParentDocumentRetrieverFields","query: string","subDocs: SubDocs","parentDocIds: string[]","parentDocs: Document[]","retrievedDocs: Document[]","doc?: Document","parentDoc: Record<string, Document>","childDocs: Document[]","addToDocstore: boolean","docs: Document[]","config?: {\n      ids?: string[];\n      addToDocstore?: boolean;\n      childDocChunkHeaderOptions?: TextSplitterChunkHeaderOptions;\n    }","_doc: Document","subDoc: Document"],"sources":["../../src/retrievers/parent_document.ts"],"sourcesContent":["import * as uuid from \"uuid\";\n\nimport {\n  type VectorStoreInterface,\n  type VectorStoreRetrieverInterface,\n} from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport {\n  TextSplitter,\n  TextSplitterChunkHeaderOptions,\n} from \"@langchain/textsplitters\";\nimport type { BaseDocumentCompressor } from \"./document_compressors/index.js\";\nimport {\n  MultiVectorRetriever,\n  type MultiVectorRetrieverInput,\n} from \"./multi_vector.js\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type SubDocs = Document<Record<string, any>>[];\n\n/**\n * Interface for the fields required to initialize a\n * ParentDocumentRetriever instance.\n */\nexport type ParentDocumentRetrieverFields = MultiVectorRetrieverInput & {\n  childSplitter: TextSplitter;\n  parentSplitter?: TextSplitter;\n  /**\n   * A custom retriever to use when retrieving instead of\n   * the `.similaritySearch` method of the vectorstore.\n   */\n  childDocumentRetriever?: VectorStoreRetrieverInterface<VectorStoreInterface>;\n  documentCompressor?: BaseDocumentCompressor | undefined;\n  documentCompressorFilteringFn?: (docs: SubDocs) => SubDocs;\n};\n\n/**\n * A type of document retriever that splits input documents into smaller chunks\n * while separately storing and preserving the original documents.\n * The small chunks are embedded, then on retrieval, the original\n * \"parent\" documents are retrieved.\n *\n * This strikes a balance between better targeted retrieval with small documents\n * and the more context-rich larger documents.\n * @example\n * ```typescript\n * const retriever = new ParentDocumentRetriever({\n *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   byteStore: new InMemoryStore<Uint8Array>(),\n *   parentSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 500,\n *   }),\n *   childSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 50,\n *   }),\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const parentDocuments = await getDocuments();\n * await retriever.addDocuments(parentDocuments);\n * const retrievedDocs = await retriever.invoke(\"justice breyer\");\n * ```\n */\nexport class ParentDocumentRetriever extends MultiVectorRetriever {\n  static lc_name() {\n    return \"ParentDocumentRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"parent_document\"];\n\n  vectorstore: VectorStoreInterface;\n\n  protected childSplitter: TextSplitter;\n\n  protected parentSplitter?: TextSplitter;\n\n  protected idKey = \"doc_id\";\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  childDocumentRetriever:\n    | VectorStoreRetrieverInterface<VectorStoreInterface>\n    | undefined;\n\n  documentCompressor: BaseDocumentCompressor | undefined;\n\n  documentCompressorFilteringFn?: ParentDocumentRetrieverFields[\"documentCompressorFilteringFn\"];\n\n  constructor(fields: ParentDocumentRetrieverFields) {\n    super(fields);\n    this.vectorstore = fields.vectorstore;\n    this.childSplitter = fields.childSplitter;\n    this.parentSplitter = fields.parentSplitter;\n    this.idKey = fields.idKey ?? this.idKey;\n    this.childK = fields.childK;\n    this.parentK = fields.parentK;\n    this.childDocumentRetriever = fields.childDocumentRetriever;\n    this.documentCompressor = fields.documentCompressor;\n    this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    let subDocs: SubDocs = [];\n    if (this.childDocumentRetriever) {\n      subDocs = await this.childDocumentRetriever.invoke(query);\n    } else {\n      subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    }\n\n    if (this.documentCompressor && subDocs.length) {\n      subDocs = await this.documentCompressor.compressDocuments(subDocs, query);\n      if (this.documentCompressorFilteringFn) {\n        subDocs = this.documentCompressorFilteringFn(subDocs);\n      }\n    }\n\n    // Maintain order\n    const parentDocIds: string[] = [];\n    for (const doc of subDocs) {\n      if (!parentDocIds.includes(doc.metadata[this.idKey])) {\n        parentDocIds.push(doc.metadata[this.idKey]);\n      }\n    }\n    const parentDocs: Document[] = [];\n    const storedParentDocs = await this.docstore.mget(parentDocIds);\n    const retrievedDocs: Document[] = storedParentDocs.filter(\n      (doc?: Document): doc is Document => doc !== undefined\n    );\n    parentDocs.push(...retrievedDocs);\n    return parentDocs.slice(0, this.parentK);\n  }\n\n  async _storeDocuments(\n    parentDoc: Record<string, Document>,\n    childDocs: Document[],\n    addToDocstore: boolean\n  ) {\n    if (this.childDocumentRetriever) {\n      await this.childDocumentRetriever.addDocuments(childDocs);\n    } else {\n      await this.vectorstore.addDocuments(childDocs);\n    }\n    if (addToDocstore) {\n      await this.docstore.mset(Object.entries(parentDoc));\n    }\n  }\n\n  /**\n   * Adds documents to the docstore and vectorstores.\n   * If a retriever is provided, it will be used to add documents instead of the vectorstore.\n   * @param docs The documents to add\n   * @param config.ids Optional list of ids for documents. If provided should be the same\n   *   length as the list of documents. Can provided if parent documents\n   *   are already in the document store and you don't want to re-add\n   *   to the docstore. If not provided, random UUIDs will be used as ids.\n   * @param config.addToDocstore Boolean of whether to add documents to docstore.\n   * This can be false if and only if `ids` are provided. You may want\n   *   to set this to False if the documents are already in the docstore\n   *   and you don't want to re-add them.\n   * @param config.chunkHeaderOptions Object with options for adding Contextual chunk headers\n   */\n  async addDocuments(\n    docs: Document[],\n    config?: {\n      ids?: string[];\n      addToDocstore?: boolean;\n      childDocChunkHeaderOptions?: TextSplitterChunkHeaderOptions;\n    }\n  ): Promise<void> {\n    const {\n      ids,\n      addToDocstore = true,\n      childDocChunkHeaderOptions = {},\n    } = config ?? {};\n    const parentDocs = this.parentSplitter\n      ? await this.parentSplitter.splitDocuments(docs)\n      : docs;\n    let parentDocIds;\n    if (ids === undefined) {\n      if (!addToDocstore) {\n        throw new Error(\n          `If ids are not passed in, \"config.addToDocstore\" MUST be true`\n        );\n      }\n      parentDocIds = parentDocs.map((_doc: Document) => uuid.v4());\n    } else {\n      parentDocIds = ids;\n    }\n    if (parentDocs.length !== parentDocIds.length) {\n      throw new Error(\n        `Got uneven list of documents and ids.\\nIf \"ids\" is provided, should be same length as \"documents\".`\n      );\n    }\n    for (let i = 0; i < parentDocs.length; i += 1) {\n      const parentDoc = parentDocs[i];\n      const parentDocId = parentDocIds[i];\n      const subDocs = await this.childSplitter.splitDocuments(\n        [parentDoc],\n        childDocChunkHeaderOptions\n      );\n      const taggedSubDocs = subDocs.map(\n        (subDoc: Document) =>\n          new Document({\n            pageContent: subDoc.pageContent,\n            metadata: { ...subDoc.metadata, [this.idKey]: parentDocId },\n          })\n      );\n      await this._storeDocuments(\n        { [parentDocId]: parentDoc },\n        taggedSubDocs,\n        addToDocstore\n      );\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEA,IAAa,0BAAb,cAA6C,qBAAqB;CAChE,OAAO,UAAU;AACf,SAAO;CACR;CAED,eAAe;EAAC;EAAa;EAAc;CAAkB;CAE7D;CAEA,AAAU;CAEV,AAAU;CAEV,AAAU,QAAQ;CAElB,AAAU;CAEV,AAAU;CAEV;CAIA;CAEA;CAEA,YAAYA,QAAuC;EACjD,MAAM,OAAO;EACb,KAAK,cAAc,OAAO;EAC1B,KAAK,gBAAgB,OAAO;EAC5B,KAAK,iBAAiB,OAAO;EAC7B,KAAK,QAAQ,OAAO,SAAS,KAAK;EAClC,KAAK,SAAS,OAAO;EACrB,KAAK,UAAU,OAAO;EACtB,KAAK,yBAAyB,OAAO;EACrC,KAAK,qBAAqB,OAAO;EACjC,KAAK,gCAAgC,OAAO;CAC7C;CAED,MAAM,sBAAsBC,OAAoC;EAC9D,IAAIC,UAAmB,CAAE;AACzB,MAAI,KAAK,wBACP,UAAU,MAAM,KAAK,uBAAuB,OAAO,MAAM;OAEzD,UAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,OAAO;AAGvE,MAAI,KAAK,sBAAsB,QAAQ,QAAQ;GAC7C,UAAU,MAAM,KAAK,mBAAmB,kBAAkB,SAAS,MAAM;AACzE,OAAI,KAAK,+BACP,UAAU,KAAK,8BAA8B,QAAQ;EAExD;EAGD,MAAMC,eAAyB,CAAE;AACjC,OAAK,MAAM,OAAO,QAChB,KAAI,CAAC,aAAa,SAAS,IAAI,SAAS,KAAK,OAAO,EAClD,aAAa,KAAK,IAAI,SAAS,KAAK,OAAO;EAG/C,MAAMC,aAAyB,CAAE;EACjC,MAAM,mBAAmB,MAAM,KAAK,SAAS,KAAK,aAAa;EAC/D,MAAMC,gBAA4B,iBAAiB,OACjD,CAACC,QAAoC,QAAQ,OAC9C;EACD,WAAW,KAAK,GAAG,cAAc;AACjC,SAAO,WAAW,MAAM,GAAG,KAAK,QAAQ;CACzC;CAED,MAAM,gBACJC,WACAC,WACAC,eACA;AACA,MAAI,KAAK,wBACP,MAAM,KAAK,uBAAuB,aAAa,UAAU;OAEzD,MAAM,KAAK,YAAY,aAAa,UAAU;AAEhD,MAAI,eACF,MAAM,KAAK,SAAS,KAAK,OAAO,QAAQ,UAAU,CAAC;CAEtD;;;;;;;;;;;;;;;CAgBD,MAAM,aACJC,MACAC,QAKe;EACf,MAAM,EACJ,KACA,gBAAgB,MAChB,6BAA6B,CAAE,GAChC,GAAG,UAAU,CAAE;EAChB,MAAM,aAAa,KAAK,iBACpB,MAAM,KAAK,eAAe,eAAe,KAAK,GAC9C;EACJ,IAAI;AACJ,MAAI,QAAQ,QAAW;AACrB,OAAI,CAAC,cACH,OAAM,IAAI,MACR,CAAC,6DAA6D,CAAC;GAGnE,eAAe,WAAW,IAAI,CAACC,SAAmB,KAAK,IAAI,CAAC;EAC7D,OACC,eAAe;AAEjB,MAAI,WAAW,WAAW,aAAa,OACrC,OAAM,IAAI,MACR,CAAC,kGAAkG,CAAC;AAGxG,OAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,GAAG;GAC7C,MAAM,YAAY,WAAW;GAC7B,MAAM,cAAc,aAAa;GACjC,MAAM,UAAU,MAAM,KAAK,cAAc,eACvC,CAAC,SAAU,GACX,2BACD;GACD,MAAM,gBAAgB,QAAQ,IAC5B,CAACC,WACC,IAAI,SAAS;IACX,aAAa,OAAO;IACpB,UAAU;KAAE,GAAG,OAAO;MAAW,KAAK,QAAQ;IAAa;GAC5D,GACJ;GACD,MAAM,KAAK,gBACT,GAAG,cAAc,UAAW,GAC5B,eACA,cACD;EACF;CACF;AACF"}

package/dist/retrievers/score_threshold.cjs

@@ -0,0 +1,43 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const __langchain_core_vectorstores = require_rolldown_runtime.__toESM(require("@langchain/core/vectorstores"));
+
+//#region src/retrievers/score_threshold.ts
+var score_threshold_exports = {};
+require_rolldown_runtime.__export(score_threshold_exports, { ScoreThresholdRetriever: () => ScoreThresholdRetriever });
+var ScoreThresholdRetriever = class extends __langchain_core_vectorstores.VectorStoreRetriever {
+	minSimilarityScore;
+	kIncrement = 10;
+	maxK = 100;
+	constructor(input) {
+		super(input);
+		this.maxK = input.maxK ?? this.maxK;
+		this.minSimilarityScore = input.minSimilarityScore ?? this.minSimilarityScore;
+		this.kIncrement = input.kIncrement ?? this.kIncrement;
+	}
+	async invoke(query) {
+		let currentK = 0;
+		let filteredResults = [];
+		do {
+			currentK += this.kIncrement;
+			const results = await this.vectorStore.similaritySearchWithScore(query, currentK, this.filter);
+			filteredResults = results.filter(([, score]) => score >= this.minSimilarityScore);
+		} while (filteredResults.length >= currentK && currentK < this.maxK);
+		return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);
+	}
+	static fromVectorStore(vectorStore, options) {
+		return new this({
+			...options,
+			vectorStore
+		});
+	}
+};
+
+//#endregion
+exports.ScoreThresholdRetriever = ScoreThresholdRetriever;
+Object.defineProperty(exports, 'score_threshold_exports', {
+  enumerable: true,
+  get: function () {
+    return score_threshold_exports;
+  }
+});
+//# sourceMappingURL=score_threshold.cjs.map

package/dist/retrievers/score_threshold.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"score_threshold.cjs","names":["VectorStoreRetriever","input: ScoreThresholdRetrieverInput<V>","query: string","filteredResults: [Document, number][]","vectorStore: V","options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">"],"sources":["../../src/retrievers/score_threshold.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<\n  VectorStoreRetrieverInput<V>,\n  \"k\"\n> & {\n  maxK?: number;\n  kIncrement?: number;\n  minSimilarityScore: number;\n};\n\nexport class ScoreThresholdRetriever<\n  V extends VectorStore\n> extends VectorStoreRetriever<V> {\n  minSimilarityScore: number;\n\n  kIncrement = 10;\n\n  maxK = 100;\n\n  constructor(input: ScoreThresholdRetrieverInput<V>) {\n    super(input);\n    this.maxK = input.maxK ?? this.maxK;\n    this.minSimilarityScore =\n      input.minSimilarityScore ?? this.minSimilarityScore;\n    this.kIncrement = input.kIncrement ?? this.kIncrement;\n  }\n\n  async invoke(query: string): Promise<Document[]> {\n    let currentK = 0;\n    let filteredResults: [Document, number][] = [];\n    do {\n      currentK += this.kIncrement;\n      const results = await this.vectorStore.similaritySearchWithScore(\n        query,\n        currentK,\n        this.filter\n      );\n      filteredResults = results.filter(\n        ([, score]) => score >= this.minSimilarityScore\n      );\n    } while (filteredResults.length >= currentK && currentK < this.maxK);\n    return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);\n  }\n\n  static fromVectorStore<V extends VectorStore>(\n    vectorStore: V,\n    options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">\n  ) {\n    return new this<V>({ ...options, vectorStore });\n  }\n}\n"],"mappings":";;;;;;AAgBA,IAAa,0BAAb,cAEUA,mDAAwB;CAChC;CAEA,aAAa;CAEb,OAAO;CAEP,YAAYC,OAAwC;EAClD,MAAM,MAAM;EACZ,KAAK,OAAO,MAAM,QAAQ,KAAK;EAC/B,KAAK,qBACH,MAAM,sBAAsB,KAAK;EACnC,KAAK,aAAa,MAAM,cAAc,KAAK;CAC5C;CAED,MAAM,OAAOC,OAAoC;EAC/C,IAAI,WAAW;EACf,IAAIC,kBAAwC,CAAE;AAC9C,KAAG;GACD,YAAY,KAAK;GACjB,MAAM,UAAU,MAAM,KAAK,YAAY,0BACrC,OACA,UACA,KAAK,OACN;GACD,kBAAkB,QAAQ,OACxB,CAAC,GAAG,MAAM,KAAK,SAAS,KAAK,mBAC9B;EACF,SAAQ,gBAAgB,UAAU,YAAY,WAAW,KAAK;AAC/D,SAAO,gBAAgB,IAAI,CAAC,cAAc,UAAU,GAAG,CAAC,MAAM,GAAG,KAAK,KAAK;CAC5E;CAED,OAAO,gBACLC,aACAC,SACA;AACA,SAAO,IAAI,KAAQ;GAAE,GAAG;GAAS;EAAa;CAC/C;AACF"}

package/dist/retrievers/score_threshold.d.cts

@@ -0,0 +1,20 @@
+import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
+import { Document } from "@langchain/core/documents";
+
+//#region src/retrievers/score_threshold.d.ts
+type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<VectorStoreRetrieverInput<V>, "k"> & {
+  maxK?: number;
+  kIncrement?: number;
+  minSimilarityScore: number;
+};
+declare class ScoreThresholdRetriever<V extends VectorStore> extends VectorStoreRetriever<V> {
+  minSimilarityScore: number;
+  kIncrement: number;
+  maxK: number;
+  constructor(input: ScoreThresholdRetrieverInput<V>);
+  invoke(query: string): Promise<Document[]>;
+  static fromVectorStore<V extends VectorStore>(vectorStore: V, options: Omit<ScoreThresholdRetrieverInput<V>, "vectorStore">): ScoreThresholdRetriever<V>;
+}
+//#endregion
+export { ScoreThresholdRetriever, ScoreThresholdRetrieverInput };
+//# sourceMappingURL=score_threshold.d.cts.map

package/dist/retrievers/score_threshold.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"score_threshold.d.cts","names":["Document","VectorStore","VectorStoreRetriever","VectorStoreRetrieverInput","ScoreThresholdRetrieverInput","V","Omit","ScoreThresholdRetriever","Promise"],"sources":["../../src/retrievers/score_threshold.d.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from \"@langchain/core/vectorstores\";\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<VectorStoreRetrieverInput<V>, \"k\"> & {\n    maxK?: number;\n    kIncrement?: number;\n    minSimilarityScore: number;\n};\nexport declare class ScoreThresholdRetriever<V extends VectorStore> extends VectorStoreRetriever<V> {\n    minSimilarityScore: number;\n    kIncrement: number;\n    maxK: number;\n    constructor(input: ScoreThresholdRetrieverInput<V>);\n    invoke(query: string): Promise<Document[]>;\n    static fromVectorStore<V extends VectorStore>(vectorStore: V, options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">): ScoreThresholdRetriever<V>;\n}\n"],"mappings":";;;;KAEYI,uCAAuCH,eAAeK,KAAKH,0BAA0BE;;EAArFD,UAAAA,CAAAA,EAAAA,MAAAA;EAA4B,kBAAA,EAAA,MAAA;CAAA;AAAyDC,cAK5EE,uBAL4EF,CAAAA,UAK1CJ,WAL0CI,CAAAA,SAKrBH,oBALqBG,CAKAA,CALAA,CAAAA,CAAAA;EAAC,kBAA3BF,EAAAA,MAAAA;EAAyB,UAA9BG,EAAAA,MAAAA;EAAI,IAAA,EAAA,MAAA;EAKjDC,WAAAA,CAAAA,KAAAA,EAIEH,4BAJqB,CAIQC,CAJR,CAAA;EAAA,MAAA,CAAA,KAAA,EAAA,MAAA,CAAA,EAKjBG,OALiB,CAKTR,QALS,EAAA,CAAA;EAAA,OAAWC,eAAAA,CAAAA,UAMlBA,WANkBA,CAAAA,CAAAA,WAAAA,EAMQI,CANRJ,EAAAA,OAAAA,EAMoBK,IANpBL,CAMyBG,4BANzBH,CAMsDI,CANtDJ,CAAAA,EAAAA,aAAAA,CAAAA,CAAAA,EAM2EM,uBAN3EN,CAMmGI,CANnGJ,CAAAA"}

package/dist/retrievers/score_threshold.d.ts

@@ -0,0 +1,20 @@
+import { Document } from "@langchain/core/documents";
+import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
+
+//#region src/retrievers/score_threshold.d.ts
+type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<VectorStoreRetrieverInput<V>, "k"> & {
+  maxK?: number;
+  kIncrement?: number;
+  minSimilarityScore: number;
+};
+declare class ScoreThresholdRetriever<V extends VectorStore> extends VectorStoreRetriever<V> {
+  minSimilarityScore: number;
+  kIncrement: number;
+  maxK: number;
+  constructor(input: ScoreThresholdRetrieverInput<V>);
+  invoke(query: string): Promise<Document[]>;
+  static fromVectorStore<V extends VectorStore>(vectorStore: V, options: Omit<ScoreThresholdRetrieverInput<V>, "vectorStore">): ScoreThresholdRetriever<V>;
+}
+//#endregion
+export { ScoreThresholdRetriever, ScoreThresholdRetrieverInput };
+//# sourceMappingURL=score_threshold.d.ts.map

package/dist/retrievers/score_threshold.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"score_threshold.d.ts","names":["Document","VectorStore","VectorStoreRetriever","VectorStoreRetrieverInput","ScoreThresholdRetrieverInput","V","Omit","ScoreThresholdRetriever","Promise"],"sources":["../../src/retrievers/score_threshold.d.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from \"@langchain/core/vectorstores\";\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<VectorStoreRetrieverInput<V>, \"k\"> & {\n    maxK?: number;\n    kIncrement?: number;\n    minSimilarityScore: number;\n};\nexport declare class ScoreThresholdRetriever<V extends VectorStore> extends VectorStoreRetriever<V> {\n    minSimilarityScore: number;\n    kIncrement: number;\n    maxK: number;\n    constructor(input: ScoreThresholdRetrieverInput<V>);\n    invoke(query: string): Promise<Document[]>;\n    static fromVectorStore<V extends VectorStore>(vectorStore: V, options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">): ScoreThresholdRetriever<V>;\n}\n"],"mappings":";;;;KAEYI,uCAAuCH,eAAeK,KAAKH,0BAA0BE;;EAArFD,UAAAA,CAAAA,EAAAA,MAAAA;EAA4B,kBAAA,EAAA,MAAA;CAAA;AAAyDC,cAK5EE,uBAL4EF,CAAAA,UAK1CJ,WAL0CI,CAAAA,SAKrBH,oBALqBG,CAKAA,CALAA,CAAAA,CAAAA;EAAC,kBAA3BF,EAAAA,MAAAA;EAAyB,UAA9BG,EAAAA,MAAAA;EAAI,IAAA,EAAA,MAAA;EAKjDC,WAAAA,CAAAA,KAAAA,EAIEH,4BAJqB,CAIQC,CAJR,CAAA;EAAA,MAAA,CAAA,KAAA,EAAA,MAAA,CAAA,EAKjBG,OALiB,CAKTR,QALS,EAAA,CAAA;EAAA,OAAWC,eAAAA,CAAAA,UAMlBA,WANkBA,CAAAA,CAAAA,WAAAA,EAMQI,CANRJ,EAAAA,OAAAA,EAMoBK,IANpBL,CAMyBG,4BANzBH,CAMsDI,CANtDJ,CAAAA,EAAAA,aAAAA,CAAAA,CAAAA,EAM2EM,uBAN3EN,CAMmGI,CANnGJ,CAAAA"}

package/dist/retrievers/score_threshold.js

@@ -0,0 +1,37 @@
+import { __export } from "../_virtual/rolldown_runtime.js";
+import { VectorStoreRetriever } from "@langchain/core/vectorstores";
+
+//#region src/retrievers/score_threshold.ts
+var score_threshold_exports = {};
+__export(score_threshold_exports, { ScoreThresholdRetriever: () => ScoreThresholdRetriever });
+var ScoreThresholdRetriever = class extends VectorStoreRetriever {
+	minSimilarityScore;
+	kIncrement = 10;
+	maxK = 100;
+	constructor(input) {
+		super(input);
+		this.maxK = input.maxK ?? this.maxK;
+		this.minSimilarityScore = input.minSimilarityScore ?? this.minSimilarityScore;
+		this.kIncrement = input.kIncrement ?? this.kIncrement;
+	}
+	async invoke(query) {
+		let currentK = 0;
+		let filteredResults = [];
+		do {
+			currentK += this.kIncrement;
+			const results = await this.vectorStore.similaritySearchWithScore(query, currentK, this.filter);
+			filteredResults = results.filter(([, score]) => score >= this.minSimilarityScore);
+		} while (filteredResults.length >= currentK && currentK < this.maxK);
+		return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);
+	}
+	static fromVectorStore(vectorStore, options) {
+		return new this({
+			...options,
+			vectorStore
+		});
+	}
+};
+
+//#endregion
+export { ScoreThresholdRetriever, score_threshold_exports };
+//# sourceMappingURL=score_threshold.js.map

package/dist/retrievers/score_threshold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"score_threshold.js","names":["input: ScoreThresholdRetrieverInput<V>","query: string","filteredResults: [Document, number][]","vectorStore: V","options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">"],"sources":["../../src/retrievers/score_threshold.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<\n  VectorStoreRetrieverInput<V>,\n  \"k\"\n> & {\n  maxK?: number;\n  kIncrement?: number;\n  minSimilarityScore: number;\n};\n\nexport class ScoreThresholdRetriever<\n  V extends VectorStore\n> extends VectorStoreRetriever<V> {\n  minSimilarityScore: number;\n\n  kIncrement = 10;\n\n  maxK = 100;\n\n  constructor(input: ScoreThresholdRetrieverInput<V>) {\n    super(input);\n    this.maxK = input.maxK ?? this.maxK;\n    this.minSimilarityScore =\n      input.minSimilarityScore ?? this.minSimilarityScore;\n    this.kIncrement = input.kIncrement ?? this.kIncrement;\n  }\n\n  async invoke(query: string): Promise<Document[]> {\n    let currentK = 0;\n    let filteredResults: [Document, number][] = [];\n    do {\n      currentK += this.kIncrement;\n      const results = await this.vectorStore.similaritySearchWithScore(\n        query,\n        currentK,\n        this.filter\n      );\n      filteredResults = results.filter(\n        ([, score]) => score >= this.minSimilarityScore\n      );\n    } while (filteredResults.length >= currentK && currentK < this.maxK);\n    return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);\n  }\n\n  static fromVectorStore<V extends VectorStore>(\n    vectorStore: V,\n    options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">\n  ) {\n    return new this<V>({ ...options, vectorStore });\n  }\n}\n"],"mappings":";;;;;;AAgBA,IAAa,0BAAb,cAEU,qBAAwB;CAChC;CAEA,aAAa;CAEb,OAAO;CAEP,YAAYA,OAAwC;EAClD,MAAM,MAAM;EACZ,KAAK,OAAO,MAAM,QAAQ,KAAK;EAC/B,KAAK,qBACH,MAAM,sBAAsB,KAAK;EACnC,KAAK,aAAa,MAAM,cAAc,KAAK;CAC5C;CAED,MAAM,OAAOC,OAAoC;EAC/C,IAAI,WAAW;EACf,IAAIC,kBAAwC,CAAE;AAC9C,KAAG;GACD,YAAY,KAAK;GACjB,MAAM,UAAU,MAAM,KAAK,YAAY,0BACrC,OACA,UACA,KAAK,OACN;GACD,kBAAkB,QAAQ,OACxB,CAAC,GAAG,MAAM,KAAK,SAAS,KAAK,mBAC9B;EACF,SAAQ,gBAAgB,UAAU,YAAY,WAAW,KAAK;AAC/D,SAAO,gBAAgB,IAAI,CAAC,cAAc,UAAU,GAAG,CAAC,MAAM,GAAG,KAAK,KAAK;CAC5E;CAED,OAAO,gBACLC,aACAC,SACA;AACA,SAAO,IAAI,KAAQ;GAAE,GAAG;GAAS;EAAa;CAC/C;AACF"}

package/dist/retrievers/self_query/functional.cjs

@@ -0,0 +1,21 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const __langchain_core_structured_query = require_rolldown_runtime.__toESM(require("@langchain/core/structured_query"));
+
+//#region src/retrievers/self_query/functional.ts
+var functional_exports = {};
+require_rolldown_runtime.__export(functional_exports, { FunctionalTranslator: () => __langchain_core_structured_query.FunctionalTranslator });
+
+//#endregion
+Object.defineProperty(exports, 'FunctionalTranslator', {
+  enumerable: true,
+  get: function () {
+    return __langchain_core_structured_query.FunctionalTranslator;
+  }
+});
+Object.defineProperty(exports, 'functional_exports', {
+  enumerable: true,
+  get: function () {
+    return functional_exports;
+  }
+});
+//# sourceMappingURL=functional.cjs.map

package/dist/retrievers/self_query/functional.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"functional.cjs","names":[],"sources":["../../../src/retrievers/self_query/functional.ts"],"sourcesContent":["export {\n  type FunctionFilter,\n  FunctionalTranslator,\n} from \"@langchain/core/structured_query\";\n"],"mappings":""}

package/dist/retrievers/self_query/functional.d.cts

@@ -0,0 +1,2 @@
+import { FunctionFilter, FunctionalTranslator } from "@langchain/core/structured_query";
+export { type FunctionFilter, FunctionalTranslator };

package/dist/retrievers/self_query/functional.d.ts

@@ -0,0 +1,2 @@
+import { FunctionFilter, FunctionalTranslator } from "@langchain/core/structured_query";
+export { type FunctionFilter, FunctionalTranslator };

package/dist/retrievers/self_query/functional.js

@@ -0,0 +1,10 @@
+import { __export } from "../../_virtual/rolldown_runtime.js";
+import { FunctionalTranslator } from "@langchain/core/structured_query";
+
+//#region src/retrievers/self_query/functional.ts
+var functional_exports = {};
+__export(functional_exports, { FunctionalTranslator: () => FunctionalTranslator });
+
+//#endregion
+export { FunctionalTranslator, functional_exports };
+//# sourceMappingURL=functional.js.map

package/dist/retrievers/self_query/functional.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functional.js","names":[],"sources":["../../../src/retrievers/self_query/functional.ts"],"sourcesContent":["export {\n  type FunctionFilter,\n  FunctionalTranslator,\n} from \"@langchain/core/structured_query\";\n"],"mappings":""}

package/dist/retrievers/self_query/index.cjs

@@ -0,0 +1,130 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_chains_query_constructor_index = require('../../chains/query_constructor/index.cjs');
+const __langchain_core_structured_query = require_rolldown_runtime.__toESM(require("@langchain/core/structured_query"));
+const __langchain_core_retrievers = require_rolldown_runtime.__toESM(require("@langchain/core/retrievers"));
+
+//#region src/retrievers/self_query/index.ts
+var self_query_exports = {};
+require_rolldown_runtime.__export(self_query_exports, {
+	BaseTranslator: () => __langchain_core_structured_query.BaseTranslator,
+	BasicTranslator: () => __langchain_core_structured_query.BasicTranslator,
+	FunctionalTranslator: () => __langchain_core_structured_query.FunctionalTranslator,
+	SelfQueryRetriever: () => SelfQueryRetriever
+});
+/**
+* Class for question answering over an index. It retrieves relevant
+* documents based on a query. It extends the BaseRetriever class and
+* implements the SelfQueryRetrieverArgs interface.
+* @example
+* ```typescript
+* const selfQueryRetriever = SelfQueryRetriever.fromLLM({
+*   llm: new ChatOpenAI({ model: "gpt-4o-mini" }),
+*   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),
+*   documentContents: "Brief summary of a movie",
+*   attributeInfo: attributeInfo,
+*   structuredQueryTranslator: new FunctionalTranslator(),
+* });
+* const relevantDocuments = await selfQueryRetriever.invoke(
+*   "Which movies are directed by Greta Gerwig?",
+* );
+* ```
+*/
+var SelfQueryRetriever = class SelfQueryRetriever extends __langchain_core_retrievers.BaseRetriever {
+	static lc_name() {
+		return "SelfQueryRetriever";
+	}
+	get lc_namespace() {
+		return [
+			"langchain",
+			"retrievers",
+			"self_query"
+		];
+	}
+	vectorStore;
+	queryConstructor;
+	verbose;
+	structuredQueryTranslator;
+	useOriginalQuery = false;
+	searchParams = {
+		k: 4,
+		forceDefaultFilter: false
+	};
+	constructor(options) {
+		super(options);
+		this.vectorStore = options.vectorStore;
+		this.queryConstructor = options.queryConstructor;
+		this.verbose = options.verbose ?? false;
+		this.searchParams = options.searchParams ?? this.searchParams;
+		this.useOriginalQuery = options.useOriginalQuery ?? this.useOriginalQuery;
+		this.structuredQueryTranslator = options.structuredQueryTranslator;
+	}
+	async _getRelevantDocuments(query, runManager) {
+		const generatedStructuredQuery = await this.queryConstructor.invoke({ query }, {
+			callbacks: runManager?.getChild("query_constructor"),
+			runName: "query_constructor"
+		});
+		const nextArg = this.structuredQueryTranslator.visitStructuredQuery(generatedStructuredQuery);
+		const filter = this.structuredQueryTranslator.mergeFilters(this.searchParams?.filter, nextArg.filter, this.searchParams?.mergeFiltersOperator, this.searchParams?.forceDefaultFilter);
+		const generatedQuery = generatedStructuredQuery.query;
+		let myQuery = query;
+		if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) myQuery = generatedQuery;
+		return this.vectorStore.asRetriever({
+			k: this.searchParams?.k,
+			filter
+		}).invoke(myQuery, { callbacks: runManager?.getChild("retriever") });
+	}
+	/**
+	* Static method to create a new SelfQueryRetriever instance from a
+	* BaseLanguageModel and a VectorStore. It first loads a query constructor
+	* chain using the loadQueryConstructorChain function, then creates a new
+	* SelfQueryRetriever instance with the loaded chain and the provided
+	* options.
+	* @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.
+	* @returns A new instance of SelfQueryRetriever.
+	*/
+	static fromLLM(options) {
+		const { structuredQueryTranslator, allowedComparators, allowedOperators, llm, documentContents, attributeInfo, examples, vectorStore,...rest } = options;
+		const queryConstructor = require_chains_query_constructor_index.loadQueryConstructorRunnable({
+			llm,
+			documentContents,
+			attributeInfo,
+			examples,
+			allowedComparators: allowedComparators ?? structuredQueryTranslator.allowedComparators,
+			allowedOperators: allowedOperators ?? structuredQueryTranslator.allowedOperators
+		});
+		return new SelfQueryRetriever({
+			...rest,
+			queryConstructor,
+			vectorStore,
+			structuredQueryTranslator
+		});
+	}
+};
+
+//#endregion
+Object.defineProperty(exports, 'BaseTranslator', {
+  enumerable: true,
+  get: function () {
+    return __langchain_core_structured_query.BaseTranslator;
+  }
+});
+Object.defineProperty(exports, 'BasicTranslator', {
+  enumerable: true,
+  get: function () {
+    return __langchain_core_structured_query.BasicTranslator;
+  }
+});
+Object.defineProperty(exports, 'FunctionalTranslator', {
+  enumerable: true,
+  get: function () {
+    return __langchain_core_structured_query.FunctionalTranslator;
+  }
+});
+exports.SelfQueryRetriever = SelfQueryRetriever;
+Object.defineProperty(exports, 'self_query_exports', {
+  enumerable: true,
+  get: function () {
+    return self_query_exports;
+  }
+});
+//# sourceMappingURL=index.cjs.map

package/dist/retrievers/self_query/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":["BaseRetriever","options: SelfQueryRetrieverArgs<T>","query: string","runManager?: CallbackManagerForRetrieverRun","options: QueryConstructorRunnableOptions &\n      Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">","loadQueryConstructorRunnable"],"sources":["../../../src/retrievers/self_query/index.ts"],"sourcesContent":["import { RunnableInterface } from \"@langchain/core/runnables\";\nimport {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { VectorStore } from \"@langchain/core/vectorstores\";\nimport {\n  BaseTranslator,\n  StructuredQuery,\n} from \"@langchain/core/structured_query\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  loadQueryConstructorRunnable,\n  QueryConstructorRunnableOptions,\n} from \"../../chains/query_constructor/index.js\";\n\nexport { BaseTranslator } from \"@langchain/core/structured_query\";\nexport {\n  BasicTranslator,\n  FunctionalTranslator,\n} from \"@langchain/core/structured_query\";\n\n/**\n * Interface for the arguments required to create a SelfQueryRetriever\n * instance. It extends the BaseRetrieverInput interface.\n */\nexport interface SelfQueryRetrieverArgs<T extends VectorStore>\n  extends BaseRetrieverInput {\n  vectorStore: T;\n  structuredQueryTranslator: BaseTranslator<T>;\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n  verbose?: boolean;\n  useOriginalQuery?: boolean;\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  };\n}\n\n/**\n * Class for question answering over an index. It retrieves relevant\n * documents based on a query. It extends the BaseRetriever class and\n * implements the SelfQueryRetrieverArgs interface.\n * @example\n * ```typescript\n * const selfQueryRetriever = SelfQueryRetriever.fromLLM({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),\n *   documentContents: \"Brief summary of a movie\",\n *   attributeInfo: attributeInfo,\n *   structuredQueryTranslator: new FunctionalTranslator(),\n * });\n * const relevantDocuments = await selfQueryRetriever.invoke(\n *   \"Which movies are directed by Greta Gerwig?\",\n * );\n * ```\n */\nexport class SelfQueryRetriever<T extends VectorStore>\n  extends BaseRetriever\n  implements SelfQueryRetrieverArgs<T>\n{\n  static lc_name() {\n    return \"SelfQueryRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"self_query\"];\n  }\n\n  vectorStore: T;\n\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n\n  verbose?: boolean;\n\n  structuredQueryTranslator: BaseTranslator<T>;\n\n  useOriginalQuery = false;\n\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  } = { k: 4, forceDefaultFilter: false };\n\n  constructor(options: SelfQueryRetrieverArgs<T>) {\n    super(options);\n    this.vectorStore = options.vectorStore;\n    this.queryConstructor = options.queryConstructor;\n    this.verbose = options.verbose ?? false;\n    this.searchParams = options.searchParams ?? this.searchParams;\n    this.useOriginalQuery = options.useOriginalQuery ?? this.useOriginalQuery;\n    this.structuredQueryTranslator = options.structuredQueryTranslator;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document<Record<string, unknown>>[]> {\n    const generatedStructuredQuery = await this.queryConstructor.invoke(\n      { query },\n      {\n        callbacks: runManager?.getChild(\"query_constructor\"),\n        runName: \"query_constructor\",\n      }\n    );\n\n    const nextArg = this.structuredQueryTranslator.visitStructuredQuery(\n      generatedStructuredQuery\n    );\n\n    const filter = this.structuredQueryTranslator.mergeFilters(\n      this.searchParams?.filter,\n      nextArg.filter,\n      this.searchParams?.mergeFiltersOperator,\n      this.searchParams?.forceDefaultFilter\n    );\n\n    const generatedQuery = generatedStructuredQuery.query;\n    let myQuery = query;\n\n    if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) {\n      myQuery = generatedQuery;\n    }\n\n    return this.vectorStore\n      .asRetriever({\n        k: this.searchParams?.k,\n        filter,\n      })\n      .invoke(myQuery, { callbacks: runManager?.getChild(\"retriever\") });\n  }\n\n  /**\n   * Static method to create a new SelfQueryRetriever instance from a\n   * BaseLanguageModel and a VectorStore. It first loads a query constructor\n   * chain using the loadQueryConstructorChain function, then creates a new\n   * SelfQueryRetriever instance with the loaded chain and the provided\n   * options.\n   * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.\n   * @returns A new instance of SelfQueryRetriever.\n   */\n  static fromLLM<T extends VectorStore>(\n    options: QueryConstructorRunnableOptions &\n      Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">\n  ): SelfQueryRetriever<T> {\n    const {\n      structuredQueryTranslator,\n      allowedComparators,\n      allowedOperators,\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      vectorStore,\n      ...rest\n    } = options;\n    const queryConstructor = loadQueryConstructorRunnable({\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      allowedComparators:\n        allowedComparators ?? structuredQueryTranslator.allowedComparators,\n      allowedOperators:\n        allowedOperators ?? structuredQueryTranslator.allowedOperators,\n    });\n    return new SelfQueryRetriever<T>({\n      ...rest,\n      queryConstructor,\n      vectorStore,\n      structuredQueryTranslator,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DA,IAAa,qBAAb,MAAa,2BACHA,0CAEV;CACE,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI,eAAe;AACjB,SAAO;GAAC;GAAa;GAAc;EAAa;CACjD;CAED;CAEA;CAEA;CAEA;CAEA,mBAAmB;CAEnB,eAKI;EAAE,GAAG;EAAG,oBAAoB;CAAO;CAEvC,YAAYC,SAAoC;EAC9C,MAAM,QAAQ;EACd,KAAK,cAAc,QAAQ;EAC3B,KAAK,mBAAmB,QAAQ;EAChC,KAAK,UAAU,QAAQ,WAAW;EAClC,KAAK,eAAe,QAAQ,gBAAgB,KAAK;EACjD,KAAK,mBAAmB,QAAQ,oBAAoB,KAAK;EACzD,KAAK,4BAA4B,QAAQ;CAC1C;CAED,MAAM,sBACJC,OACAC,YAC8C;EAC9C,MAAM,2BAA2B,MAAM,KAAK,iBAAiB,OAC3D,EAAE,MAAO,GACT;GACE,WAAW,YAAY,SAAS,oBAAoB;GACpD,SAAS;EACV,EACF;EAED,MAAM,UAAU,KAAK,0BAA0B,qBAC7C,yBACD;EAED,MAAM,SAAS,KAAK,0BAA0B,aAC5C,KAAK,cAAc,QACnB,QAAQ,QACR,KAAK,cAAc,sBACnB,KAAK,cAAc,mBACpB;EAED,MAAM,iBAAiB,yBAAyB;EAChD,IAAI,UAAU;AAEd,MAAI,CAAC,KAAK,oBAAoB,kBAAkB,eAAe,SAAS,GACtE,UAAU;AAGZ,SAAO,KAAK,YACT,YAAY;GACX,GAAG,KAAK,cAAc;GACtB;EACD,EAAC,CACD,OAAO,SAAS,EAAE,WAAW,YAAY,SAAS,YAAY,CAAE,EAAC;CACrE;;;;;;;;;;CAWD,OAAO,QACLC,SAEuB;EACvB,MAAM,EACJ,2BACA,oBACA,kBACA,KACA,kBACA,eACA,UACA,YACA,GAAG,MACJ,GAAG;EACJ,MAAM,mBAAmBC,oEAA6B;GACpD;GACA;GACA;GACA;GACA,oBACE,sBAAsB,0BAA0B;GAClD,kBACE,oBAAoB,0BAA0B;EACjD,EAAC;AACF,SAAO,IAAI,mBAAsB;GAC/B,GAAG;GACH;GACA;GACA;EACD;CACF;AACF"}

package/dist/retrievers/self_query/index.d.cts

@@ -0,0 +1,79 @@
+import { QueryConstructorRunnableOptions } from "../../chains/query_constructor/index.cjs";
+import { RunnableInterface } from "@langchain/core/runnables";
+import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
+import { VectorStore } from "@langchain/core/vectorstores";
+import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
+import { Document } from "@langchain/core/documents";
+import { BaseTranslator, BaseTranslator as BaseTranslator$1, BasicTranslator, FunctionalTranslator, StructuredQuery } from "@langchain/core/structured_query";
+
+//#region src/retrievers/self_query/index.d.ts
+
+/**
+ * Interface for the arguments required to create a SelfQueryRetriever
+ * instance. It extends the BaseRetrieverInput interface.
+ */
+interface SelfQueryRetrieverArgs<T extends VectorStore> extends BaseRetrieverInput {
+  vectorStore: T;
+  structuredQueryTranslator: BaseTranslator$1<T>;
+  queryConstructor: RunnableInterface<{
+    query: string;
+  }, StructuredQuery>;
+  verbose?: boolean;
+  useOriginalQuery?: boolean;
+  searchParams?: {
+    k?: number;
+    filter?: T["FilterType"];
+    mergeFiltersOperator?: "or" | "and" | "replace";
+    forceDefaultFilter?: boolean;
+  };
+}
+/**
+ * Class for question answering over an index. It retrieves relevant
+ * documents based on a query. It extends the BaseRetriever class and
+ * implements the SelfQueryRetrieverArgs interface.
+ * @example
+ * ```typescript
+ * const selfQueryRetriever = SelfQueryRetriever.fromLLM({
+ *   llm: new ChatOpenAI({ model: "gpt-4o-mini" }),
+ *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),
+ *   documentContents: "Brief summary of a movie",
+ *   attributeInfo: attributeInfo,
+ *   structuredQueryTranslator: new FunctionalTranslator(),
+ * });
+ * const relevantDocuments = await selfQueryRetriever.invoke(
+ *   "Which movies are directed by Greta Gerwig?",
+ * );
+ * ```
+ */
+declare class SelfQueryRetriever<T extends VectorStore> extends BaseRetriever implements SelfQueryRetrieverArgs<T> {
+  static lc_name(): string;
+  get lc_namespace(): string[];
+  vectorStore: T;
+  queryConstructor: RunnableInterface<{
+    query: string;
+  }, StructuredQuery>;
+  verbose?: boolean;
+  structuredQueryTranslator: BaseTranslator$1<T>;
+  useOriginalQuery: boolean;
+  searchParams?: {
+    k?: number;
+    filter?: T["FilterType"];
+    mergeFiltersOperator?: "or" | "and" | "replace";
+    forceDefaultFilter?: boolean;
+  };
+  constructor(options: SelfQueryRetrieverArgs<T>);
+  _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, unknown>>[]>;
+  /**
+   * Static method to create a new SelfQueryRetriever instance from a
+   * BaseLanguageModel and a VectorStore. It first loads a query constructor
+   * chain using the loadQueryConstructorChain function, then creates a new
+   * SelfQueryRetriever instance with the loaded chain and the provided
+   * options.
+   * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.
+   * @returns A new instance of SelfQueryRetriever.
+   */
+  static fromLLM<T extends VectorStore>(options: QueryConstructorRunnableOptions & Omit<SelfQueryRetrieverArgs<T>, "queryConstructor">): SelfQueryRetriever<T>;
+}
+//#endregion
+export { BaseTranslator, BasicTranslator, FunctionalTranslator, SelfQueryRetriever, SelfQueryRetrieverArgs };
+//# sourceMappingURL=index.d.cts.map

package/dist/retrievers/self_query/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":["RunnableInterface","BaseRetriever","BaseRetrieverInput","Document","VectorStore","BaseTranslator","StructuredQuery","CallbackManagerForRetrieverRun","QueryConstructorRunnableOptions","BasicTranslator","FunctionalTranslator","SelfQueryRetrieverArgs","T","SelfQueryRetriever","Record","Promise","Omit"],"sources":["../../../src/retrievers/self_query/index.d.ts"],"sourcesContent":["import { RunnableInterface } from \"@langchain/core/runnables\";\nimport { BaseRetriever, type BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { VectorStore } from \"@langchain/core/vectorstores\";\nimport { BaseTranslator, StructuredQuery } from \"@langchain/core/structured_query\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { QueryConstructorRunnableOptions } from \"../../chains/query_constructor/index.js\";\nexport { BaseTranslator } from \"@langchain/core/structured_query\";\nexport { BasicTranslator, FunctionalTranslator, } from \"@langchain/core/structured_query\";\n/**\n * Interface for the arguments required to create a SelfQueryRetriever\n * instance. It extends the BaseRetrieverInput interface.\n */\nexport interface SelfQueryRetrieverArgs<T extends VectorStore> extends BaseRetrieverInput {\n    vectorStore: T;\n    structuredQueryTranslator: BaseTranslator<T>;\n    queryConstructor: RunnableInterface<{\n        query: string;\n    }, StructuredQuery>;\n    verbose?: boolean;\n    useOriginalQuery?: boolean;\n    searchParams?: {\n        k?: number;\n        filter?: T[\"FilterType\"];\n        mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n        forceDefaultFilter?: boolean;\n    };\n}\n/**\n * Class for question answering over an index. It retrieves relevant\n * documents based on a query. It extends the BaseRetriever class and\n * implements the SelfQueryRetrieverArgs interface.\n * @example\n * ```typescript\n * const selfQueryRetriever = SelfQueryRetriever.fromLLM({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),\n *   documentContents: \"Brief summary of a movie\",\n *   attributeInfo: attributeInfo,\n *   structuredQueryTranslator: new FunctionalTranslator(),\n * });\n * const relevantDocuments = await selfQueryRetriever.invoke(\n *   \"Which movies are directed by Greta Gerwig?\",\n * );\n * ```\n */\nexport declare class SelfQueryRetriever<T extends VectorStore> extends BaseRetriever implements SelfQueryRetrieverArgs<T> {\n    static lc_name(): string;\n    get lc_namespace(): string[];\n    vectorStore: T;\n    queryConstructor: RunnableInterface<{\n        query: string;\n    }, StructuredQuery>;\n    verbose?: boolean;\n    structuredQueryTranslator: BaseTranslator<T>;\n    useOriginalQuery: boolean;\n    searchParams?: {\n        k?: number;\n        filter?: T[\"FilterType\"];\n        mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n        forceDefaultFilter?: boolean;\n    };\n    constructor(options: SelfQueryRetrieverArgs<T>);\n    _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, unknown>>[]>;\n    /**\n     * Static method to create a new SelfQueryRetriever instance from a\n     * BaseLanguageModel and a VectorStore. It first loads a query constructor\n     * chain using the loadQueryConstructorChain function, then creates a new\n     * SelfQueryRetriever instance with the loaded chain and the provided\n     * options.\n     * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.\n     * @returns A new instance of SelfQueryRetriever.\n     */\n    static fromLLM<T extends VectorStore>(options: QueryConstructorRunnableOptions & Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">): SelfQueryRetriever<T>;\n}\n"],"mappings":";;;;;;;;;;AAaA;;;;AAE8CY,UAF7BD,sBAE6BC,CAAAA,UAFIR,WAEJQ,CAAAA,SAFyBV,kBAEzBU,CAAAA;EAAC,WAAhBP,EADdO,CACcP;EAAc,yBAGtCC,EAHwBD,gBAGxBC,CAHuCM,CAGvCN,CAAAA;EAAe,gBAFAN,EAAAA,iBAAAA,CAAAA;IAOLY,KAAAA,EAAAA,MAAAA;EAAC,CAAA,EALXN,eALgEJ,CAAAA;EAAkB,OAAA,CAAA,EAAA,OAAA;EAiCpEW,gBAAAA,CAAAA,EAAAA,OAAkB;EAAA,YAAA,CAAA,EAAA;IAAWT,CAAAA,CAAAA,EAAAA,MAAAA;IAAqEQ,MAAAA,CAAAA,EAvBtGA,CAuBsGA,CAAAA,YAAAA,CAAAA;IAGtGA,oBAAAA,CAAAA,EAAAA,IAAAA,GAAAA,KAAAA,GAAAA,SAAAA;IAGVN,kBAAAA,CAAAA,EAAAA,OAAAA;EAAe,CAAA;;;;;;;;;;;;;;;;;;;AANgG;cAAjGO,6BAA6BT,qBAAqBH,aAAAA,YAAyBU,uBAAuBC;;;eAGtGA;oBACKZ;;KAEfM;;6BAEwBD,iBAAeO;;;;aAI7BA;;;;uBAIQD,uBAAuBC;oDACML,iCAAiCQ,QAAQZ,SAASW;;;;;;;;;;2BAU3EV,sBAAsBI,kCAAkCQ,KAAKL,uBAAuBC,0BAA0BC,mBAAmBD"}