Method: projects.locations.collections.engines.assistants.agents.message.send

エージェントにメッセージを送信します。これは、タスクが完了するとタスクを返すブロッキング呼び出しです。LRO がリクエストされた場合は LRO を返します。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/message:send

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

パスパラメータ

パラメータ
tenant

string

省略可能なテナント。パスパラメータとして指定します。試験運用版。1.0 リリースで変更される可能性があります。

リクエストの本文

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

JSON 表現
{
  "message": {
    object (Message)
  },
  "configuration": {
    object (SendMessageConfiguration)
  },
  "metadata": {
    object
  }
}
フィールド
message

object (Message)

必須。エージェントに送信するメッセージ。

configuration

object (SendMessageConfiguration)

送信リクエストの構成。

metadata

object (Struct format)

リクエストのメタデータ(省略可)。

レスポンスの本文

////// レスポンス メッセージ ///////////

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

JSON 表現
{

  // Union field payload can be only one of the following:
  "task": {
    object (Task)
  },
  "message": {
    object (Message)
  }
  // End of list of possible types for union field payload.
}
フィールド

共用体フィールド payload

payload は次のいずれかになります。

task

object (Task)

message

object (Message)

認可スコープ

次の OAuth スコープが必要です。

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

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