Message

会話内のメッセージ。

JSON 表現
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
フィールド
role

string

省略可。会話内のロール(ユーザー、エージェントなど)。

chunks[]

object (Chunk)

省略可。メッセージのコンテンツをチャンクのシーケンスとして表します。

eventTime

string (Timestamp format)

省略可。メッセージが送信または受信されたときのタイムスタンプ。メッセージが example の一部である場合は使用しないでください。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

チャンク

メッセージ内のコンテンツのチャンク。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of mutually exclusive fields.
}
フィールド
チャンクデータ。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
text

string

省略可。テキストデータ。

transcript

string

省略可。音声に関連付けられた文字起こし。

blob

object (Blob)

省略可。Blob データ。

payload

object (Struct format)

省略可。カスタム ペイロード データ。

image

object (Image)

省略可。画像データ。

toolCall

object (ToolCall)

省略可。ツールの実行リクエスト。

toolResponse

object (ToolResponse)

省略可。ツール実行のレスポンス。

agentTransfer

object (AgentTransfer)

省略可。エージェントの転送イベント。

updatedVariables

object (Struct format)

構造体は、会話で更新された変数を変数名でキー設定して表します。

defaultVariables

object (Struct format)

構造体は、会話の開始時のデフォルト変数を表します。変数名でキー設定されます。

相互に排他的なフィールドの終わり。

Blob

会話内の BLOB の入力または出力を表します。

JSON 表現
{
  "mimeType": string,
  "data": string
}
フィールド
mimeType

string

必須。ソースデータの IANA 標準 MIME タイプ。

data

string (bytes format)

必須。blob の元のバイト。

Base64 でエンコードされた文字列。

画像

会話内の画像入力または画像出力を表します。

JSON 表現
{
  "mimeType": string,
  "data": string,
  "altText": string
}
フィールド
mimeType

string

必須。ソースデータの IANA 標準 MIME タイプ。サポートされている画像タイプは次のとおりです。* image/png * image/jpeg * image/webp

data

string (bytes format)

必須。画像の未加工のバイト数。

Base64 でエンコードされた文字列。

altText

string

省略可。画像の代替テキスト。

ToolCall

クライアントまたはエージェントに指定されたツールの実行をリクエストします。

JSON 表現
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
フィールド
id

string

省略可。ツール呼び出しの固有識別子。入力されている場合、クライアントは ToolResponse の照合用のウェブ商品アイテム ID を含む実行結果を返す必要があります。

displayName

string

出力専用。ツールの表示名。

args

object (Struct format)

省略可。JSON オブジェクト形式のツールの入力パラメータと値。

parentToolCallId

string

出力専用。親通話の代わりに作業しているサブエージェントによって発行された場合、このツール呼び出しの原因となったツール呼び出しの ID。トップレベルの呼び出しの場合は空。クライアントが、サブエージェントの作業を、すべてのステップを兄弟としてレンダリングするのではなく、その作業を開始した呼び出しの下にグループ化できるようにします。

agentName

string

出力専用。この呼び出しを発行したエージェントの人が読める形式の名前(「契約アーキテクト」など)。ルート エージェントが発行した場合は空。

実行するツールの識別子。永続化されたツールまたはツールセットのツールです。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
tool

string

省略可。実行するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

省略可。実行するツールセット ツール。

相互に排他的なフィールドの終わり。

ToolsetTool

ツールセットから作成されたツール。

JSON 表現
{
  "toolset": string,
  "toolId": string
}
フィールド
toolset

string

必須。このツールが派生した Toolset のリソース名。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

toolId

string

省略可。スキーマを取得するツールをフィルタするツール ID。

ToolResponse

クライアントまたはエージェントからの特定のツールの実行結果。

JSON 表現
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
フィールド
id

string

省略可。レスポンスの対象となる tool call の照合用のウェブ商品アイテム ID。

displayName

string

出力専用。ツールの表示名。

response

object (Struct format)

必須。JSON オブジェクト形式のツール実行結果。「output」キーを使用してツールのレスポンスを指定し、「error」キーを使用してエラーの詳細を指定します(ある場合)。「output」キーと「error」キーが指定されていない場合、レスポンス全体がツール実行結果として扱われます。

parentToolCallId

string

出力専用。親通話の代わりに作業しているサブエージェントによって発行された場合、このツール呼び出しの原因となったツール呼び出しの ID。トップレベルの呼び出しの場合は空。クライアントが、サブエージェントの作業を、すべてのステップを兄弟としてレンダリングするのではなく、その作業を開始した呼び出しの下にグループ化できるようにします。

agentName

string

出力専用。この呼び出しを発行したエージェントの人が読める形式の名前(「契約アーキテクト」など)。ルート エージェントが発行した場合は空。

実行されたツールの ID。永続化されたツールまたはツールセットのツールです。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
tool

string

省略可。実行するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

省略可。実行されたツールセット ツール。

相互に排他的なフィールドの終わり。

AgentTransfer

会話が別のエージェントに転送されたことを示すイベントを表します。

JSON 表現
{
  "targetAgent": string,
  "displayName": string
}
フィールド
targetAgent

string

必須。会話の転送先のエージェント。ここから先は、エージェントが会話に対応します。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayName

string

出力専用。エージェントの表示名。