GetYaoChiAgent - 瑶池Agent大模型能力接口-数据库自治服务(DAS)-阿里云帮助中心

瑶池Agent大模型能力接口，可以进行知识问答，性能诊断等功能

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hdm:GetYaoChiAgent

get

*全部资源

*

无

请求语法

POST /agent HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Query	string	是	问答自然语言描述	Are there any issues or abnormalities with my instance rm-xxx?
SessionId	string	否	可选，会话 Id，格式为 UUID 字符串。未传入会创建新的会话，上下文对话需保持同一个会话 Id	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
Source	string	否	非必填，云产品来源，指定问答所属的云产品，未填写默认为 yaochi 枚举值： tair : tair dbs : dbs polardb-ai : polardb-ai polarx : polarx yaochi : yaochi polarx-light : polarx-light lindorm : lindorm mongodb : mongodb polardb : polardb	yaochi
ExtraInfo	string	否	非必填，附加信息，json 字符串	{}

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Content	string	回答内容	xxx
RequestId	string	请求 ID	7172BECE-588A-5961-8126-C216E16B****
ReasoningContent	string	模型思维内容	xxx
Product	string	云产品类型	polardb
FunctionCall	array<object>	工具调用列表
	object	字符串列表
Name	string	调用工具名称	sqlReview
Arguments	string	调用工具参数	{"arg": "xxx"}
Id	string	工具 ID	12345
Status	string	工具调用状态	RUNNING
UiFunctionCall	array<object>	卡片工具调用列表
	object	字符串列表
ArgsText	string	卡片工具参数	{"arg": "xxx"}
ToolName	string	卡片工具名称	card
SessionId	string	SessionId，同请求参数中的 SessionId	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
QueryId	string	QueryId，同请求参数中的 QueryId	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
SubAgentCall	array<object>	子 Agent 调用信息列表
	object	字符串列表
SubAgentId	string	子 AgentID	12345
SubAgentName	string	子 Agent 名称	XX Agent
Status	string	子 Agent 状态	running
ParentId	string	仅当消息为子 Agent 输出时，存在 ParentId 字段，且值为子 AgentID	12345

示例

正常返回示例

JSON格式

{
  "Content": "xxx",
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "ReasoningContent": "xxx",
  "Product": "polardb",
  "FunctionCall": [
    {
      "Name": "sqlReview",
      "Arguments": "{\"arg\": \"xxx\"}",
      "Id": "12345",
      "Status": "RUNNING"
    }
  ],
  "UiFunctionCall": [
    {
      "ArgsText": "{\"arg\": \"xxx\"}",
      "ToolName": "card"
    }
  ],
  "SessionId": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "QueryId": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "SubAgentCall": [
    {
      "SubAgentId": "12345",
      "SubAgentName": "XX Agent",
      "Status": "running"
    }
  ],
  "ParentId": "12345"
}

错误码

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

变更历史

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