GetYaoChiAgent - Database Autonomy Service - Alibaba Cloud ドキュメントセンター

Yaochi Agent 大規模モデルインターフェースは、質問応答およびパフォーマンス診断の機能を提供します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:GetYaoChiAgent

get

*All Resource

*

なし

リクエスト構文

POST /agent HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Query	string	必須	自然言語クエリ。	Are there any issues or abnormalities with my instance rm-xxx?
SessionId	string	任意	オプション。UUID 形式のセッション ID。このパラメーターを省略すると、新しいセッションが作成されます。会話のコンテキストを維持するには、後続のすべてのリクエストで同じセッション 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	応答オブジェクト。
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	ツール呼び出しの引数。JSON 文字列としてフォーマットされます。	{"arg": "xxx"}
Id	string	ツール呼び出しの一意の ID。	12345
Status	string	ツール呼び出しの現在のステータス。	RUNNING
UiFunctionCall	array<object>	インタラクティブな UI カードをレンダリングするために使用されるカードツール呼び出しのリスト。
	object	単一の UI 関数呼び出し。
ArgsText	string	カードツールの引数。JSON 文字列としてフォーマットされます。	{"arg": "xxx"}
ToolName	string	カードツールの名前。	card
SessionId	string	セッション ID。この値は、リクエストの `SessionId` と一致します。	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
QueryId	string	クエリ ID。この値は、リクエストの `QueryId` と一致します。	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
SubAgentCall	array<object>	サブエージェント呼び出しの詳細リスト。
	object	単一のサブエージェント呼び出し。
SubAgentId	string	サブエージェントの一意の ID。	12345
SubAgentName	string	サブエージェントの名前。	XX Agent
Status	string	サブエージェント呼び出しのステータス。	running
ParentId	string	親 ID。このパラメーターは、サブエージェントからのメッセージに対してのみ返されます。そのような場合、値はサブエージェントの ID (`SubAgentId`) です。	12345

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。