@langchain/classic 1.0.0-alpha.1

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

@@ -0,0 +1,79 @@
+import { QueryConstructorRunnableOptions } from "../../chains/query_constructor/index.js";
+import { Document } from "@langchain/core/documents";
+import { RunnableInterface } from "@langchain/core/runnables";
+import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
+import { VectorStore } from "@langchain/core/vectorstores";
+import { BaseTranslator, BaseTranslator as BaseTranslator$1, BasicTranslator, FunctionalTranslator, StructuredQuery } from "@langchain/core/structured_query";
+import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
+
+//#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.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","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"}

package/dist/retrievers/self_query/index.js

@@ -0,0 +1,106 @@
+import { __export } from "../../_virtual/rolldown_runtime.js";
+import { loadQueryConstructorRunnable } from "../../chains/query_constructor/index.js";
+import { BaseTranslator, BasicTranslator, FunctionalTranslator } from "@langchain/core/structured_query";
+import { BaseRetriever } from "@langchain/core/retrievers";
+
+//#region src/retrievers/self_query/index.ts
+var self_query_exports = {};
+__export(self_query_exports, {
+	BaseTranslator: () => BaseTranslator,
+	BasicTranslator: () => BasicTranslator,
+	FunctionalTranslator: () => 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 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 = loadQueryConstructorRunnable({
+			llm,
+			documentContents,
+			attributeInfo,
+			examples,
+			allowedComparators: allowedComparators ?? structuredQueryTranslator.allowedComparators,
+			allowedOperators: allowedOperators ?? structuredQueryTranslator.allowedOperators
+		});
+		return new SelfQueryRetriever({
+			...rest,
+			queryConstructor,
+			vectorStore,
+			structuredQueryTranslator
+		});
+	}
+};
+
+//#endregion
+export { BaseTranslator, BasicTranslator, FunctionalTranslator, SelfQueryRetriever, self_query_exports };
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["options: SelfQueryRetrieverArgs<T>","query: string","runManager?: CallbackManagerForRetrieverRun","options: QueryConstructorRunnableOptions &\n      Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">"],"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,2BACH,cAEV;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,YAAYA,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,mBAAmB,6BAA6B;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/time_weighted.cjs

@@ -0,0 +1,236 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const __langchain_core_retrievers = require_rolldown_runtime.__toESM(require("@langchain/core/retrievers"));
+
+//#region src/retrievers/time_weighted.ts
+var time_weighted_exports = {};
+require_rolldown_runtime.__export(time_weighted_exports, {
+	BUFFER_IDX: () => BUFFER_IDX,
+	LAST_ACCESSED_AT_KEY: () => LAST_ACCESSED_AT_KEY,
+	TimeWeightedVectorStoreRetriever: () => TimeWeightedVectorStoreRetriever
+});
+const LAST_ACCESSED_AT_KEY = "last_accessed_at";
+const BUFFER_IDX = "buffer_idx";
+/**
+* TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.
+* ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py
+* @example
+* ```typescript
+* const retriever = new TimeWeightedVectorStoreRetriever({
+*   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+*   memoryStream: [],
+*   searchKwargs: 2,
+* });
+* await retriever.addDocuments([
+*   { pageContent: "My name is John.", metadata: {} },
+*   { pageContent: "My favourite food is pizza.", metadata: {} },
+*
+* ]);
+* const results = await retriever.invoke(
+*   "What is my favourite food?",
+* );
+* ```
+*/
+var TimeWeightedVectorStoreRetriever = class extends __langchain_core_retrievers.BaseRetriever {
+	static lc_name() {
+		return "TimeWeightedVectorStoreRetriever";
+	}
+	get lc_namespace() {
+		return [
+			"langchain",
+			"retrievers",
+			"time_weighted"
+		];
+	}
+	/**
+	* The vectorstore to store documents and determine salience.
+	*/
+	vectorStore;
+	/**
+	* The number of top K most relevant documents to consider when searching.
+	*/
+	searchKwargs;
+	/**
+	* The memory_stream of documents to search through.
+	*/
+	memoryStream;
+	/**
+	* The exponential decay factor used as (1.0-decay_rate)**(hrs_passed).
+	*/
+	decayRate;
+	/**
+	* The maximum number of documents to retrieve in a given call.
+	*/
+	k;
+	/**
+	* Other keys in the metadata to factor into the score, e.g. 'importance'.
+	*/
+	otherScoreKeys;
+	/**
+	* The salience to assign memories not retrieved from the vector store.
+	*/
+	defaultSalience;
+	/**
+	* Constructor to initialize the required fields
+	* @param fields - The fields required for initializing the TimeWeightedVectorStoreRetriever
+	*/
+	constructor(fields) {
+		super(fields);
+		this.vectorStore = fields.vectorStore;
+		this.searchKwargs = fields.searchKwargs ?? 100;
+		this.memoryStream = fields.memoryStream ?? [];
+		this.decayRate = fields.decayRate ?? .01;
+		this.k = fields.k ?? 4;
+		this.otherScoreKeys = fields.otherScoreKeys ?? [];
+		this.defaultSalience = fields.defaultSalience ?? null;
+	}
+	/**
+	* Get the memory stream of documents.
+	* @returns The memory stream of documents.
+	*/
+	getMemoryStream() {
+		return this.memoryStream;
+	}
+	/**
+	* Set the memory stream of documents.
+	* @param memoryStream The new memory stream of documents.
+	*/
+	setMemoryStream(memoryStream) {
+		this.memoryStream = memoryStream;
+	}
+	/**
+	* Get relevant documents based on time-weighted relevance
+	* @param query - The query to search for
+	* @returns The relevant documents
+	*/
+	async _getRelevantDocuments(query, runManager) {
+		const now = Math.floor(Date.now() / 1e3);
+		const memoryDocsAndScores = this.getMemoryDocsAndScores();
+		const salientDocsAndScores = await this.getSalientDocuments(query, runManager);
+		const docsAndScores = {
+			...memoryDocsAndScores,
+			...salientDocsAndScores
+		};
+		return this.computeResults(docsAndScores, now);
+	}
+	/**
+	* NOTE: When adding documents to a vector store, use addDocuments
+	* via retriever instead of directly to the vector store.
+	* This is because it is necessary to process the document
+	* in prepareDocuments.
+	*
+	* @param docs - The documents to add to vector store in the retriever
+	*/
+	async addDocuments(docs) {
+		const now = Math.floor(Date.now() / 1e3);
+		const savedDocs = this.prepareDocuments(docs, now);
+		this.memoryStream.push(...savedDocs);
+		await this.vectorStore.addDocuments(savedDocs);
+	}
+	/**
+	* Get memory documents and their scores
+	* @returns An object containing memory documents and their scores
+	*/
+	getMemoryDocsAndScores() {
+		const memoryDocsAndScores = {};
+		for (const doc of this.memoryStream.slice(-this.k)) {
+			const bufferIdx = doc.metadata[BUFFER_IDX];
+			if (bufferIdx === void 0) throw new Error(`Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the "addDocuments" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`);
+			memoryDocsAndScores[bufferIdx] = {
+				doc,
+				score: this.defaultSalience ?? 0
+			};
+		}
+		return memoryDocsAndScores;
+	}
+	/**
+	* Get salient documents and their scores based on the query
+	* @param query - The query to search for
+	* @returns An object containing salient documents and their scores
+	*/
+	async getSalientDocuments(query, runManager) {
+		const docAndScores = await this.vectorStore.similaritySearchWithScore(query, this.searchKwargs, void 0, runManager?.getChild());
+		const results = {};
+		for (const [fetchedDoc, score] of docAndScores) {
+			const bufferIdx = fetchedDoc.metadata[BUFFER_IDX];
+			if (bufferIdx === void 0) throw new Error(`Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the "addDocuments" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`);
+			const doc = this.memoryStream[bufferIdx];
+			results[bufferIdx] = {
+				doc,
+				score
+			};
+		}
+		return results;
+	}
+	/**
+	* Compute the final result set of documents based on the combined scores
+	* @param docsAndScores - An object containing documents and their scores
+	* @param now - The current timestamp
+	* @returns The final set of documents
+	*/
+	computeResults(docsAndScores, now) {
+		const recordedDocs = Object.values(docsAndScores).map(({ doc, score }) => ({
+			doc,
+			score: this.getCombinedScore(doc, score, now)
+		})).sort((a, b) => b.score - a.score);
+		const results = [];
+		for (const { doc } of recordedDocs) {
+			const bufferedDoc = this.memoryStream[doc.metadata[BUFFER_IDX]];
+			bufferedDoc.metadata[LAST_ACCESSED_AT_KEY] = now;
+			results.push(bufferedDoc);
+			if (results.length > this.k) break;
+		}
+		return results;
+	}
+	/**
+	* Prepare documents with necessary metadata before saving
+	* @param docs - The documents to prepare
+	* @param now - The current timestamp
+	* @returns The prepared documents
+	*/
+	prepareDocuments(docs, now) {
+		return docs.map((doc, i) => ({
+			...doc,
+			metadata: {
+				...doc.metadata,
+				[LAST_ACCESSED_AT_KEY]: doc.metadata[LAST_ACCESSED_AT_KEY] ?? now,
+				created_at: doc.metadata.created_at ?? now,
+				[BUFFER_IDX]: this.memoryStream.length + i
+			}
+		}));
+	}
+	/**
+	* Calculate the combined score based on vector relevance and other factors
+	* @param doc - The document to calculate the score for
+	* @param vectorRelevance - The relevance score from the vector store
+	* @param nowMsec - The current timestamp in milliseconds
+	* @returns The combined score for the document
+	*/
+	getCombinedScore(doc, vectorRelevance, nowMsec) {
+		const hoursPassed = this.getHoursPassed(nowMsec, doc.metadata[LAST_ACCESSED_AT_KEY]);
+		let score = (1 - this.decayRate) ** hoursPassed;
+		for (const key of this.otherScoreKeys) score += doc.metadata[key];
+		if (vectorRelevance !== null) score += vectorRelevance;
+		return score;
+	}
+	/**
+	* Calculate the hours passed between two time points
+	* @param time - The current time in seconds
+	* @param refTime - The reference time in seconds
+	* @returns The number of hours passed between the two time points
+	*/
+	getHoursPassed(time, refTime) {
+		return (time - refTime) / 3600;
+	}
+};
+
+//#endregion
+exports.BUFFER_IDX = BUFFER_IDX;
+exports.LAST_ACCESSED_AT_KEY = LAST_ACCESSED_AT_KEY;
+exports.TimeWeightedVectorStoreRetriever = TimeWeightedVectorStoreRetriever;
+Object.defineProperty(exports, 'time_weighted_exports', {
+  enumerable: true,
+  get: function () {
+    return time_weighted_exports;
+  }
+});
+//# sourceMappingURL=time_weighted.cjs.map

package/dist/retrievers/time_weighted.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"time_weighted.cjs","names":["BaseRetriever","fields: TimeWeightedVectorStoreRetrieverFields","memoryStream: DocumentInterface[]","query: string","runManager?: CallbackManagerForRetrieverRun","docs: DocumentInterface[]","memoryDocsAndScores: Record<\n      number,\n      { doc: DocumentInterface; score: number }\n    >","docAndScores: [DocumentInterface, number][]","results: Record<number, { doc: DocumentInterface; score: number }>","docsAndScores: Record<number, { doc: DocumentInterface; score: number }>","now: number","results: DocumentInterface[]","doc: DocumentInterface","vectorRelevance: number | null","nowMsec: number","time: number","refTime: number"],"sources":["../../src/retrievers/time_weighted.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\n/**\n * Interface for the fields required to initialize a\n * TimeWeightedVectorStoreRetriever instance.\n */\nexport interface TimeWeightedVectorStoreRetrieverFields\n  extends BaseRetrieverInput {\n  vectorStore: VectorStoreInterface;\n  searchKwargs?: number;\n  memoryStream?: DocumentInterface[];\n  decayRate?: number;\n  k?: number;\n  otherScoreKeys?: string[];\n  defaultSalience?: number;\n}\n\nexport const LAST_ACCESSED_AT_KEY = \"last_accessed_at\";\nexport const BUFFER_IDX = \"buffer_idx\";\n\n/**\n * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.\n * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py\n * @example\n * ```typescript\n * const retriever = new TimeWeightedVectorStoreRetriever({\n *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   memoryStream: [],\n *   searchKwargs: 2,\n * });\n * await retriever.addDocuments([\n *   { pageContent: \"My name is John.\", metadata: {} },\n *   { pageContent: \"My favourite food is pizza.\", metadata: {} },\n *\n * ]);\n * const results = await retriever.invoke(\n *   \"What is my favourite food?\",\n * );\n * ```\n */\nexport class TimeWeightedVectorStoreRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"TimeWeightedVectorStoreRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"time_weighted\"];\n  }\n\n  /**\n   * The vectorstore to store documents and determine salience.\n   */\n  private vectorStore: VectorStoreInterface;\n\n  /**\n   * The number of top K most relevant documents to consider when searching.\n   */\n  private searchKwargs: number;\n\n  /**\n   * The memory_stream of documents to search through.\n   */\n  private memoryStream: DocumentInterface[];\n\n  /**\n   * The exponential decay factor used as (1.0-decay_rate)**(hrs_passed).\n   */\n  private decayRate: number;\n\n  /**\n   * The maximum number of documents to retrieve in a given call.\n   */\n  private k: number;\n\n  /**\n   * Other keys in the metadata to factor into the score, e.g. 'importance'.\n   */\n  private otherScoreKeys: string[];\n\n  /**\n   * The salience to assign memories not retrieved from the vector store.\n   */\n  private defaultSalience: number | null;\n\n  /**\n   * Constructor to initialize the required fields\n   * @param fields - The fields required for initializing the TimeWeightedVectorStoreRetriever\n   */\n  constructor(fields: TimeWeightedVectorStoreRetrieverFields) {\n    super(fields);\n    this.vectorStore = fields.vectorStore;\n    this.searchKwargs = fields.searchKwargs ?? 100;\n    this.memoryStream = fields.memoryStream ?? [];\n    this.decayRate = fields.decayRate ?? 0.01;\n    this.k = fields.k ?? 4;\n    this.otherScoreKeys = fields.otherScoreKeys ?? [];\n    this.defaultSalience = fields.defaultSalience ?? null;\n  }\n\n  /**\n   * Get the memory stream of documents.\n   * @returns The memory stream of documents.\n   */\n  getMemoryStream(): DocumentInterface[] {\n    return this.memoryStream;\n  }\n\n  /**\n   * Set the memory stream of documents.\n   * @param memoryStream The new memory stream of documents.\n   */\n  setMemoryStream(memoryStream: DocumentInterface[]) {\n    this.memoryStream = memoryStream;\n  }\n\n  /**\n   * Get relevant documents based on time-weighted relevance\n   * @param query - The query to search for\n   * @returns The relevant documents\n   */\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<DocumentInterface[]> {\n    const now = Math.floor(Date.now() / 1000);\n    const memoryDocsAndScores = this.getMemoryDocsAndScores();\n\n    const salientDocsAndScores = await this.getSalientDocuments(\n      query,\n      runManager\n    );\n    const docsAndScores = { ...memoryDocsAndScores, ...salientDocsAndScores };\n\n    return this.computeResults(docsAndScores, now);\n  }\n\n  /**\n   * NOTE: When adding documents to a vector store, use addDocuments\n   * via retriever instead of directly to the vector store.\n   * This is because it is necessary to process the document\n   * in prepareDocuments.\n   *\n   * @param docs - The documents to add to vector store in the retriever\n   */\n  async addDocuments(docs: DocumentInterface[]): Promise<void> {\n    const now = Math.floor(Date.now() / 1000);\n    const savedDocs = this.prepareDocuments(docs, now);\n\n    this.memoryStream.push(...savedDocs);\n    await this.vectorStore.addDocuments(savedDocs);\n  }\n\n  /**\n   * Get memory documents and their scores\n   * @returns An object containing memory documents and their scores\n   */\n  private getMemoryDocsAndScores(): Record<\n    number,\n    { doc: DocumentInterface; score: number }\n  > {\n    const memoryDocsAndScores: Record<\n      number,\n      { doc: DocumentInterface; score: number }\n    > = {};\n    for (const doc of this.memoryStream.slice(-this.k)) {\n      const bufferIdx = doc.metadata[BUFFER_IDX];\n      if (bufferIdx === undefined) {\n        throw new Error(\n          `Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the \"addDocuments\" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`\n        );\n      }\n      memoryDocsAndScores[bufferIdx] = {\n        doc,\n        score: this.defaultSalience ?? 0,\n      };\n    }\n    return memoryDocsAndScores;\n  }\n\n  /**\n   * Get salient documents and their scores based on the query\n   * @param query - The query to search for\n   * @returns An object containing salient documents and their scores\n   */\n  private async getSalientDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Record<number, { doc: DocumentInterface; score: number }>> {\n    const docAndScores: [DocumentInterface, number][] =\n      await this.vectorStore.similaritySearchWithScore(\n        query,\n        this.searchKwargs,\n        undefined,\n        runManager?.getChild()\n      );\n    const results: Record<number, { doc: DocumentInterface; score: number }> =\n      {};\n    for (const [fetchedDoc, score] of docAndScores) {\n      const bufferIdx = fetchedDoc.metadata[BUFFER_IDX];\n      if (bufferIdx === undefined) {\n        throw new Error(\n          `Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the \"addDocuments\" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`\n        );\n      }\n      const doc = this.memoryStream[bufferIdx];\n      results[bufferIdx] = { doc, score };\n    }\n    return results;\n  }\n\n  /**\n   * Compute the final result set of documents based on the combined scores\n   * @param docsAndScores - An object containing documents and their scores\n   * @param now - The current timestamp\n   * @returns The final set of documents\n   */\n  private computeResults(\n    docsAndScores: Record<number, { doc: DocumentInterface; score: number }>,\n    now: number\n  ): DocumentInterface[] {\n    const recordedDocs = Object.values(docsAndScores)\n      .map(({ doc, score }) => ({\n        doc,\n        score: this.getCombinedScore(doc, score, now),\n      }))\n      .sort((a, b) => b.score - a.score);\n\n    const results: DocumentInterface[] = [];\n    for (const { doc } of recordedDocs) {\n      const bufferedDoc = this.memoryStream[doc.metadata[BUFFER_IDX]];\n      bufferedDoc.metadata[LAST_ACCESSED_AT_KEY] = now;\n      results.push(bufferedDoc);\n      if (results.length > this.k) {\n        break;\n      }\n    }\n    return results;\n  }\n\n  /**\n   * Prepare documents with necessary metadata before saving\n   * @param docs - The documents to prepare\n   * @param now - The current timestamp\n   * @returns The prepared documents\n   */\n  private prepareDocuments(\n    docs: DocumentInterface[],\n    now: number\n  ): DocumentInterface[] {\n    return docs.map((doc, i) => ({\n      ...doc,\n      metadata: {\n        ...doc.metadata,\n        [LAST_ACCESSED_AT_KEY]: doc.metadata[LAST_ACCESSED_AT_KEY] ?? now,\n        created_at: doc.metadata.created_at ?? now,\n        [BUFFER_IDX]: this.memoryStream.length + i,\n      },\n    }));\n  }\n\n  /**\n   * Calculate the combined score based on vector relevance and other factors\n   * @param doc - The document to calculate the score for\n   * @param vectorRelevance - The relevance score from the vector store\n   * @param nowMsec - The current timestamp in milliseconds\n   * @returns The combined score for the document\n   */\n  private getCombinedScore(\n    doc: DocumentInterface,\n    vectorRelevance: number | null,\n    nowMsec: number\n  ): number {\n    const hoursPassed = this.getHoursPassed(\n      nowMsec,\n      doc.metadata[LAST_ACCESSED_AT_KEY]\n    );\n    let score = (1.0 - this.decayRate) ** hoursPassed;\n    for (const key of this.otherScoreKeys) {\n      score += doc.metadata[key];\n    }\n    if (vectorRelevance !== null) {\n      score += vectorRelevance;\n    }\n    return score;\n  }\n\n  /**\n   * Calculate the hours passed between two time points\n   * @param time - The current time in seconds\n   * @param refTime - The reference time in seconds\n   * @returns The number of hours passed between the two time points\n   */\n  private getHoursPassed(time: number, refTime: number): number {\n    return (time - refTime) / 3600;\n  }\n}\n"],"mappings":";;;;;;;;;;AAoBA,MAAa,uBAAuB;AACpC,MAAa,aAAa;;;;;;;;;;;;;;;;;;;;;AAsB1B,IAAa,mCAAb,cAAsDA,0CAAc;CAClE,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI,eAAe;AACjB,SAAO;GAAC;GAAa;GAAc;EAAgB;CACpD;;;;CAKD,AAAQ;;;;CAKR,AAAQ;;;;CAKR,AAAQ;;;;CAKR,AAAQ;;;;CAKR,AAAQ;;;;CAKR,AAAQ;;;;CAKR,AAAQ;;;;;CAMR,YAAYC,QAAgD;EAC1D,MAAM,OAAO;EACb,KAAK,cAAc,OAAO;EAC1B,KAAK,eAAe,OAAO,gBAAgB;EAC3C,KAAK,eAAe,OAAO,gBAAgB,CAAE;EAC7C,KAAK,YAAY,OAAO,aAAa;EACrC,KAAK,IAAI,OAAO,KAAK;EACrB,KAAK,iBAAiB,OAAO,kBAAkB,CAAE;EACjD,KAAK,kBAAkB,OAAO,mBAAmB;CAClD;;;;;CAMD,kBAAuC;AACrC,SAAO,KAAK;CACb;;;;;CAMD,gBAAgBC,cAAmC;EACjD,KAAK,eAAe;CACrB;;;;;;CAOD,MAAM,sBACJC,OACAC,YAC8B;EAC9B,MAAM,MAAM,KAAK,MAAM,KAAK,KAAK,GAAG,IAAK;EACzC,MAAM,sBAAsB,KAAK,wBAAwB;EAEzD,MAAM,uBAAuB,MAAM,KAAK,oBACtC,OACA,WACD;EACD,MAAM,gBAAgB;GAAE,GAAG;GAAqB,GAAG;EAAsB;AAEzE,SAAO,KAAK,eAAe,eAAe,IAAI;CAC/C;;;;;;;;;CAUD,MAAM,aAAaC,MAA0C;EAC3D,MAAM,MAAM,KAAK,MAAM,KAAK,KAAK,GAAG,IAAK;EACzC,MAAM,YAAY,KAAK,iBAAiB,MAAM,IAAI;EAElD,KAAK,aAAa,KAAK,GAAG,UAAU;EACpC,MAAM,KAAK,YAAY,aAAa,UAAU;CAC/C;;;;;CAMD,AAAQ,yBAGN;EACA,MAAMC,sBAGF,CAAE;AACN,OAAK,MAAM,OAAO,KAAK,aAAa,MAAM,CAAC,KAAK,EAAE,EAAE;GAClD,MAAM,YAAY,IAAI,SAAS;AAC/B,OAAI,cAAc,OAChB,OAAM,IAAI,MACR,CAAC,2RAA2R,CAAC;GAGjS,oBAAoB,aAAa;IAC/B;IACA,OAAO,KAAK,mBAAmB;GAChC;EACF;AACD,SAAO;CACR;;;;;;CAOD,MAAc,oBACZH,OACAC,YACoE;EACpE,MAAMG,eACJ,MAAM,KAAK,YAAY,0BACrB,OACA,KAAK,cACL,QACA,YAAY,UAAU,CACvB;EACH,MAAMC,UACJ,CAAE;AACJ,OAAK,MAAM,CAAC,YAAY,MAAM,IAAI,cAAc;GAC9C,MAAM,YAAY,WAAW,SAAS;AACtC,OAAI,cAAc,OAChB,OAAM,IAAI,MACR,CAAC,2RAA2R,CAAC;GAGjS,MAAM,MAAM,KAAK,aAAa;GAC9B,QAAQ,aAAa;IAAE;IAAK;GAAO;EACpC;AACD,SAAO;CACR;;;;;;;CAQD,AAAQ,eACNC,eACAC,KACqB;EACrB,MAAM,eAAe,OAAO,OAAO,cAAc,CAC9C,IAAI,CAAC,EAAE,KAAK,OAAO,MAAM;GACxB;GACA,OAAO,KAAK,iBAAiB,KAAK,OAAO,IAAI;EAC9C,GAAE,CACF,KAAK,CAAC,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM;EAEpC,MAAMC,UAA+B,CAAE;AACvC,OAAK,MAAM,EAAE,KAAK,IAAI,cAAc;GAClC,MAAM,cAAc,KAAK,aAAa,IAAI,SAAS;GACnD,YAAY,SAAS,wBAAwB;GAC7C,QAAQ,KAAK,YAAY;AACzB,OAAI,QAAQ,SAAS,KAAK,EACxB;EAEH;AACD,SAAO;CACR;;;;;;;CAQD,AAAQ,iBACNN,MACAK,KACqB;AACrB,SAAO,KAAK,IAAI,CAAC,KAAK,OAAO;GAC3B,GAAG;GACH,UAAU;IACR,GAAG,IAAI;KACN,uBAAuB,IAAI,SAAS,yBAAyB;IAC9D,YAAY,IAAI,SAAS,cAAc;KACtC,aAAa,KAAK,aAAa,SAAS;GAC1C;EACF,GAAE;CACJ;;;;;;;;CASD,AAAQ,iBACNE,KACAC,iBACAC,SACQ;EACR,MAAM,cAAc,KAAK,eACvB,SACA,IAAI,SAAS,sBACd;EACD,IAAI,SAAS,IAAM,KAAK,cAAc;AACtC,OAAK,MAAM,OAAO,KAAK,gBACrB,SAAS,IAAI,SAAS;AAExB,MAAI,oBAAoB,MACtB,SAAS;AAEX,SAAO;CACR;;;;;;;CAQD,AAAQ,eAAeC,MAAcC,SAAyB;AAC5D,UAAQ,OAAO,WAAW;CAC3B;AACF"}

package/dist/retrievers/time_weighted.d.cts

@@ -0,0 +1,142 @@
+import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
+import { VectorStoreInterface } from "@langchain/core/vectorstores";
+import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
+import { DocumentInterface } from "@langchain/core/documents";
+
+//#region src/retrievers/time_weighted.d.ts
+
+/**
+ * Interface for the fields required to initialize a
+ * TimeWeightedVectorStoreRetriever instance.
+ */
+interface TimeWeightedVectorStoreRetrieverFields extends BaseRetrieverInput {
+  vectorStore: VectorStoreInterface;
+  searchKwargs?: number;
+  memoryStream?: DocumentInterface[];
+  decayRate?: number;
+  k?: number;
+  otherScoreKeys?: string[];
+  defaultSalience?: number;
+}
+declare const LAST_ACCESSED_AT_KEY = "last_accessed_at";
+declare const BUFFER_IDX = "buffer_idx";
+/**
+ * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.
+ * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py
+ * @example
+ * ```typescript
+ * const retriever = new TimeWeightedVectorStoreRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   memoryStream: [],
+ *   searchKwargs: 2,
+ * });
+ * await retriever.addDocuments([
+ *   { pageContent: "My name is John.", metadata: {} },
+ *   { pageContent: "My favourite food is pizza.", metadata: {} },
+ *
+ * ]);
+ * const results = await retriever.invoke(
+ *   "What is my favourite food?",
+ * );
+ * ```
+ */
+declare class TimeWeightedVectorStoreRetriever extends BaseRetriever {
+  static lc_name(): string;
+  get lc_namespace(): string[];
+  /**
+   * The vectorstore to store documents and determine salience.
+   */
+  private vectorStore;
+  /**
+   * The number of top K most relevant documents to consider when searching.
+   */
+  private searchKwargs;
+  /**
+   * The memory_stream of documents to search through.
+   */
+  private memoryStream;
+  /**
+   * The exponential decay factor used as (1.0-decay_rate)**(hrs_passed).
+   */
+  private decayRate;
+  /**
+   * The maximum number of documents to retrieve in a given call.
+   */
+  private k;
+  /**
+   * Other keys in the metadata to factor into the score, e.g. 'importance'.
+   */
+  private otherScoreKeys;
+  /**
+   * The salience to assign memories not retrieved from the vector store.
+   */
+  private defaultSalience;
+  /**
+   * Constructor to initialize the required fields
+   * @param fields - The fields required for initializing the TimeWeightedVectorStoreRetriever
+   */
+  constructor(fields: TimeWeightedVectorStoreRetrieverFields);
+  /**
+   * Get the memory stream of documents.
+   * @returns The memory stream of documents.
+   */
+  getMemoryStream(): DocumentInterface[];
+  /**
+   * Set the memory stream of documents.
+   * @param memoryStream The new memory stream of documents.
+   */
+  setMemoryStream(memoryStream: DocumentInterface[]): void;
+  /**
+   * Get relevant documents based on time-weighted relevance
+   * @param query - The query to search for
+   * @returns The relevant documents
+   */
+  _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<DocumentInterface[]>;
+  /**
+   * NOTE: When adding documents to a vector store, use addDocuments
+   * via retriever instead of directly to the vector store.
+   * This is because it is necessary to process the document
+   * in prepareDocuments.
+   *
+   * @param docs - The documents to add to vector store in the retriever
+   */
+  addDocuments(docs: DocumentInterface[]): Promise<void>;
+  /**
+   * Get memory documents and their scores
+   * @returns An object containing memory documents and their scores
+   */
+  private getMemoryDocsAndScores;
+  private getSalientDocuments;
+  /**
+   * Compute the final result set of documents based on the combined scores
+   * @param docsAndScores - An object containing documents and their scores
+   * @param now - The current timestamp
+   * @returns The final set of documents
+   */
+  private computeResults;
+  /**
+   * Prepare documents with necessary metadata before saving
+   * @param docs - The documents to prepare
+   * @param now - The current timestamp
+   * @returns The prepared documents
+   */
+  private prepareDocuments;
+  /**
+   * Calculate the combined score based on vector relevance and other factors
+   * @param doc - The document to calculate the score for
+   * @param vectorRelevance - The relevance score from the vector store
+   * @param nowMsec - The current timestamp in milliseconds
+   * @returns The combined score for the document
+   */
+  private getCombinedScore;
+  /**
+   * Calculate the hours passed between two time points
+   * @param time - The current time in seconds
+   * @param refTime - The reference time in seconds
+   * @returns The number of hours passed between the two time points
+   */
+  private getHoursPassed;
+}
+//#endregion
+export { BUFFER_IDX, LAST_ACCESSED_AT_KEY, TimeWeightedVectorStoreRetriever, TimeWeightedVectorStoreRetrieverFields };
+//# sourceMappingURL=time_weighted.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"time_weighted.d.cts","names":["BaseRetriever","BaseRetrieverInput","VectorStoreInterface","DocumentInterface","CallbackManagerForRetrieverRun","TimeWeightedVectorStoreRetrieverFields","LAST_ACCESSED_AT_KEY","BUFFER_IDX","TimeWeightedVectorStoreRetriever","Promise"],"sources":["../../src/retrievers/time_weighted.d.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n/**\n * Interface for the fields required to initialize a\n * TimeWeightedVectorStoreRetriever instance.\n */\nexport interface TimeWeightedVectorStoreRetrieverFields extends BaseRetrieverInput {\n    vectorStore: VectorStoreInterface;\n    searchKwargs?: number;\n    memoryStream?: DocumentInterface[];\n    decayRate?: number;\n    k?: number;\n    otherScoreKeys?: string[];\n    defaultSalience?: number;\n}\nexport declare const LAST_ACCESSED_AT_KEY = \"last_accessed_at\";\nexport declare const BUFFER_IDX = \"buffer_idx\";\n/**\n * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.\n * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py\n * @example\n * ```typescript\n * const retriever = new TimeWeightedVectorStoreRetriever({\n *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   memoryStream: [],\n *   searchKwargs: 2,\n * });\n * await retriever.addDocuments([\n *   { pageContent: \"My name is John.\", metadata: {} },\n *   { pageContent: \"My favourite food is pizza.\", metadata: {} },\n *\n * ]);\n * const results = await retriever.invoke(\n *   \"What is my favourite food?\",\n * );\n * ```\n */\nexport declare class TimeWeightedVectorStoreRetriever extends BaseRetriever {\n    static lc_name(): string;\n    get lc_namespace(): string[];\n    /**\n     * The vectorstore to store documents and determine salience.\n     */\n    private vectorStore;\n    /**\n     * The number of top K most relevant documents to consider when searching.\n     */\n    private searchKwargs;\n    /**\n     * The memory_stream of documents to search through.\n     */\n    private memoryStream;\n    /**\n     * The exponential decay factor used as (1.0-decay_rate)**(hrs_passed).\n     */\n    private decayRate;\n    /**\n     * The maximum number of documents to retrieve in a given call.\n     */\n    private k;\n    /**\n     * Other keys in the metadata to factor into the score, e.g. 'importance'.\n     */\n    private otherScoreKeys;\n    /**\n     * The salience to assign memories not retrieved from the vector store.\n     */\n    private defaultSalience;\n    /**\n     * Constructor to initialize the required fields\n     * @param fields - The fields required for initializing the TimeWeightedVectorStoreRetriever\n     */\n    constructor(fields: TimeWeightedVectorStoreRetrieverFields);\n    /**\n     * Get the memory stream of documents.\n     * @returns The memory stream of documents.\n     */\n    getMemoryStream(): DocumentInterface[];\n    /**\n     * Set the memory stream of documents.\n     * @param memoryStream The new memory stream of documents.\n     */\n    setMemoryStream(memoryStream: DocumentInterface[]): void;\n    /**\n     * Get relevant documents based on time-weighted relevance\n     * @param query - The query to search for\n     * @returns The relevant documents\n     */\n    _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<DocumentInterface[]>;\n    /**\n     * NOTE: When adding documents to a vector store, use addDocuments\n     * via retriever instead of directly to the vector store.\n     * This is because it is necessary to process the document\n     * in prepareDocuments.\n     *\n     * @param docs - The documents to add to vector store in the retriever\n     */\n    addDocuments(docs: DocumentInterface[]): Promise<void>;\n    /**\n     * Get memory documents and their scores\n     * @returns An object containing memory documents and their scores\n     */\n    private getMemoryDocsAndScores;\n    private getSalientDocuments;\n    /**\n     * Compute the final result set of documents based on the combined scores\n     * @param docsAndScores - An object containing documents and their scores\n     * @param now - The current timestamp\n     * @returns The final set of documents\n     */\n    private computeResults;\n    /**\n     * Prepare documents with necessary metadata before saving\n     * @param docs - The documents to prepare\n     * @param now - The current timestamp\n     * @returns The prepared documents\n     */\n    private prepareDocuments;\n    /**\n     * Calculate the combined score based on vector relevance and other factors\n     * @param doc - The document to calculate the score for\n     * @param vectorRelevance - The relevance score from the vector store\n     * @param nowMsec - The current timestamp in milliseconds\n     * @returns The combined score for the document\n     */\n    private getCombinedScore;\n    /**\n     * Calculate the hours passed between two time points\n     * @param time - The current time in seconds\n     * @param refTime - The reference time in seconds\n     * @returns The number of hours passed between the two time points\n     */\n    private getHoursPassed;\n}\n"],"mappings":";;;;;;;;;AAQA;;AACiBE,UADAG,sCAAAA,SAA+CJ,kBAC/CC,CAAAA;EAAoB,WAElBC,EAFFD,oBAEEC;EAAiB,YAH4BF,CAAAA,EAAAA,MAAAA;EAAkB,YAAA,CAAA,EAG/DE,iBAH+D,EAAA;EAS7DG,SAAAA,CAAAA,EAAAA,MAAAA;EACAC,CAAAA,CAAAA,EAAAA,MAAAA;EAqBAC,cAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAgC,eAAA,CAAA,EAAA,MAAA;;AAwC9BL,cA9DFG,oBAAAA,GA8DEH,kBAAAA;AAKWA,cAlEbI,UAAAA,GAkEaJ,YAAAA;;;;;;;AA7CyC;;;;;;;;;;;;;;cAAtDK,gCAAAA,SAAyCR,aAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAmCtCK;;;;;qBAKDF;;;;;gCAKWA;;;;;;oDAMoBC,iCAAiCK,QAAQN;;;;;;;;;qBASxEA,sBAAsBM"}