CancelAgentSession - DataWorks - Alibaba Cloud ドキュメントセンター

指定されたセッション内のエージェント呼び出しをキャンセルします。この操作は、ストリーミング応答の中断にも対応しています。

操作説明

概要

特にストリーミング応答を生成中のセッションを中断する場合に、この API を使用します。
SessionId パラメーターは必須であり、キャンセル対象のセッションを識別します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Jsonrpc	string	任意	JSON-RPC のバージョンです。値は `2.0` である必要があります。	2.0
Id	string	任意	クライアントが提供するリクエスト ID で、応答に含まれて返されます。	676303114031776
Params	object	任意	リクエストのビジネスパラメーターです。
SessionId	string	任意	キャンセル対象のセッション ID を指定します。	sess_0f12abc34

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクトです。
RequestId	string	リクエスト ID です。	7CD3D216-5876-5DB1-A34A-396806F4A413
JsonRpcResponse	object	JSON-RPC の結果です。
Jsonrpc	string	JSON-RPC のバージョンです。値は `2.0` です。	2.0
Id	string	リクエストでクライアントが提供した ID です。	7675839888324361477
Result	object	セッションキャンセルの結果です。
SessionId	string	キャンセルされたセッション ID です。	session-d5d549fe4c2c4180a9814fb74190f502

例

成功レスポンス

JSONJSON

{
  "RequestId": "7CD3D216-5876-5DB1-A34A-396806F4A413",
  "JsonRpcResponse": {
    "Jsonrpc": "2.0",
    "Id": "7675839888324361477",
    "Result": {
      "SessionId": "session-d5d549fe4c2c4180a9814fb74190f502"
    }
  }
}

エラーコード

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

変更履歴

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