RunDataAnalysis - Chat对话接口

更新时间:2025-03-14 02:33:30

析言为您提供了与官方页面对话效果相同的open api接口,只需传入workspaceId以及query等相关信息,即可对您已经创建好的业务空间进行问答和数据分析。

接口说明

请确保在使用该接口前,已充分了解析言产品的收费方式和价格

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
dataanalysisgbi:RunDataAnalysisnone
*全部资源
*

请求语法

POST /{workspaceId}/gbi/runDataAnalysis HTTP/1.1

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
workspaceIdstring

当前请求所使用的百炼业务空间 id

llm-2v3934xtp49esw64
bodyobject

请求体参数

specificationTypestring

当前请求指定使用的版本信息,不填时使用默认业务空间版本

枚举值:
  • STANDARD_TURBO标准版turbo
  • STANDARD_MIX标准版mix
  • CUSTOMIZATION定制版turbo
STANDARD_MIX
generateSqlOnlyboolean

当前请求只生成并返回 sql,不会执行

true
querystring

用户输入的 query

请问销量前十的产品有哪些
sessionIdstring

消息会话 ID,服务窗回调消息返回的会话 ID。

sessionID
dataRolearray

数据权限-角色名称的列表

说明
数据权限的相关配置内容需要在产品页面进行配置后,方可获取参数在 api 中调用
string

数据权限-角色名称的具体名字

管理员
userParamsany

数据角色依赖的自定义参数,当该角色配置了外部参数,必须传入

说明
数据权限的相关配置内容需要在产品页面进行配置后,方可获取参数在 api 中调用
{ "shopId":[ "1", "2" ], "userId":"10001" }
agentCtrlParamsany

当前对话接口所透传的自定义参数,现仅支持:跳过改写、跳过可视化模块

{ "withoutRewrite": true, "withoutVisualization": true }

返回参数

名称类型描述示例值
名称类型描述示例值
object

Schema of Response

dataobject

返回信息

errorMessagestring

错误信息

Access was denied, message: No such namespace namespaces/tech-scp-chain7.
eventstring

事件类型

枚举值:
  • result最终结果事件
  • evidence所用到的辅助模型推理的信息
  • sql_part流式生成sql的中间事件
  • sql_datasql执行获取到结果的事件
  • selector选表事件
  • refine开启重试时的重试事件
  • rewrite改写事件
  • sql生成sql的最终事件
rewrite
evidencestring

所用到的辅助模型推理的信息

今年是2024
requestIdstring

当前本次请求的 id

DA2578F7-88A5-5D6E-9305-33E724E97D60
rewritestring

改写后的用户输入

查询全部关键字数据,并以饼图形式展示
selectorarray

这次对话,召回了哪些表以用于 sql 的生成

selectorstring

召回的具体的表的名字

table_name1
sessionIdstring

对话 ID

sessionid1
sqlstring

当前对话生成的 SQL 语句

select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between '2022-10-22' and '2024-10-22' group by p.product_id, p.product_name having total_sales > 5
sqlDataobject

sql 执行所返回的结构化内容

columnarray

sql 执行结果中,查询的具体的字段名字

columnstring

具体的字段名字内容

product
dataarray<object>

sql 执行后获取的结构化数据,可能是多条

valueobject

sql 执行后所查询到的结构化数据的一条内容

{ "product_id": "29", "total_sales": "63", "product_name": "1L迷你电热水壶" }
sqlErrorstring

当任务执行失败时,此字段会报错导致任务失败的原因

Can not issue data manipulation statements with executeQuery()
visualizationobject

用于可视化模块展示所需要的信息

dataobject

用于可视化模块展示的结构化信息

plotTypestring

可视化图表展示的类型

枚举值:
  • bar柱状图
  • line折线图
  • pie饼状图
bar
xAxisarray

可视化图表中 x 轴的内容

xAxisstring

具体某一个 x 轴所展示的字段

product_name
yAxisarray

可视化图表中 y 轴的内容

yAxisstring

具体某一个 y 轴所展示的字段

total_sales
textstring

对于 sql 执行结果的分析总结

查询结果显示,在过去两年中销量超过5的所有产品包括:2L大容量空气炸锅销售了109件,青春版运动手环销售了119件,2L大容量全自动豆浆机销售了106件,无线蓝牙耳机快充版销售了84件,2L大容量便携式榨汁机销售了136件,青春版智能手表销售了104件,挂壁式护眼台灯销售了102件,P30手机8+256G销售了83件,2L大容量电热水壶销售了84件,男士电动化妆刷套装销售了197件,旅行箱销售了82件,手链销售了101件,项链销售了84件,头饰发链销售了89件,腕表销售了98件,戒指销售了157件,真皮皮包销售了136件,风衣大衣销售了76件,运动旅行包销售了91件,丝巾销售了265件,1L迷你空气炸锅销售了85件,豪华款运动手环销售了132件,1L迷你全自动豆浆机销售了81件,豪华版无线蓝牙耳机(绿色)销售了122件,1L迷你便携式榨汁机销售了76件,豪华款智能手表销售了76件,粘贴式护眼台灯销售了109件,M60手机16+512G销售了109件,1L迷你电热水壶销售了63件,女士电动化妆刷套装销售了158件。
httpStatusCodelong

当前某一轮事件透出的 http 状态码,正常情况下不会额外透出,无需处理

200
messagestring

系统错误透出的报错信息,用于报错排查,无需用户处理

org.springframework.core.task.TaskRejectedException: ExecutorService in active state did not accept task: java.util.concurrent.CompletableFuture$AsyncSupply@25653b3b
codestring

系统错误透出的错误码,用于报错排查,无需用户处理

NoAuth
httpStatusCodelong

当前本次请求透出的 http 状态码,正常情况下不会额外透出,无需处理

200

示例

正常返回示例

JSON格式

{
  "data": {
    "errorMessage": "Access was denied, message: No such namespace namespaces/tech-scp-chain7.",
    "event": "rewrite",
    "evidence": "今年是2024年",
    "requestId": "DA2578F7-88A5-5D6E-9305-33E724E97D60",
    "rewrite": "查询全部关键字数据,并以饼图形式展示",
    "selector": [
      "table_name1"
    ],
    "sessionId": "sessionid1",
    "sql": "select p.product_id, p.product_name, sum(o.quantity) as total_sales from products p join orders o on p.product_id = o.product_id where o.order_date between '2022-10-22' and '2024-10-22' group by p.product_id, p.product_name having total_sales > 5",
    "sqlData": {
      "column": [
        "product"
      ],
      "data": [
        {
          "product_id": "29",
          "total_sales": "63",
          "product_name": "1L迷你电热水壶"
        }
      ]
    },
    "sqlError": "Can not issue data manipulation statements with executeQuery()",
    "visualization": {
      "data": {
        "plotType": "bar",
        "xAxis": [
          "product_name"
        ],
        "yAxis": [
          "total_sales"
        ]
      },
      "text": "查询结果显示,在过去两年中销量超过5的所有产品包括:2L大容量空气炸锅销售了109件,青春版运动手环销售了119件,2L大容量全自动豆浆机销售了106件,无线蓝牙耳机快充版销售了84件,2L大容量便携式榨汁机销售了136件,青春版智能手表销售了104件,挂壁式护眼台灯销售了102件,P30手机8+256G销售了83件,2L大容量电热水壶销售了84件,男士电动化妆刷套装销售了197件,旅行箱销售了82件,手链销售了101件,项链销售了84件,头饰发链销售了89件,腕表销售了98件,戒指销售了157件,真皮皮包销售了136件,风衣大衣销售了76件,运动旅行包销售了91件,丝巾销售了265件,1L迷你空气炸锅销售了85件,豪华款运动手环销售了132件,1L迷你全自动豆浆机销售了81件,豪华版无线蓝牙耳机(绿色)销售了122件,1L迷你便携式榨汁机销售了76件,豪华款智能手表销售了76件,粘贴式护眼台灯销售了109件,M60手机16+512G销售了109件,1L迷你电热水壶销售了63件,女士电动化妆刷套装销售了158件。"
    },
    "httpStatusCode": 200,
    "attempts": [
      ""
    ]
  },
  "message": "org.springframework.core.task.TaskRejectedException: ExecutorService in active state did not accept task: java.util.concurrent.CompletableFuture$AsyncSupply@25653b3b",
  "code": "NoAuth",
  "httpStatusCode": 200
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
401NoAuthBad Request: Workspace.Illegal.Auth.当前所使用的账号无所指定业务空间的权限
401Internal.ErrorBad Request: Internal Error.内部错误,请联系客服人员排查

访问错误中心查看更多错误码。

  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码