生成看板图表 SQL 草稿

根据自然语言问题生成当前数据看板可用的只读 SQL 草稿和建议图表类型。接口只生成并校验草稿，不执行 SQL，也不创建看板图表。

POST https://api.moi.matrixorigin.cn/v5/data-dashboards/{dashboard_id}/generate-sql

调用前准备

先在查询数据看板列表中选择已配置数据库和数据表的数据看板。

准备可访问目标工作区的个人访问令牌和目标工作区 ID。

请求体

将示例中的 $DASHBOARD_ID、$AI_STUDIO_API_KEY、$WORKSPACE_ID 替换为实际值。

curl -X POST "https://api.moi.matrixorigin.cn/v5/data-dashboards/$DASHBOARD_ID/generate-sql" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "统计最近 30 天每天的销售额",
  "title": "近 30 天销售趋势"
}'

参数

类型

是否必填

说明

dashboard_id

string

是

数据看板 ID。

请求体

字段

类型

是否必填

说明

question

string

是

希望通过数据回答的问题，不能为空。

title

string

否

图表标题，用于辅助生成草稿。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "sql_text": "SELECT sale_date, SUM(amount) AS total_amount FROM sales WHERE sale_date >= DATE_SUB(CURRENT_DATE, INTERVAL 30 DAY) GROUP BY sale_date ORDER BY sale_date",
    "chart_type": "line"
  }
}

字段

类型

说明

data.sql_text

string

生成并校验通过的只读 SQL 草稿。

data.chart_type

string

建议使用的图表类型。取值：metric、table、line、bar、pie、area、combo、stacked_bar、scatter。

错误响应

{
  "code": "ErrDataDashboardSQLDraftValidationFailed",
  "message": "生成的 SQL 未通过校验"
}

字段

类型

说明

code

integer 或 string

错误代码或状态码。

message

string

错误信息。
最后更新于