GetDasAgentSSE API 呼び出しによる SSE ストリーミングデータベース診断 - DAS - Alibaba Cloud - Database Autonomy Service

DAS large モデルのインタラクティブな SSE インターフェイスを提供します。AI チャットやパフォーマンス診断などの特徴をサポートしています。

操作説明

これは有料 API であり、出力文字数に基づいて課金されます。この API を使用する前に、DAS 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:GetDasAgentSSE

get

*すべてのリソース。

*

なし

リクエスト構文

POST /getDasAgentSSE HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Query	string	必須	クエリの自然言語による説明。	私のインスタンス rm-xxx に問題や異常はありますか?
InstanceId	string	任意	非推奨のパラメーターです。インスタンス ID は Query フィールドを通じて渡されます。	rm-xxxx
SessionId	string	任意	任意。UUID 文字列フォーマットのセッション ID です。指定しない場合、新しい会話が作成されます。会話間でコンテキストを維持するには、同じセッション ID を使用してください。	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
AgentId	string	任意	任意。デフォルトでは、デフォルトのエージェントが使用されます。DAS Agent サービスの有効化後に生成されたエージェントや、手動で作成したエージェントを指定することもできます。	ag-472T0DxtmjIxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
Id	string	会話 ID。リクエストパラメーターの SessionId と同じ値です。	123e4567-e89b-12d3-a456-xxxxxxxxxxxx
Answer	string	回答の内容。	rm-xxxx
Metadata	object	メタデータ。
Code	integer	例外発生時に返されるエラータイプ。例外が発生していない場合、このフィールドは空です。	-1810001
CharCount	integer	回答の文字数。	1403
ToolName	string	呼び出されるツールコマンド。	SqlFilter
ToolParams	array	ツールのパラメーター。
	string	文字列のリスト。	["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"]
RequestId	string	リクエスト ID。	04930480-9404-50CB-8252-Axxxxxxxx
Event	string	返される回答情報のフォーマット。列挙値: summary : エージェントに関連する統計情報 [_single.resp.200.props.Event.enum. error ]エラー情報 [_single.resp.200.props.Event.enum.agent_message ]large 言語モデルによって生成された回答 [_single.resp.200.props.Event.enum. error ]エラー情報 [_single.resp.200.props.Event.enum.agent_message ]large モデルによって生成された回答 [responses.200.schema.properties.Event.enumValueTitles. error ]エラー情報 [responses.200.schema.properties.Event.enumValueTitles.agent_message ]large モデルによって生成された回答 error : 报错信息 agent_message : 大模型生成的回答	summary

例

成功レスポンス

JSONJSON

{
  "Id": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
  "Answer": "rm-xxxx",
  "Metadata": {
    "Code": -1810001,
    "CharCount": 1403,
    "ToolName": "SqlFilter",
    "ToolParams": [
      "[\"--instanceId\", \"rm-*****\", \"--sqlText\", \"select~from~das~where~name~das1\"]"
    ],
    "RequestId": "04930480-9404-50CB-8252-Axxxxxxxx"
  },
  "Event": "summary"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.	リクエストパラメーターが無効です。
500	Timeout	The request processing has failed due to timeout.	タイムアウトによりリクエストの処理に失敗しました。
403	NoPermission	You are not authorized to do this action.	この操作を実行する権限がありません。
404	InstanceNotFound	Requested instance not found.	対応するインスタンス ID が見つかりません。

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

変更履歴

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