diff --git a/.changeset/smart-eels-design.md b/.changeset/smart-eels-design.md new file mode 100644 index 0000000000000000000000000000000000000000..4863ea4f705975a60eb2589a61c8d8d2b99453ee --- /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 8ab879e2155bdd232d578d9e8718705f25406a42..e6fd08e75a38dd34b2cca997fd6a92c42fdf2af0 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 718437178e087cd721d7af3d293bf858ce271ba7..04e644809a7aa6dbe63880e5aada3fc302607d9b 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 75a95fbf75e51a1c3837684929ccd44e6e18132c..bc1b6c230d800cfc586781eee4172b783474be5b 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 }); }