youdata-data-model-meta-query
SKILL.md
有数数据模型元数据获取技能
功能
该技能允许用户查询有数BI数据模型的元数据。
使用场景
- 当用户想了解某个数据模型的详细信息时
- 当用户想了解某个数据模型有哪些字段可供使用时
- 当用户想快速获取前几行数据了解某个数据模型的数据概况时
依赖环境
- Node.js 20+
- 需要网络连接访问知数平台API
- 需要安装 skill
youdata-env-config并完成配置
使用方法
- 提供数据模型ID (dataModelId)
配置要求
需要在skill目录下 /scripts/env.js 中配置:
tokenKey: 用户的有数tokenKeydomainUrl: API域名
调用示例
- step1:使用 skill
youdata-env-config获取 env(json字符串格式) - step2:获取当前 SKILL.md 的绝对目录地址 skillFolder
- step3:调用脚本
node ${skillFolder}/scripts/index.js <dataModelId> <env>
参数说明
dataModelId: 数据模型的唯一标识符
返回结果
返回JSON格式的查询结果,主要包含以下内容:
{
// markdown 格式的字符串,用来描述数据模型元信息
"meta": "模型ID: 97;\n模型名: 超市;\n\n模型的字段信息,包括字段名、字段类型、字段成员示例等信息如下:\n\n\n| colName | colType | member example |\n|--|-|-|\n| 客户名称 | string | |\n| 国家 | string | |\n| 地区 | string | |\n| 销售额 | float | |\n| 子类别 | string | |\n| 数量 | float | |\n| 折扣 | float | |\n| 利润 | float | |",
"data": {
"size": 1084, //数据模型明细数据总行数,
"head": ["国家", "地区", "子类别", "客户名称", "利润", "折扣", "数量", "销售额"], //表头
"dataSet": [ //样例数据集
["中国","东北","纸张","赵婵",0,0,2,210],
["中国","中南","复印机","严聪",160.02,0,2,2000.46]
]
}
}
错误处理
- 缺少参数时会提示正确用法
- 配置不完整时会提示配置信息
- 网络错误会显示具体错误信息
- 脚本查询失败时显示错误信息并立刻终止问答