自然语言查数接口 - InvokeNlQuery

功能介绍

自然语言查数接口。输入为自然语言数据查询问题，返回查询到的数据和对应的SQL。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

• 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
• 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/nl-query

请求参数

响应参数

状态码：200

请求示例

• 自然语言查数。

  POST https://{endpoint}/v1/{project_id}/nl-query
  
  {
    "message_content" : "去年11月公司的收入是多少",
    "dialog_id" : "66xxxx02x5axxx9xx12fxxx9c2xxxx6d",
    "subject_id" : "xa4axxx4-9xx9-4xx2-9xxx-3axxxxf4a5c3",
    "need_insight" : true
  }

• 自然语言查数，对结果精简。

  POST https://{endpoint}/v1/{project_id}/nl-query
  
  {
    "message_content" : "去年11月公司的收入是多少",
    "dialog_id" : "66xxxx02x5axxx9xx12fxxx9c2xxxx6d",
    "subject_id" : "xa4axxx4-9xx9-4xx2-9xxx-3axxxxf4a5c3",
    "need_insight" : true,
    "simplify_response" : true
  }

响应示例

状态码：200

nl-query请求返回体。

{
  "header" : [ {
    "caption" : "收入",
    "data_type" : "NUMBER",
    "level_type" : null,
    "model_type" : "measure"
  } ],
  "data" : [ [ "423xxx214.32" ] ],
  "sql_text" : "SELECT xxx AS xxx FROM xxx.xxx AS xxx",
  "insight" : "查询结果: 去年11月公司的收入为xxx。建议探索的方向：xxx。业务建议：xxx。"
}

状态码

错误码

请参见错误码。