GetYaoChiAgent - Database Autonomy Service - Alibaba Cloud Documentation Center

The Yaochi Agent large model interface provides capabilities for question answering and performance diagnosis.

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 query.	Are there any issues or abnormalities with my instance rm-xxx?
SessionId	string	No	Optional. The session ID in UUID format. Omitting this parameter creates a new session. To maintain conversational context, pass the same session ID in all subsequent requests.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
Source	string	No	Optional. The cloud product to query. The default value is `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. Additional information as a JSON string.	{}

Response elements

Element	Type	Description	Example
	object	The response object.
Content	string	The response content.	xxx
RequestId	string	The request ID.	7172BECE-588A-5961-8126-C216E16B****
ReasoningContent	string	The model's reasoning content.	xxx
Product	string	The cloud product type.	polardb
FunctionCall	array<object>	A list of tool calls.
	object	A single tool call.
Name	string	The name of the tool to call.	sqlReview
Arguments	string	The arguments for the tool call, formatted as a JSON string.	{"arg": "xxx"}
Id	string	A unique ID for the tool call.	12345
Status	string	The current status of the tool call.	RUNNING
UiFunctionCall	array<object>	A list of card tool calls used to render interactive UI cards.
	object	A single UI function call.
ArgsText	string	The arguments for the card tool, formatted as a JSON string.	{"arg": "xxx"}
ToolName	string	The name of the card tool.	card
SessionId	string	The session ID. This value matches the `SessionId` in the request.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
QueryId	string	The query ID. This value matches the `QueryId` in the request.	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
SubAgentCall	array<object>	A list of sub-agent call details.
	object	A single sub-agent call.
SubAgentId	string	The unique ID for the sub-agent.	12345
SubAgentName	string	The name of the sub-agent.	XX Agent
Status	string	The status of the sub-agent call.	running
ParentId	string	The parent ID. This parameter is returned only for messages from a sub-agent. In such cases, the value is the sub-agent's ID (`SubAgentId`).	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.