调用GetDasAgentSSE进行知识问答与性能诊断-数据库自治服务-阿里云

接口说明

该接口是付费接口，会按照输出字符进行计费，请确保在使用该接口前，已充分了解 DAS Agent 产品的收费方式和价格。提供 java 和 Python两个调用示例供参考。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hdm:GetDasAgentSSE

get

*全部资源

*

无

请求语法

POST /getDasAgentSSE HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Query	string	是	问答自然语言描述	Are there any issues or abnormalities with my instance rm-xxx?
InstanceId	string	否	废弃参数，实例 Id 通过 Query 字段传入	rm-xxxx
SessionId	string	否	可选，会话 Id，UUID 字符串格式，未传入会创建新的会话，上下文对话需保持同一个会话 Id	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
AgentId	string	否	可选，默认使用默认 Agent 进行服务，或者传入开启 DASAgent 服务后生成的或者主动创建的 Agent	ag-472T0DxtmjIxxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Id	string	SessionId，同请求参数中的 SessionId	xxx-xxx-xxx
Answer	string	回答内容	rm-xxxx
Metadata	object	元信息
Code	integer	如果异常，会返回错误类型，无异常时返回为空	-1810001
CharCount	integer	回答的字符数量	1403
ToolName	string	调用的工具命令	SqlFilter
ToolParams	array	工具参数
	string	字符串列表	["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"]
RequestId	string	请求 Id	04930480-9404-50CB-8252-Axxxxxxxx
Event	string	返回回答信息的类型枚举值： summary : 回答的相关统计 error : 报错信息 agent_message : 大模型生成的回答	summary

示例

正常返回示例

JSON格式

{
  "Id": "xxx-xxx-xxx",
  "Answer": "rm-xxxx",
  "Metadata": {
    "Code": -1810001,
    "CharCount": 1403,
    "ToolName": "SqlFilter",
    "ToolParams": [
      "[\"--instanceId\", \"rm-*****\", \"--sqlText\", \"select~from~das~where~name~das1\"]"
    ],
    "RequestId": "04930480-9404-50CB-8252-Axxxxxxxx"
  },
  "Event": "summary"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
500	Timeout	The request processing has failed due to timeout.	由于超时请求处理失败。
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作
404	InstanceNotFound	Requested instance not found.	对应实例id无法找到

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

变更历史

更多信息，参考变更详情。