GetYaoChiAgent - Business Foundation SystemAgent大模型能力介面 - Database Autonomy Service

Business Foundation SystemAgent大模型能力介面，可以進行知識問答，效能診斷等功能

調試

您可以在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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。