Text2InsightQuery - 发起数据分析请求
向 Analytics Agent 提交一个自然语言问题,发起数据分析任务。
接口说明
本接口为异步接口。调用成功后返回
questionId 和初始状态 running,表示分析任务已开始执行。客户端需通过 SafeQuestionPoll 接口轮询获取分析结果。
使用须知
- 问题内容使用自然语言描述,Agent 会自动理解并执行分析
- 支持通过
指定使用的模型modelSettings - 同一个 Session 中可以连续发起多个问题,Agent 会保留对话上下文
使用建议
- 问题描述尽量清晰明确,包含时间范围、维度等关键信息
- 如需使用知识库辅助分析,可在问题中提示 Agent 查阅知识
请求方式
请求参数
| 参数名 | 位置 | 类型 | 是否必须 | 说明 |
|---|---|---|---|---|
| tenantId | Query + Body | Integer | 是 | 租户 ID |
| userId | Query + Body | Integer | 是 | 用户 ID |
| domainId | Body | Integer | 是 | 数据域 ID |
| sessionId | Body | Integer | 是 | 对话会话 ID,通过 CreateSession 获取或复用已有值 |
| msg | Body | String | 是 | 问题内容,自然语言描述的分析需求 |
| loginToken | Query + Body | String | 是 | 认证 Token |
| modelSettings | Body | Object | 否 | 模型配置 |
| modelSettings.model_name | Body | String | 否 | 指定使用的模型名称 |
返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| data.questionId | Integer | 问题 ID,用于后续轮询和停止操作 |
| data.sessionId | Integer | 会话 ID |
| data.status | String | 当前状态,初始值为 |
请求示例
返回示例
正常返回示例:
后续步骤
请求成功后,使用返回的
questionId 调用 SafeQuestionPoll 进行轮询,直到分析完成。
错误码
| 错误码 | 说明 |
|---|---|
| success=false | Token 无效、Session 不存在、参数缺失或模型不可用 |
相关文档
- CreateSession — 上一步:创建对话会话
- SafeQuestionPoll — 下一步:轮询获取分析结果
- 理解返回结果 — 消息类型详解与展示建议
- Quick Start 快速上手 — 完整端到端示例
联系我们
