From 6cc3a36d448f6d82ae6b72dbc5695ca4cab52e84 Mon Sep 17 00:00:00 2001
From: Gavin Morgan <morgan.gavin@gmail.com>
Date: Sun, 4 Feb 2024 16:22:04 -0800
Subject: [PATCH] fix: update `VectorIndexRetriever` constructor parameters'
type. (#515)
Co-authored-by: Alex Yang <himself65@outlook.com>
---
.changeset/smart-eels-design.md | 5 +++++
packages/core/package.json | 2 +-
.../src/indices/vectorStore/VectorIndexRetriever.ts | 12 +++++++-----
.../core/src/indices/vectorStore/VectorStoreIndex.ts | 9 +++++++--
4 files changed, 20 insertions(+), 8 deletions(-)
create mode 100644 .changeset/smart-eels-design.md
diff --git a/.changeset/smart-eels-design.md b/.changeset/smart-eels-design.md
new file mode 100644
index 000000000..4863ea4f7
--- /dev/null
+++ b/.changeset/smart-eels-design.md
@@ -0,0 +1,5 @@
+---
+"llamaindex": patch
+---
+
+fix: update `VectorIndexRetriever` constructor parameters' type.
diff --git a/packages/core/package.json b/packages/core/package.json
index 8ab879e21..e6fd08e75 100644
--- a/packages/core/package.json
+++ b/packages/core/package.json
@@ -200,7 +200,7 @@
"scripts": {
"lint": "eslint .",
"test": "jest",
- "build": "NODE_OPTIONS=\"--max-old-space-size=8192\" bunchee",
+ "build": "rm -rf ./dist && NODE_OPTIONS=\"--max-old-space-size=8192\" bunchee",
"postbuild": "pnpm run copy && pnpm run modify-package-json",
"copy": "cp -r package.json CHANGELOG.md ../../README.md ../../LICENSE examples src dist/",
"modify-package-json": "node ./scripts/modify-package-json.mjs",
diff --git a/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts b/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts
index 718437178..04e644809 100644
--- a/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts
+++ b/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts
@@ -17,6 +17,12 @@ import { VectorStoreIndex } from "./VectorStoreIndex";
* VectorIndexRetriever retrieves nodes from a VectorIndex.
*/
+export type VectorIndexRetrieverOptions = {
+ index: VectorStoreIndex;
+ similarityTopK?: number;
+ imageSimilarityTopK?: number;
+};
+
export class VectorIndexRetriever implements BaseRetriever {
index: VectorStoreIndex;
similarityTopK: number;
@@ -27,11 +33,7 @@ export class VectorIndexRetriever implements BaseRetriever {
index,
similarityTopK,
imageSimilarityTopK,
- }: {
- index: VectorStoreIndex;
- similarityTopK?: number;
- imageSimilarityTopK?: number;
- }) {
+ }: VectorIndexRetrieverOptions) {
this.index = index;
this.serviceContext = this.index.serviceContext;
this.similarityTopK = similarityTopK ?? DEFAULT_SIMILARITY_TOP_K;
diff --git a/packages/core/src/indices/vectorStore/VectorStoreIndex.ts b/packages/core/src/indices/vectorStore/VectorStoreIndex.ts
index 75a95fbf7..bc1b6c230 100644
--- a/packages/core/src/indices/vectorStore/VectorStoreIndex.ts
+++ b/packages/core/src/indices/vectorStore/VectorStoreIndex.ts
@@ -34,7 +34,10 @@ import {
IndexDict,
IndexStructType,
} from "../BaseIndex";
-import { VectorIndexRetriever } from "./VectorIndexRetriever";
+import {
+ VectorIndexRetriever,
+ VectorIndexRetrieverOptions,
+} from "./VectorIndexRetriever";
interface IndexStructOptions {
indexStruct?: IndexDict;
@@ -260,7 +263,9 @@ export class VectorStoreIndex extends BaseIndex<IndexDict> {
return index;
}
- asRetriever(options?: any): VectorIndexRetriever {
+ asRetriever(
+ options?: Omit<VectorIndexRetrieverOptions, "index">,
+ ): VectorIndexRetriever {
return new VectorIndexRetriever({ index: this, ...options });
}
--
GitLab