面向所有问数与数据分析场景,基于 DataPilot 的 OpenAPI 执行从数据源接入到数据问答的完整流程。用于自然语言查数、SQL 查询校验、图表生成、报告导出下载、创建与管理数据分析 Agent、维护 Agent 知识库。
DataAgent OpenAPI Assistant
功能概述
DataAgent OpenAPI Assistant是一项面向实际任务的技能,主要用于当用户要求任何"问数 / 查数 / 数据分析 / 报表"相关能力时使用本技能,包括但不限于:;基于数据源创建通用数据分析 Agent(面向任意业务域,不限行业);
核心要点
- 自然语言问数、SQL 校验、图表展示、报告导出与下载;
- 列出和检索当前全部 Agent(含描述);
- 维护 Agent 知识库(参考 SQL、业务知识、分析模板)。
使用与执行
它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
结果检查与注意事项
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
DataAgent OpenAPI Assistant
何时使用
当用户要求任何"问数 / 查数 / 数据分析 / 报表"相关能力时使用本技能,包括但不限于:
- 基于数据源创建通用数据分析 Agent(面向任意业务域,不限行业)
- 自然语言问数、SQL 校验、图表展示、报告导出与下载
- 列出和检索当前全部 Agent(含描述)
- 维护 Agent 知识库(参考 SQL、业务知识、分析模板)
能力总览
| 能力 | CLI 命令 | 说明 |
|---|---|---|
| 创建 DataAgent 实例 | create-instance |
一步完成 agent 创建,接入数据源 |
| 自然语言问数 | ask |
SSE 对话,返回 SQL / 表格 / 图表 / 报告下载链接 |
| 列出全部 Agent | list-agents |
跨 namespace 汇总所有 agent 信息 |
| 查看知识库 | knowledge-list |
列出指定 agent 的知识条目(可按类型过滤) |
| 新增/更新知识 | knowledge-upsert |
新增或覆盖一条知识(reference_sql / business_knowledge / analysis_template) |
| 查看知识条目 | knowledge-get |
获取单条知识详情 |
| 删除知识条目 | knowledge-delete |
删除一条知识 |
核心流程
用户需求 │ ├─ 首次使用 ──► create-instance(接入数据源,创建 Agent) │ │ │ ▼ │ 返回 namespaceId + agentId │ ├─ 问数分析 ──► ask(传入 agentId + 自然语言问题) │ │ │ ▼ │ SSE 流式返回:SQL / 表格 / 图表 / 报告下载链接 │ ├─ 查看 Agent ► list-agents(列出所有可用 Agent) │ └─ 知识管理 ──► knowledge-list / knowledge-upsert / knowledge-get / knowledge-delete
配置与鉴权
- API 基础前缀:
/api - 响应格式:
{ code, message, data },code === 0视为成功 - 鉴权:Header
Authorization: Bearer - 语言:Header
X-Lang: zh
调用方式
所有能力通过 Node 脚本 dataagent_openapi_cli.mjs 调用。
node dataagent_openapi_cli.mjs[options]
通用参数
| 参数 | 说明 | 默认值 |
|---|---|---|
--base-url |
API 服务地址 | 环境变量 DATAPILOT_API_URL |
--token 或 --apiKey |
鉴权令牌 | 环境变量 DATAPILOT_API_KEY |
命令详解
1. create-instance — 创建 DataAgent 实例
创建一个 agent 实例,提供问数,数据分析等能力。
参数:
| 参数 | 必填 | 说明 |
|---|---|---|
--name |
是 | 实例名称(同时作为 namespace 和 agent 名) |
--description |
否 | 实例描述(推荐模板:[业务域] + [核心指标] + [时间粒度] + [场景]) |
--datasource-file |
二选一 | 数据源 JSON 配置文件路径 |
--datasource-json |
二选一 | 数据源 JSON 字符串 |
--sqlite-file |
条件 | SQLite 类型且无 uri 时,需提供 .db 文件路径上传 |
数据源配置格式:
| 类型 | 必填字段 |
|---|---|
sqlite |
{ type: "sqlite", uri } — 或通过 --sqlite-file 上传后自动填充 |
mysql |
{ type, host, port, username, password, database, schema? } |
postgresql |
{ type, host, port, username, password, database, schema? } |
odps |
{ type: "odps", access_id, access_key, project, endpoint, schema? } |
oboracle |
{ type: "oboracle", host, port, username, password, tenant, cluster?, database? } |
示例:
node dataagent_openapi_cli.mjs create-instance --name "sales_copilot" --description "销售经营分析,覆盖GMV/转化率/复购,按日周月输出。" --datasource-file ./datasource.json
返回:
{
"namespaceId": "ns_xxx",
"agentId": "agent_xxx",
"name": "sales_copilot",
"description": "销售经营分析...",
"tablesCount": 12,
"datasourceType": "mysql"
}
2. ask — 自然语言问数
通过 SSE 对话接口进行问数,返回流式事件和下载链接。
参数:
| 参数 | 必填 | 说明 |
|---|---|---|
--namespace-id |
是 | 目标 namespace ID |
--agent-id |
是 | 目标 agent ID |
--input |
是 | 自然语言问题 |
--session-id |
否 | 会话 ID(多轮对话时传入) |
--role |
否 | 角色标识 |
示例:
node dataagent_openapi_cli.mjs ask --namespace-id ns_xxx --agent-id agent_xxx --input "按周分析最近90天GMV变化并生成周报"
返回:
{
"sessionId": "sess_xxx",
"content": "最终回复文本(Markdown 格式,含表格、图表、报告等)",
"downloadUrls": ["http://localhost:3000/api/sub-agents/.../download/files/..."],
"status": "completed"
}
| 字段 | 说明 |
|---|---|
content |
最终回复文本(由所有 text block 拼接而成) |
sql |
执行过的 SQL 语句列表 |
downloadUrls |
从回复中提取的可下载文件绝对 URL |
status |
completed(成功)或 failed(出错) |
3. list-agents — 列出全部 Agent
跨 namespace 汇总所有 agent 信息。
参数: 仅通用参数。
示例:
node dataagent_openapi_cli.mjs list-agents
返回: 数组,每项包含 agentId / name / description / namespaceId / namespaceName / datasourceType / updatedAt。
4. knowledge-list — 查看知识库
参数:
| 参数 | 必填 | 说明 |
|---|---|---|
--namespace-id |
是 | 目标 namespace ID |
--agent-id |
是 | 目标 agent ID |
--knowledge-type |
否 | 按类型过滤:reference_sql / business_knowledge / analysis_template |
示例:
node dataagent_openapi_cli.mjs knowledge-list --namespace-id ns_xxx --agent-id agent_xxx
5. knowledge-upsert — 新增/更新知识
参数:
| 参数 | 必填 | 说明 |
|---|---|---|
--namespace-id |
是 | 目标 namespace ID |
--agent-id |
是 | 目标 agent ID |
--knowledge-type |
是 | 类型:reference_sql / business_knowledge / analysis_template |
--name |
是 | 知识条目名称(推荐:业务域_主题_版本) |
--content |
是 | 知识内容(SQL / 术语定义 / 模板文本) |
示例:
node dataagent_openapi_cli.mjs knowledge-upsert
--namespace-id ns_xxx --agent-id agent_xxx
--knowledge-type reference_sql
--name weekly_gmv_v1
--content "SELECT date_trunc('week', order_date) AS week, SUM(amount) AS gmv FROM orders GROUP BY 1"
6. knowledge-get — 查看知识条目
参数:
| 参数 | 必填 | 说明 |
|---|---|---|
--namespace-id |
是 | 目标 namespace ID |
--agent-id |
是 | 目标 agent ID |
--knowledge-type |
是 | 知识类型 |
--name |
是 | 知识条目名称 |
示例:
node dataagent_openapi_cli.mjs knowledge-get --namespace-id ns_xxx --agent-id agent_xxx --knowledge-type reference_sql --name weekly_gmv_v1
7. knowledge-delete — 删除知识条目
参数: 同 knowledge-get。
示例:
node dataagent_openapi_cli.mjs knowledge-delete --namespace-id ns_xxx --agent-id agent_xxx --knowledge-type reference_sql --name weekly_gmv_v1
热门AI工具
相关专题
本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。
0
2026.11.12
本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。
0
2026.11.12
本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。
0
2026.11.12
本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。
0
2026.11.06
围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。
0
2026.11.06
详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。
0
2026.11.06
DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。
0
2026.11.05
DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。
0
2026.11.05
本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。
0
2026.11.04
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.8万人学习
共6课时 | 54.7万人学习
最新文章