youdata-metrics-nl-query
SKILL.md
有数指标自然语言查询技能
功能
该技能允许用户通过自然语言查询指标数据,无需编写复杂的查询语句。
依赖环境
- Node.js 20+
- 需要网络连接访问知数平台API
- 需要安装 skill
youdata-env-config并完成配置
使用场景
- 用户已有 metricsId,想用自然语言查询该指标的数据
- 用户通过
youdata-metrics-nl-choose找到指标后,想进一步查询具体数据 - 用户想对指标做筛选、聚合、趋势分析等操作
前置流程
如果用户没有提供 metricsId,应先使用 youdata-metrics-nl-choose 技能,根据用户的自然语言描述查找匹配的指标并获取 metricsId,再调用本技能进行数据查询。
使用方法
- 提供指标ID (metricsId)
- 提供自然语言查询问题
- 技能将调用queryMetrics函数进行智能查询
调用示例
- step1:使用 skill
youdata-env-config获取 env(json字符串格式) - step2:获取当前 SKILL.md 的绝对目录地址 skillFolder
- step3:调用脚本
node ${skillFolder}/scripts/index.js <metricsId> "查询最近7天的销售总额" <env>
参数说明
metricsId: 指标的唯一标识符question: 自然语言查询问题,支持中文
返回结果
返回JSON格式的查询结果,包含查询的数据和分析结果。 其中head是列名,body是数据行
{
"head": [
"国家",
"省/自治区",
"城市",
"各地区销售额"
],
"body": [
[
"中国",
"甘肃",
null,
802
],
[
"中国",
"河南",
null,
573
]
]
}
错误处理
- 如果没有安装 skill
youdata-env-config,会提示安装该技能 - 缺少参数时会提示正确用法
- 配置不完整时会提示配置信息
- 网络错误会显示具体错误信息
- 脚本查询失败时显示错误信息并立刻终止问答