@ontos-ai/knowhere-sdk 2.2.0 → 2.3.0

package/README.md

@@ -515,12 +515,17 @@ without creating SDK local-disk cache state. Use `syncParsedDocument(...)` to
 explicitly resume or retry parsed-storage sync for an existing `documentId`,
 `jobId`, or local parsed result.
 
-Follow-up queries can exclude documents or sections for one request:
+Retrieval queries can limit documents and exclude documents or sections for one request.
+`includeDocumentIds?: string[]` restricts retrieval to the supplied document IDs.
+Omitting it leaves documents unrestricted by inclusion; passing `[]` matches no
+documents. Exclusions take precedence over inclusions, including when a document
+ID appears in both `includeDocumentIds` and `excludeDocumentIds`.
 
 ```typescript
 const followUp = await client.retrieval.query({
   namespace: 'support-center',
   query: 'battery charging',
+  includeDocumentIds: ['doc_123', 'doc_old'],
   excludeDocumentIds: ['doc_old'],
   excludeSections: [{ documentId: 'doc_123', sectionPath: 'Appendix / Legal' }],
 });

package/dist/index.d.mts

@@ -859,7 +859,13 @@ interface RetrievalQueryParams {
     threshold?: number;
     /** Override the internal per-channel recall count */
     internalRecallK?: number;
-    /** Documents to exclude for this request only */
+    /**
+     * Limit retrieval to these documents for this request only.
+     * Omitted means no document inclusion restriction; [] matches no documents.
+     * Exclusions take precedence over inclusions.
+     */
+    includeDocumentIds?: string[];
+    /** Documents to exclude for this request only, even when included in includeDocumentIds. */
     excludeDocumentIds?: string[];
     /** Document sections to exclude for this request only */
     excludeSections?: RetrievalSectionExclusion[];

package/dist/index.d.ts

@@ -859,7 +859,13 @@ interface RetrievalQueryParams {
     threshold?: number;
     /** Override the internal per-channel recall count */
     internalRecallK?: number;
-    /** Documents to exclude for this request only */
+    /**
+     * Limit retrieval to these documents for this request only.
+     * Omitted means no document inclusion restriction; [] matches no documents.
+     * Exclusions take precedence over inclusions.
+     */
+    includeDocumentIds?: string[];
+    /** Documents to exclude for this request only, even when included in includeDocumentIds. */
     excludeDocumentIds?: string[];
     /** Document sections to exclude for this request only */
     excludeSections?: RetrievalSectionExclusion[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ontos-ai/knowhere-sdk",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Official Node.js SDK for Knowhere document parsing API",
   "keywords": [
     "knowhere",