Method: projects.locations.apps.runAssistant

指定されたアシスタント セッションのアシスタント エージェントを実行します。

HTTP リクエスト

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runAssistant

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

パスパラメータ

パラメータ
app

string

必須。アシスタントを実行するアプリ。形式: projects/{project}/locations/{location}/apps/{app}

リクエストの本文

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

JSON 表現 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
フィールド
assistantSession

string

必須。アシスタントの実行に使用されるアシスタント セッション。形式: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

必須。アシスタント エージェントに送信するメッセージ。
interactionType

enum (RunAssistantRequest.InteractionType)

省略可。アシスタント メッセージのさまざまなインタラクション タイプ。

レスポンスの本文

AssistantService.RunAssistant に対するレスポンス メッセージです。

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

JSON 表現 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
フィールド
output

object (AssistantOutput)

必須。アシスタント エージェントからの出力。
state

enum (AssistantSessionState)

出力専用。アシスタント セッションのステータス。

認可スコープ

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

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

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

IAM 権限

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

  • ces.apps.update

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

RunAssistantRequest.InteractionType

アシスタントに送信されたメッセージのインタラクションのタイプ。

列挙型
INTERACTION_TYPE_UNSPECIFIED デフォルト値。この値は、タイプが指定されていない場合に使用されます。
NEW_MESSAGE メッセージはユーザー入力です。ユーザー入力はチャンクリストで提供されます。
POLL このメッセージは、アシスタント セッションの状態をポーリングするためのものです。
DISMISS このメッセージは、審査待ちのアシスタント セッションを閉じるためのものです。これにより、アシスタント セッションの状態がアイドルに変わります。

AssistantOutput

アシスタント エージェントからの出力。

JSON 表現 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
フィールド
message

object (AssistantMessage)

必須。アシスタント エージェントからの回答。
userResponseSuggestions

object (UserResponseSuggestions)

出力専用。アシスタント エージェントからのユーザーの回答候補。