@solazah/solazah-runtime 0.1.11 → 0.1.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solazah/solazah-runtime",
-  "version": "0.1.11",
+  "version": "0.1.16",
   "main": "index.cjs",
   "module": "index.js",
   "types": "types/index.d.ts",

package/types/Kb.d.ts

@@ -1,11 +1,22 @@
 import { default as IpcRenderer } from './IpcRenderer';
 export interface KbSearchHit {
+    /** 相对工作空间根的路径,用于展示与定位 */
     path: string;
+    /** 「文档」目录下的相对路径;命中不在文档目录内时为 null(如 agent 写在工作空间根的产出) */
+    docPath: string | null;
     title: string;
     chunk: string;
     distance: number;
 }
-/** window.kb —— 笔记知识库语义检索(主进程用 provider embedding + sqlite-vec)。 */
+/** 一次索引同步的统计。用于给用户具体反馈,而不是一句没信息量的「成功」。 */
+export interface KbSyncResult {
+    ok: boolean;
+    numAdded: number;
+    numUpdated: number;
+    numSkipped: number;
+    numDeleted: number;
+}
+/** window.kb —— 工作空间知识库语义检索(主进程用 provider embedding + sqlite-vec)。 */
 export default class Kb {
     private transport;
     constructor(transport?: IpcRenderer);
@@ -18,13 +29,12 @@ export default class Kb {
      */
     search: (query: string, k?: number) => Promise<KbSearchHit[]>;
     /**
-     * 重建或增量同步笔记向量索引。
-     * force 缺省为 true(整体重建);传 false 则只做按 mtime 的增量同步。
+     * 重建或增量同步工作空间知识库索引。
+     * force 缺省为 true(忽略已有记录整体重灌);传 false 则只同步变更内容。
      *
-     * @param force 是否强制整体重建,缺省 true。false 时仅增量同步变更文件。
-     * @returns 固定返回 `{ ok: true }` 表示索引操作已完成。
+     * @param force 是否强制重灌,缺省 true。
+     * @returns ok 恒为 true;numAdded/numUpdated/numSkipped/numDeleted 为本次索引统计,可直接展示给用户。
+     * @throws 未配置 Embedding 模型时抛错(code: KB_NO_EMBEDDING_MODEL)。
      */
-    reindex: (force?: boolean) => Promise<{
-        ok: boolean;
-    }>;
+    reindex: (force?: boolean) => Promise<KbSyncResult>;
 }