跳转到内容

结构化输出约定

自动化程序和 Agent 应始终加全局选项 --json。

字段 含义 调用方应如何处理
ok 命令是否成功 为 false 时读取 error
summary 可直接展示的简短结论 优先显示给用户
data 命令相关结构化结果 用字段判断下一步,不解析自然语言
artifacts 文件产物 展示路径、类型和大小
warnings 非阻断提示 保留并提示用户
{
"ok": true,
"command": "conductivity.status",
"summary": "当前轮次状态已获取",
"data": {},
"artifacts": [],
"warnings": []
}
  • summary:可直接展示给用户的简短结论;
  • data:命令相关结构化结果;
  • artifacts:生成文件的路径、大小和类型;
  • warnings:不阻断操作但需要用户知道的信息。
{
"ok": false,
"error": {
"code": "permission_denied",
"message": "当前用户无权访问目标实验",
"action": "请确认项目成员关系或联系项目管理员。",
"retryable": false,
"details": {}
}
}

Agent 应优先遵循 action,并根据 retryable 判断是否能做有限重试。权限、校验和生命周期错误不是可绕过的客户端限制。

  • retryable: true:先查询服务端状态,再做有限次数退避重试;
  • retryable: false:停止自动重试,把 message 与 action 原样说明给用户;
  • 写操作超时:不能直接重复提交,必须先用状态命令确认是否已经创建任务。
Terminal window
datacore --request-id my-run-20260828 --json conductivity status "<轮次页面链接>"

为自动化调用设置稳定请求 ID,便于把客户端日志与 DataCore 服务端审计关联起来。