@ontos-ai/knowhere-sdk 2.4.0 → 2.4.1

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

@@ -949,7 +949,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 +967,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

@@ -949,7 +949,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 +967,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.1",
   "description": "Official Node.js SDK for Knowhere document parsing API",
   "keywords": [
     "knowhere",