智能问数
更新时间:2024-08-19
获取智能问数结果
接口简介
获取智能问数结果
接口详情
请求地址
/openapi/v2/group/{groupKey}/ernieAsk
请求类型
POST
请求参数
{
"messages": [
// 对话信息
{
"role": "user",
"content": "华北地区2019年的销售额"
},
{
"role": "assistant",
"content": "```json\n{\n \"dimensions\": [\n \"产品名称\"\n ],\n \"measures\": [\n \"销售额\"\n ],\n \"filters\": [\n {\n \"k\": \"订单日期\",\n \"op\": \"between\",\n \"v\": [\n \"2019-04-01\",\n \"2019-04-30\"\n ]\n }\n ],\n \"filtersRate\": [\n {\n \"k\": \"订单日期\",\n \"op\": \"between\",\n \"v\": [\n \"2019-03-01\",\n \"2019-03-31\"\n ]\n }\n ],\n \"aggregator\": [\n {\n \"type\": \"SUM\",\n \"field\": \"销售额\"\n }\n ]\n}\n```"
},
{
"role": "user",
"content": "各省份2019年各月的销售额"
}
],
"dataModelHash": "mld_ada15-9c2ccod1-46jxow4" // 数据模型hash
}
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
dataModelHash | String | 是 | 数据模型 hash | - | mld_ada15-9c2ccod1-46jxow4 |
messages | Array | 是 | 对话信息 | - | [] |
注: messages 中需要 role 为 user 和 role 为 assistant 的 message 依次使用,且 assistant 的 message 内容需要是 json 格式的字符串,最后需要 role 为 user 的信息结尾;
数据模型需要进行前期数据准备,具体参考:智能问数前期数据准备
返回正确 JSON 示例
{
"status": 0,
"msg": "",
"data": {
"messages": [
{
"role": "user",
"content": "华北地区2019年的销售额"
},
{
"role": "assistant",
"content": "```json\n{\n \"dimensions\": [\n \"省份\"\n ],\n \"measures\": [\n \"销售额\"\n ],\n \"filters\": [\n {\n \"k\": \"地区\",\n \"op\": \"=\",\n \"v\": \"华北\"\n },\n {\n \"k\": \"订单日期\",\n \"op\": \"between\",\n \"v\": [\n \"2019-01-01\",\n \"2019-12-31\"\n ]\n }\n ]\n}\n```"
}
],
"result": { // 智能问数结果
"dimensions": [ // 维度信息
"省份"
],
"measures": [ // 度量信息
"销售额"
],
"filters": [ // 筛选条件
{
"k": "订单日期", // 字段信息
"op": "between", // 连接方式(>、<、>=、<=、=、!=、between、in、notIn)
"v": [ // 过滤条件取值
"2019-01-01",
"2019-12-31"
]
},
{
"k": "地区",
"op": "equal",
"v": [
"华北"
]
}
],
"sort": "desc", // 排序方式,asc(正序)|desc(倒序)
"limit": 10, // limit取值
"aggregator": [ // 聚合信息
{
"type": "SUM|AVG|MAX|MIN|COUNT", // 聚合方式,SUM(求和)|AVG(均值)|MAX(最大值)|MIN(最小值)|COUNT(计数)
"fileld": "" // 字段信息
}
],
"dateAggregation": [ // 日期聚合
{
"type": "YEAR-MONTH", // 类型,YEAR(年)、YEAR-QUARTER(年-季度)、YEAR-MONTH(年-月)、YEAR-WEEK(年-周)、YEAR-MONTH-DAY(年-月-日)、QUARTER(季度)、MONTH(月)、WEEK(周)、DAYOFWEEK(星期)、DAY(日)、YEAR-MONTH-DAY-HOUR(年-月-日-小时)、YEAR-MONTH-DAY-HOUR-MINUTE(年-月-日 小时-分)
"field": "订单日期"
}
],
"rateConfig": [ // 同环比相关信息
{
"type": "环比", // 类型,环比、周同比、月同比、季同比、年同比
"field": "销售额"
}
]
},
// sql 语句
"sql": "SELECT
SUM(`sale_order`.`价格`) AS FLWQ5ZQSX183UWIRL
FROM
`sale_order`
WHERE
((`sale_order`.`订单日期` >= '2019-01-01' AND `sale_order`.`订单日期` <= '2019-12-31') AND `sale_order`.`地区` = '华北')
ORDER BY
SUM(`sale_order`.`价格`) desc
LIMIT 0, 10000",
"fields": { // 字段信息
"FLWQ5ZQSX183UWIRL": {
"alias": "销售额", // 字段别名
"calculated": false, // 是否计算字段
"tableCal": false, // 是否表计算字段,只有度量字段才会有表计算字段
"dataType": "float", // 数据类型,string|float|int|date|datetime|timestamp
"expression": "", // 计算字段表达式|表计算字段表达式
"field": "价格", // 字段信息
"isAggregated": false, // 是否聚合字段
"isHidden": false, // 是否隐藏字段
"table": "sale_order", // 表信息
"type": "measure" // 字段类型,measure(度量)、dimension(维度)
}
}
}
}
返回错误 JSON 示例
{
"msg": "错误详情",
"status": 499
}
请求示例
具体请求参数如下,header中参数请参考:请求头信息