Method: projects.locations.apps.assistantSessions.cancelAssistantTurn

アシスタント セッションの処理中のターンをキャンセルします（存在する場合）。これは、ストリームから切り離されて実行されているターンをユーザーが明示的に停止するものです。ターンをホストしていないタスクにキャンセルが到達すると、代わりにセッション ターン エポックを介してプリエンプトされ、1 回のリース更新内で終了します。

HTTP リクエスト

POST https://ces.googleapis.com/v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。キャンセルするインフライト ターンを含むアシスタント セッション。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "turnId": string
}
フィールド
turnId

string

省略可。キャンセルするターン。空の場合、実行中のターンがキャンセルされます。実行中でなくなったターンを指定するキャンセルは、何も行いません。

レスポンスの本文

assistantSessions.cancelAssistantTurn のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "cancelled": boolean
}
フィールド
cancelled

boolean

処理中のターンが見つかり、停止を求められたかどうか（このタスクで直接、または別の場所でホストされているターンのエポック プリエンプションを介して）。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • ces.assistantSessions.get

詳細については、IAM のドキュメントをご覧ください。