@ontos-ai/knowhere-sdk 2.4.0 → 2.4.2

package/README.md

@@ -311,8 +311,8 @@ const response = await client.retrieval.query({
 
 console.log(response.answerText); // LLM-generated answer
 console.log(response.referencedChunks); // cited evidence chunks
-console.log(response.evidence); // composed parts to consume (text/HTML and inline images)
-console.log(response.evidenceText); // text projection of those parts
+console.log(response.evidence); // grouped [E n] parts (text/HTML and inline images)
+console.log(response.evidenceText); // deprecated; always empty. Use evidence.
 console.log(response.stopReason); // agentic termination reason, when returned
 console.log(response.failureReason); // no-answer reason, when returned
 

package/dist/index.d.mts

@@ -199,14 +199,23 @@ interface Manifest {
 interface ConnectTo {
     /** Target chunk_id */
     target: string;
-    /** Relationship type */
-    relation: 'embeds' | 'related';
+    /**
+     * Relationship type.
+     * - `embeds`: body chunk -> inline image/table asset
+     * - `embedded_by`: image/table asset -> owning body chunk (reverse of `embeds`)
+     * - `related`: same-page body chunk -> asset
+     * - `cross_doc_entity` / `intra_doc_ref`: reserved, not produced yet
+     */
+    relation: 'embeds' | 'embedded_by' | 'related' | 'cross_doc_entity' | 'intra_doc_ref';
+    /** Reserved for cross-document targets; omitted for same-document edges */
+    targetDocumentId?: string;
     /** Placeholder ref in content, e.g. '[images/a.png]' (embeds only) */
     ref?: string;
-    /** Semantic similarity score (related only) */
-    score?: number;
-    /** Shared keywords (related only) */
-    keywords?: string[];
+    /** Character offsets of `ref` in the body content (embeds only) */
+    position?: {
+        start: number;
+        end: number;
+    };
 }
 /**
  * A single image or table resource entry in ``doc_nav.json``.
@@ -949,7 +958,7 @@ interface RetrievalReferencedChunk {
  *
  * Downstream agents consume:
  * - `evidence`: composed parts (text/HTML and inline images)
- * - `evidenceText`: text projection of those parts
+ * - `evidenceText`: deprecated; always empty. Use `evidence`.
  * - `results`: raw path chunks for debug
  * - `decisionTrace`: per-step navigation decisions (includes stop/failure)
  * - `referencedChunks`: structured chunk citations for follow-up queries
@@ -967,7 +976,7 @@ interface RetrievalQueryResponse {
     answerText: string | null;
     /** Cited evidence chunks with asset URLs when available */
     referencedChunks: RetrievalReferencedChunk[];
-    /** Text projection of evidence. Tables stay as HTML; images are data URLs. */
+    /** Deprecated. Always empty. Use evidence. */
     evidenceText?: string | null;
     /** Reason why the agentic run stopped (e.g. answer_done, not_found) */
     stopReason?: string | null;

package/dist/index.d.ts

@@ -199,14 +199,23 @@ interface Manifest {
 interface ConnectTo {
     /** Target chunk_id */
     target: string;
-    /** Relationship type */
-    relation: 'embeds' | 'related';
+    /**
+     * Relationship type.
+     * - `embeds`: body chunk -> inline image/table asset
+     * - `embedded_by`: image/table asset -> owning body chunk (reverse of `embeds`)
+     * - `related`: same-page body chunk -> asset
+     * - `cross_doc_entity` / `intra_doc_ref`: reserved, not produced yet
+     */
+    relation: 'embeds' | 'embedded_by' | 'related' | 'cross_doc_entity' | 'intra_doc_ref';
+    /** Reserved for cross-document targets; omitted for same-document edges */
+    targetDocumentId?: string;
     /** Placeholder ref in content, e.g. '[images/a.png]' (embeds only) */
     ref?: string;
-    /** Semantic similarity score (related only) */
-    score?: number;
-    /** Shared keywords (related only) */
-    keywords?: string[];
+    /** Character offsets of `ref` in the body content (embeds only) */
+    position?: {
+        start: number;
+        end: number;
+    };
 }
 /**
  * A single image or table resource entry in ``doc_nav.json``.
@@ -949,7 +958,7 @@ interface RetrievalReferencedChunk {
  *
  * Downstream agents consume:
  * - `evidence`: composed parts (text/HTML and inline images)
- * - `evidenceText`: text projection of those parts
+ * - `evidenceText`: deprecated; always empty. Use `evidence`.
  * - `results`: raw path chunks for debug
  * - `decisionTrace`: per-step navigation decisions (includes stop/failure)
  * - `referencedChunks`: structured chunk citations for follow-up queries
@@ -967,7 +976,7 @@ interface RetrievalQueryResponse {
     answerText: string | null;
     /** Cited evidence chunks with asset URLs when available */
     referencedChunks: RetrievalReferencedChunk[];
-    /** Text projection of evidence. Tables stay as HTML; images are data URLs. */
+    /** Deprecated. Always empty. Use evidence. */
     evidenceText?: string | null;
     /** Reason why the agentic run stopped (e.g. answer_done, not_found) */
     stopReason?: string | null;

package/package.json

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