GetYaoChiAgent - Database Autonomy Service - Alibaba Cloud Documentation Center

Invokes the ApsaraDB Agent large language model API to perform tasks such as knowledge Q&A and performance diagnostics.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:GetYaoChiAgent

get

*All Resource

*

None

Request syntax

POST /agent HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Query	string	Yes	The natural language description of the query.	Are there any issues or abnormalities with my instance rm-xxx?
SessionId	string	No	Optional. The session ID, which is a UUID string. If this parameter is not specified, a new session is created. To maintain context in a conversation, use the same session ID.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
Source	string	No	Optional. The source cloud service. Specifies the cloud service to which the Q&A belongs. Default value: yaochi. Valid values: 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	No	Optional. The additional information, which is a JSON string.	{}
ImageKeys	string	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
Content	string	The response content.	xxx
RequestId	string	The request ID.	7172BECE-588A-5961-8126-C216E16B****
ReasoningContent	string	The reasoning content generated by the model.	xxx
Product	string	The type of the cloud service.	polardb
FunctionCall	array<object>	The tool invocation list.
	object	The list of strings.
Name	string	The name of the called tool.	sqlReview
Arguments	string	The arguments of the called tool.	{"arg": "xxx"}
Id	string	The tool ID.	12345
Status	string	The tool invocation status.	RUNNING
UiFunctionCall	array<object>	The card tool invocation list.
	object	The list of strings.
ArgsText	string	The arguments of the card tool.	{"arg": "xxx"}
ToolName	string	The name of the card tool.	card
SessionId	string	The session ID, which is the same as the SessionId request parameter.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
QueryId	string	The query ID, which is the same as the QueryId request parameter.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
SubAgentCall	array<object>	The list of sub-agent invocation information.
	object	The list of strings.
SubAgentId	string	The sub-agent ID.	12345
SubAgentName	string	The name of the sub-agent.	XX Agent
Status	string	The status of the sub-agent.	running
ParentId	string	The parent ID. This field exists only when the message is generated by a sub-agent, and its value is the sub-agent ID.	12345

Examples

Success response

JSON format

{
  "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.