@guandata/decidex 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +106 -10
- package/docs/api-coverage.md +51 -0
- package/package.json +4 -4
- package/src/api-catalog.json +6849 -0
- package/src/catalog.js +36 -0
- package/src/cli.js +283 -10
- package/src/compatibility.js +45 -2
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# Decidex CLI
|
|
2
2
|
|
|
3
|
-
基于 Decidex **0.0.
|
|
3
|
+
基于 Decidex **0.0.6** HTTP API 的零依赖 Node.js CLI(CLI 版本 0.3.0)。要求 Node.js 22+。
|
|
4
4
|
|
|
5
|
-
适配基线:[tag 0.0.
|
|
5
|
+
适配基线:[tag 0.0.6 / 73901fa03](https://gitlab.mayidata.com/zijie0/decidex/-/tree/0.0.6),2026-11-06。按实际部署的 release 契约执行,保留 0.0.5 调度兼容。
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install -g @guandata/decidex@0.
|
|
8
|
+
npm install -g @guandata/decidex@0.3.0
|
|
9
9
|
decidex version --json # 本地 CLI 版本
|
|
10
10
|
decidex server version # 目标服务端版本与 commit
|
|
11
11
|
decidex server check auth whoami
|
|
@@ -34,7 +34,7 @@ decidex auth whoami # 服务端 >= 0.0.5,返回已验证的
|
|
|
34
34
|
|
|
35
35
|
版本来自已登录目标的 `GET /api/app-version`,每次 CLI 进程重新读取,不持久缓存。`version` 查询即使遇到 `dev` 等版本也会显示原值和 `comparable=false`;需要版本决策的命令遇到无法比较的版本、认证失败或版本查询失败会明确报错,不猜测版本或在写入失败后重试另一种协议。
|
|
36
36
|
|
|
37
|
-
`server check` 对没有版本规则的命令返回 `supported=null`、`reason=no_version_rule`,表示尚未声明版本边界,不能据此断言目标支持。`0.0.
|
|
37
|
+
`server check` 对没有版本规则的命令返回 `supported=null`、`reason=no_version_rule`,表示尚未声明版本边界,不能据此断言目标支持。`0.0.6` 是本次适配基线,不是所有命令的首次发布版本。SemVer 比较支持 `v` 前缀、预发布和构建信息;例如 `0.0.8-rc.1` 低于正式 `0.0.8`。
|
|
38
38
|
|
|
39
39
|
已核实的版本差异:
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ decidex auth whoami # 服务端 >= 0.0.5,返回已验证的
|
|
|
44
44
|
| `auth status` / `auth login` 的登录验证 | 原有 Agent 列表验证,`legacy=true`,用户/组织身份未验证 | `/api/auth/context`,返回已验证身份 |
|
|
45
45
|
| `context show` | 本地上下文,`organizationIdVerified=false` | 读取服务端身份;可在没有活动组织时使用 |
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
常用命令的兼容规则在 `src/compatibility.js`,操作目录的路由版本在 `src/api-catalog.json`。后续添加命令时,可依据实际 release tag 声明:
|
|
48
48
|
|
|
49
49
|
```js
|
|
50
50
|
"example create": { minVersion: "0.0.8" },
|
|
@@ -258,7 +258,7 @@ decidex eval run AGENT_ID eval-run.json --cases all --wait --output eval-result.
|
|
|
258
258
|
decidex eval stop AGENT_ID RUN_ID
|
|
259
259
|
```
|
|
260
260
|
|
|
261
|
-
CLI 按服务端 `0.0.5` tag
|
|
261
|
+
CLI 按服务端 `0.0.5` / `0.0.6` tag 的共同契约校验该文件:只接受 `caseIds`、`targetModelSelection` 和 `judgeModelSelection`。使用 `--cases all` 时由 CLI 获取并覆盖 `caseIds`;Agent 没有评测案例时会在本地停止。
|
|
262
262
|
|
|
263
263
|
查询、接管或批量监控已经启动的评测:
|
|
264
264
|
|
|
@@ -306,10 +306,94 @@ decidex automation runs AUTOMATION_ID --cursor NEXT_CURSOR
|
|
|
306
306
|
decidex automation delete AUTOMATION_ID
|
|
307
307
|
```
|
|
308
308
|
|
|
309
|
-
文件包含 `id` 时用 PATCH 更新;可只传 `{ "id": "...", "status": "PAUSED" }`
|
|
309
|
+
文件包含 `id` 时用 PATCH 更新;可只传 `{ "id": "...", "status": "PAUSED" }` 暂停,改为 `ACTIVE` 恢复。暂停状态不能手动运行;单次调度完成后由服务端写入 `FINISHED`,不能手动设置、恢复或再次运行。
|
|
310
|
+
|
|
311
|
+
服务端 >= 0.0.6 支持以下调度:
|
|
312
|
+
|
|
313
|
+
| schedule 示例 | 含义 |
|
|
314
|
+
| --- | --- |
|
|
315
|
+
| `{ "kind": "DAILY", "timeOfDayMinutes": 600 }` | 每天 10:00 |
|
|
316
|
+
| `{ "kind": "WEEKLY", "weekdays": [3, 5], "timeOfDayMinutes": 600 }` | 每周三、五 10:00,周日为 0 |
|
|
317
|
+
| `{ "kind": "MONTHLY", "monthDays": [1, 15], "timeOfDayMinutes": 600 }` | 每月 1 日、15 日 10:00;短月不存在的日期跳过 |
|
|
318
|
+
| `{ "kind": "INTERVAL", "intervalMinutes": 60 }` | 每隔 60 分钟,范围 5..2147483647 分钟 |
|
|
319
|
+
| `{ "kind": "ONCE", "runOnceAt": "2099-01-01T10:00:00+08:00" }` | 固定时间执行一次,保存时必须晚于当前时间 |
|
|
320
|
+
|
|
321
|
+
`timeOfDayMinutes` 范围 0..1439,缺省 540(09:00);周期调度按服务端时区执行。ONCE 建议显式填写时区。
|
|
322
|
+
|
|
323
|
+
CLI 根据目标版本选择协议:0.0.6 的旧 `weekday` 转为 `weekdays`,旧 `HOURLY` 转为 `INTERVAL(60)`;目标 0.0.5 保留原协议,单元素 `weekdays` 可转换为 `weekday`,多元素及新调度模式在写入前拒绝。`server check automation apply` 查看所选协议。
|
|
310
324
|
|
|
311
325
|
文件还可按服务端契约配置 `imPush`、`emailPush`;更新时省略保留原配置,`null` 清空。手动 `run --wait` 等待分析 Run,不代表通知已送达;送达结果查看 `automation runs`。服务端 0.0.5 的启动接口会同步等待执行结果,`--wait --timeout` 覆盖该请求及后续读取的总时间。客户端超时不会取消服务端执行;应先查 `automation runs`,不要直接重试触发。
|
|
312
326
|
|
|
327
|
+
## 任务中心
|
|
328
|
+
|
|
329
|
+
### 行动任务
|
|
330
|
+
|
|
331
|
+
Agent 配置中设置 `actionSuggestionsEnabled: true`,运行产生行动建议后再创建任务:
|
|
332
|
+
|
|
333
|
+
```bash
|
|
334
|
+
decidex action-task suggestions SESSION_ID --run-id RUN_ID
|
|
335
|
+
decidex action-task members SESSION_ID --query 张
|
|
336
|
+
decidex session view SESSION_ID # 读取回答的消息 ID
|
|
337
|
+
decidex action-task create SESSION_ID action-task.json
|
|
338
|
+
decidex action-task list --status PENDING
|
|
339
|
+
decidex action-task get TASK_ID
|
|
340
|
+
decidex action-task adopt TASK_ID --version 0
|
|
341
|
+
decidex action-task complete TASK_ID --version 1
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
`action-task.json` 使用回答消息 ID、建议 ID 和分配信息:
|
|
345
|
+
|
|
346
|
+
```json
|
|
347
|
+
{
|
|
348
|
+
"messageId": "ASSISTANT_MESSAGE_ID",
|
|
349
|
+
"suggestionId": "SUGGESTION_ID",
|
|
350
|
+
"draft": { "title": "核查异常", "description": "核实异常原因并记录结果", "assigneeIds": ["USER_ID"] }
|
|
351
|
+
}
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
`--run-id` 从当前会话窗口查找回答;较早的回答用 `session view --before CURSOR` 找到消息后传 `--message-id`。采纳后可完成或取消,待处理时可拒绝。`reject`、`cancel` 必须传 `--note 理由`。每次操作使用 `get` 返回的当前 `task.version`;409 表示任务已变化,应重新确认,不自动重试。平台没有行动任务删除接口。
|
|
355
|
+
|
|
356
|
+
### 指标追踪
|
|
357
|
+
|
|
358
|
+
追踪任务从会话内已有的候选与 BOE 证据链创建;这里的路径是远端会话路径:
|
|
359
|
+
|
|
360
|
+
```bash
|
|
361
|
+
decidex tracking preview SESSION_ID --candidate-path workspace/analysis/decision-tracking/turn.json --boe-path workspace/analysis/biz-ontology-evidence/turn.boe
|
|
362
|
+
decidex tracking create SESSION_ID --candidate-path workspace/analysis/decision-tracking/turn.json --boe-path workspace/analysis/biz-ontology-evidence/turn.boe --wait
|
|
363
|
+
decidex tracking list --filter due
|
|
364
|
+
decidex tracking get TASK_ID
|
|
365
|
+
decidex tracking review TASK_ID --wait
|
|
366
|
+
decidex tracking report TASK_ID report.html
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
`create` 使用服务端校验后的候选和 `evidenceVersion`,证据变化时保留 409。相同来源重复创建返回原任务;`lookup` 可按会话和两个路径查找。初始报告异步生成,用 `wait TASK_ID` 继续等待;失败后可显式 `retry TASK_ID --wait`;已有初始报告时返回原结果,不重复启动。
|
|
370
|
+
|
|
371
|
+
支持 `rename TASK_ID 标题`、`pause/resume/close/delete TASK_ID`、`reviews TASK_ID --cursor CURSOR`。`schedule TASK_ID schedule.json` 接收 `{ "reviewFrequency": "WEEKLY", "nextReviewAt": "2026-11-12T01:00:00.000Z" }`,频率也可为 `MONTHLY`、`QUARTERLY`。初始报告完成后才能暂停、恢复、结束或复核。
|
|
372
|
+
|
|
373
|
+
`review --data FILE` 可指定 `{ "requestedReviewWindow": { "startDate": "2026-10-01", "endDate": "2026-10-31", "grain": "month" } }`。`--wait` 等待报告或明确失败,不把已入队的复核占位记录当作完成。成功生成报告时退出码为 0,`DATA_NOT_READY` 等业务结果及原因保留原值;后台生成失败且无报告时退出码为 1。`report --initial` 下载初始报告,`--review-id ID` 下载指定复核报告。
|
|
374
|
+
|
|
375
|
+
`--timeout` 覆盖请求和等待的总时间,默认 600 秒。客户端超时不会取消后台任务;先用 `get` / `reviews` 查状态,避免重复发起复核。
|
|
376
|
+
|
|
377
|
+
## 平台操作目录
|
|
378
|
+
|
|
379
|
+
除常用专用命令外,`platform` 按真实路由注册操作,覆盖知识库、权限与成员、记忆、连接器、消息渠道、运营统计及平台管理等 API:
|
|
380
|
+
|
|
381
|
+
```bash
|
|
382
|
+
decidex platform list --query knowledge-library
|
|
383
|
+
decidex platform show knowledge-library.folders.documents.create
|
|
384
|
+
decidex platform call knowledge-library.folders.list
|
|
385
|
+
decidex platform call knowledge-library.folders.documents.create --folder-id FOLDER_ID --file files=./reference.pdf
|
|
386
|
+
decidex platform call knowledge-library.documents.original.list --document-id DOCUMENT_ID --output original.pdf
|
|
387
|
+
decidex platform call action-tasks.list --query-param status=all --query-param q=异常
|
|
388
|
+
decidex platform coverage
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
`show` 显示方法、路径、必填路径参数和最低版本。调用支持 `--data JSON文件`、可重复的 `--query-param KEY=VALUE`、`--file FIELD=FILE` / `--field KEY=VALUE`;原始二进制用 `--body-file FILE`,下载用 `--output FILE`。`--dry-run` 只检查和展示请求,不联网。
|
|
392
|
+
|
|
393
|
+
版本边界来自 release tag 中的路由存在性,**不等于该版本所有业务字段均兼容**;字段与权限仍以服务端契约为准。仅在 main 存在的操作默认拒绝,确认目标已部署后才能显式 `--allow-unreleased`,不猜测未来版本号。`inputHints` 是路由文件线索,不是完整请求 schema。
|
|
394
|
+
|
|
395
|
+
当前目录覆盖 444/444 个纳入范围的操作,全部存在于 0.0.6 tag。全部 549 个路由操作中另有 105 个运行时、服务令牌、公开分享、回调、流式或代理协议,未纳入浏览器登录态 CLI;按全部路由计为 80.9%。这表示操作入口覆盖,不是逐接口业务验证或真实冒烟覆盖。详见 [覆盖审计](docs/api-coverage.md)。
|
|
396
|
+
|
|
313
397
|
## 组织
|
|
314
398
|
|
|
315
399
|
```bash
|
|
@@ -350,11 +434,11 @@ CI 中可使用 `DECIDEX_BASE_URL` 和 `DECIDEX_SESSION`,无需写本地配置
|
|
|
350
434
|
|
|
351
435
|
## 当前边界
|
|
352
436
|
|
|
353
|
-
-
|
|
437
|
+
- 常用命令已包含任务中心行动任务和指标追踪;其余纳入范围的 API 可通过有版本约束的 `platform call` 调用。
|
|
354
438
|
- 当前上传与下载会整包载入内存,适合常规场景包和产物;超大文件需要后续增加流式传输。
|
|
355
439
|
- 组织列表当前没有普通用户 GET 接口;已验证身份由 `/api/auth/context` 提供。评测案例并发版本控制、Runner Pod/OOM/资源诊断、长期机器凭据仍缺少本 CLI 可用的契约。
|
|
356
|
-
-
|
|
357
|
-
- 已在 `decidex.guandata.com` 的准确 0.0.5 tag commit 上完成下述真实冒烟;目标部署存在定制或与 tag 不一致时,版本号不能独自证明每项能力可用。
|
|
440
|
+
- 权限、知识库、记忆、连接器、消息渠道、运营及平台管理多数使用操作目录,尚未提供与页面流程等价的专用命令。内部 Runner、服务令牌、分享/认证回调、SSE 和代理不在本次范围内。
|
|
441
|
+
- 已在 `decidex.guandata.com` 的准确 0.0.5 与 0.0.6 tag commit 上完成下述真实冒烟;目标部署存在定制或与 tag 不一致时,版本号不能独自证明每项能力可用。
|
|
358
442
|
|
|
359
443
|
|
|
360
444
|
## 维护与验证
|
|
@@ -362,6 +446,8 @@ CI 中可使用 `DECIDEX_BASE_URL` 和 `DECIDEX_SESSION`,无需写本地配置
|
|
|
362
446
|
```bash
|
|
363
447
|
npm test
|
|
364
448
|
npm pack --dry-run
|
|
449
|
+
# 更新 API 目录:必须指定已核对的源码 commit 和适配 tag
|
|
450
|
+
python3 scripts/sync-api-catalog.py --repo /path/to/decidex --ref COMMIT --baseline 0.0.6
|
|
365
451
|
npm install -g . # 更新本机 decidex;不发布到 npm
|
|
366
452
|
```
|
|
367
453
|
|
|
@@ -379,3 +465,13 @@ npm install -g . # 更新本机 decidex;不发布到 npm
|
|
|
379
465
|
- 临时 Agent、普通会话、Skill、凭证、案例/标签、定时任务、知识文档/文件夹和本体均已通过产品接口清理并核验;评测审计及软删除记录遵循服务端保留策略。本地回归 17 项通过。
|
|
380
466
|
|
|
381
467
|
边界:0.0.4 legacy/低版本拒绝仍由本地测试验证;未验证非空 BI 资产引用、外部通知、大文件、超过 20 轮窗口的历史读取。分析文件下载返回空列表,本次不据此声称验证了 BOE/产物文件内容传输。
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
## 0.3.0 / 2026-11-05
|
|
471
|
+
|
|
472
|
+
新增任务中心行动任务与指标追踪命令,以及按源码/tag 生成的平台操作目录。真实 0.0.5 环境完成任务生命周期、报告、版本限制和多种传输验证;修复异步复核提前结束和业务结果被误判为执行失败的问题。25 项本地回归通过。详细验证记录保存在代码仓库;API 入口覆盖与未验证范围见 [覆盖审计](docs/api-coverage.md)。
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
## 2026-11-06 / 服务端 0.0.6 适配
|
|
476
|
+
|
|
477
|
+
适配 tag `0.0.6 / 73901fa03`,CLI 0.3.0 在此补充 0.0.6 适配。新增多星期、月度、固定间隔和单次调度,保留 0.0.5 legacy 协议并拒绝不兼容写入;操作目录更新为已发布的 444 项,新增 BI 用户同步入口。机器人成员候选需传 `botId`,可用机器人支持 `purpose=push|channel`、`transport=STREAM|WEBHOOK`;使用授权支持成员或 BI 组。在线文档不支持下载或替换上传原件。权限与业务字段仍以目标服务端为准。
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# API 覆盖审计
|
|
2
|
+
|
|
3
|
+
更新:2026-11-06;CLI:0.3.0;适配服务端:0.0.6。
|
|
4
|
+
|
|
5
|
+
源码依据与适配基线:[0.0.6 / 73901fa03](https://gitlab.mayidata.com/zijie0/decidex/-/tree/0.0.6),与生产 `server version` 返回的 commit 一致。逐一扫描 `src/app/api/**/route.ts` 的 HTTP 方法导出,以“方法 + 路径”计数,未把 `decidex api` 兜底算作覆盖。
|
|
6
|
+
|
|
7
|
+
## 覆盖口径
|
|
8
|
+
|
|
9
|
+
| 范围 | 操作数 | CLI 入口 |
|
|
10
|
+
| --- | ---: | --- |
|
|
11
|
+
| 用户/管理员主动调用的 HTTP 操作 | 444 | 全部注册到 `platform list/show/call`,目录覆盖 100% |
|
|
12
|
+
| 其中存在于 0.0.6 tag | 444 | 默认可调用,实际权限由服务端判断 |
|
|
13
|
+
| 其中仅在 main | 0 | 本次目录仅取部署 release |
|
|
14
|
+
| 运行时、分享、认证回调等协议 | 105 | 不纳入浏览器登录态 CLI |
|
|
15
|
+
| 全部路由操作 | 549 | 按全部路由计算为 80.9% |
|
|
16
|
+
|
|
17
|
+
**90% 目标在“用户/管理员主动操作”的入口范围内达到;若包含服务协议全部路由,仍未达到 90%。** 目录注册证明请求入口可发现、路径参数可校验、传输可执行,不证明每个接口字段已适配或业务功能经过冒烟。特殊协议不应通过替换认证头强行视为普通管理 API。
|
|
18
|
+
|
|
19
|
+
## 补齐的能力
|
|
20
|
+
|
|
21
|
+
- 行动任务:建议/成员读取、创建/幂等、查询、采纳/拒绝/完成/取消,保留版本冲突与操作理由。
|
|
22
|
+
- 指标追踪:候选与证据确认、创建/查询/等待、标题与调度、暂停/恢复/结束、复核历史、HTML 报告、失败重试与删除。
|
|
23
|
+
- 操作目录:补足既有专用命令之外的知识库 CRUD/文件、Agent 记忆/权限/发布/自进化、Skill 治理、组织成员/渠道/机器人/邮件、MCP 连接器、运营分析和平台管理等调用入口。支持 JSON、查询参数、multipart、二进制上传与下载。
|
|
24
|
+
|
|
25
|
+
## 仍有的差距
|
|
26
|
+
|
|
27
|
+
- 上述扩展领域多数没有专用流程命令;请求字段仍需依据对应服务端 route/契约,`inputHints` 只提供线索。
|
|
28
|
+
- 版本元数据只证明路由在哪个 tag 已存在,不保证相同路由的请求字段、语义或权限始终不变;字段协议变化仍需单独适配与测试。
|
|
29
|
+
- 未支持内部运行时 24 项、服务令牌协议 61 项、外部消息回调/投递 5 项、认证回调/元数据 7 项、事件流 2 项、代理/预览 catch-all 3 项、公开分享 3 项。
|
|
30
|
+
- 当前上传/下载整包载入内存;外部消息实际送达、管理员写配置及每个接口的业务成功路径未全量验证。
|
|
31
|
+
|
|
32
|
+
## 0.0.6 版本差异
|
|
33
|
+
|
|
34
|
+
- 原 main 独有的 9 项已进入 0.0.6,最低版本改为有 tag 依据的 0.0.6;另外增加 BI 用户同步配置、搜索及触发等 4 个操作。低于 0.0.6 时在请求前拒绝。
|
|
35
|
+
- `automation apply` 根据版本选择 schedule-v1 / schedule-v2:旧单星期、HOURLY 兼容转换,多星期/月度/间隔/单次仅在 0.0.6 可用。新增模式的参数范围和状态限制见 README。
|
|
36
|
+
- 机器人成员候选查询要求 `botId`;可用机器人增加 `purpose=push|channel`、`transport=STREAM|WEBHOOK`。授权写入可使用成员或 BI 组;本轮不修改生产权限或发送消息。
|
|
37
|
+
- `organizations.current.bi-user-sync.users.list` 必须传 `--query-param q=关键词`,`offset` 默认 0;省略 q 的实际请求返回服务端 500,补齐参数后成功。CLI 保留原始错误,没有改写服务端错误码。
|
|
38
|
+
- 在线知识文档不支持上传原件的下载/替换协议;该限制由目标服务端判断,普通上传文档传输保持可用。
|
|
39
|
+
|
|
40
|
+
## 复核方法
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
python3 scripts/sync-api-catalog.py --repo /path/to/decidex --ref COMMIT --baseline 0.0.6
|
|
44
|
+
decidex platform coverage
|
|
45
|
+
decidex platform list --group knowledge-library
|
|
46
|
+
decidex platform show knowledge-library.folders.documents.create
|
|
47
|
+
npm test
|
|
48
|
+
npm pack --dry-run
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
每次升级先固定 commit/tag,再更新目录与字段适配;新增业务操作应补代表性契约测试及真实环境冒烟。不能用目录计数替代测试结果。
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@guandata/decidex",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "CLI for building and operating Decidex ontologies, agents, skills, sessions, and evaluations.",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"files": [
|
|
8
|
-
"src/
|
|
9
|
-
"
|
|
10
|
-
"
|
|
8
|
+
"src/",
|
|
9
|
+
"README.md",
|
|
10
|
+
"docs/api-coverage.md"
|
|
11
11
|
],
|
|
12
12
|
"bin": {
|
|
13
13
|
"decidex": "src/cli.js"
|