数据解释¶
本接口在 v3.30.0 版本中引入
请求方式¶
Request Method: GET
Request URL: /openapi/v1/workspaces/{workspaceId}/data/insight/?memberUid={memberUid}&text={text}
Request Header:
Authorization: "{连接密钥}"
请求参数说明¶
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| workspaceId | string | 是 | 用户工作区的 id |
| 连接密钥 | string | 是 | API密钥 |
| memberUid | string | 是 | 工作区中成员的 uid |
| text | string | 是 | 成员提的问题,比如“今年每月营业额”,需要该问题的第一张卡片可以生成数据解释 |
返回结果¶
返回结果的 data 内容包含如下字段:
| 参数 | 类型 | 说明 |
|---|---|---|
| type | string | 返回的数据解释来源,目前包含 text 和 llm,分别代表由北极九章生成和大语言模型生成 |
| text | string | 数据解释内容 |
- 如果工作区关闭数据解释或卡片没有数据解释,会返回 400 错误
{
"errcode": 400,
"errmsg": "用户问题无法搜索出数据解释"
}
- 数据解释任务执行失败,会返回 400 错误
{
"errcode": 400,
"errmsg": "获取数据解释内容失败:{错误信息}"
}
- 获取数据解释超时,会返回 400 错误
{
"errcode": 400,
"errmsg": "获取数据解释超时"
}
- 数据解释任务执行成功,但无返回结果,会返回 400 错误
{
"errcode": 400,
"errmsg": "获取数据解释失败"
}