Message

ユーザーとシステム間のインタラクションからのメッセージ。

JSON 表現
{
  "timestamp": string,
  "messageId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMessage": {
    object (UserMessage)
  },
  "systemMessage": {
    object (SystemMessage)
  }
  // End of mutually exclusive fields.
}
フィールド
timestamp

string (Timestamp format)

出力専用。ユーザー メッセージの場合、これはシステムがメッセージを受信した時刻です。システム メッセージの場合、これはシステムがメッセージを生成した時刻です。

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"。

messageId

string

省略可。永続化のための会話内のメッセージの一意の ID。

メッセージの種類。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
userMessage

object (UserMessage)

システムとやり取りしているユーザーからのメッセージ。

systemMessage

object (SystemMessage)

ユーザーへの応答としてシステムから送信されるメッセージ。

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

UserMessage

システムとやり取りしているユーザーからのメッセージ。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string
  // End of mutually exclusive fields.
}
フィールド
ユーザー メッセージのコンテンツの種類。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
text

string

テキストには blob ではなくこのフィールドを使用する必要があります。

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

SystemMessage

ユーザーへの応答としてシステムから送信されるメッセージ。このメッセージは、システムとのマルチターンの会話の履歴コンテキストとしてのユーザーからのメッセージである可能性もあります。

JSON 表現
{
  "citation": {
    object (Citation)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": {
    object (TextMessage)
  },
  "schema": {
    object (SchemaMessage)
  },
  "data": {
    object (DataMessage)
  },
  "analysis": {
    object (AnalysisMessage)
  },
  "chart": {
    object (ChartMessage)
  },
  "error": {
    object (ErrorMessage)
  },
  "exampleQueries": {
    object (ExampleQueries)
  },
  "clarification": {
    object (ClarificationMessage)
  }
  // End of mutually exclusive fields.
  "groupId": integer
}
フィールド
citation

object (Citation)

出力専用。システム メッセージの引用情報。

システム メッセージのコンテンツの種類。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
text

object (TextMessage)

ユーザー メッセージに対する自然言語の直接的な回答。

schema

object (SchemaMessage)

スキーマの解決中に生成されたメッセージ。

data

object (DataMessage)

データの取得中に生成されたメッセージ。

analysis

object (AnalysisMessage)

分析中に生成されたメッセージ。

chart

object (ChartMessage)

グラフの生成中に生成されたメッセージ。

error

object (ErrorMessage)

エラー メッセージ。

exampleQueries

object (ExampleQueries)

省略可。クエリの例を含むメッセージ。

clarification
(deprecated)

object (ClarificationMessage)

省略可。非推奨: 代わりに TextType.FINAL_RESPONSE を指定した TextMessage を使用してください。確認のための質問を含むメッセージ。

相互に排他的なフィールドの終了。
groupId

integer

イベントが属するグループを識別します。類似するイベントは論理的に関連性があると見なされ、UI で一緒に表示されます。

TextMessage

マルチパート テキスト メッセージ。

JSON 表現
{
  "parts": [
    string
  ],
  "textType": enum (TextType),
  "thoughtSignature": string
}
フィールド
parts[]

string

省略可。メッセージの各部分。

textType

enum (TextType)

省略可。テキスト メッセージのタイプ。

thoughtSignature

string (bytes format)

省略可。思考の不透明な署名。後続のリクエストで再利用できます。

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

TextType

テキスト メッセージのタイプ。

列挙型
TEXT_TYPE_UNSPECIFIED デフォルトのテキストタイプ。
FINAL_RESPONSE テキストはユーザーの質問に対する最終的な回答です。
THOUGHT テキストはモデルからの思考です。
PROGRESS テキストは、ツールの呼び出しなど、エージェントの進行状況に関する情報メッセージです。これは、エージェントの内部思考プロセス(THOUGHT)やユーザーへの最終回答(FINAL_RESPONSE)とは異なります。これらのメッセージは、エージェントのアクションに関する分析情報を提供します。
FOLLOWUP_QUESTIONS テキストは、提案されたフォローアップの質問のリストです。parts の各アイテムはフォローアップの質問です。

SchemaMessage

スキーマの解決中に生成されたメッセージ。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "query": {
    object (SchemaQuery)
  },
  "result": {
    object (SchemaResult)
  }
  // End of mutually exclusive fields.
}
フィールド
このメッセージにクエリまたはスキーマ解決の結果が含まれているかどうか。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
query

object (SchemaQuery)

スキーマ解決クエリ。

result

object (SchemaResult)

スキーマ解決クエリの結果。

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

SchemaQuery

提示された質問に関連するスキーマを解決するためのクエリ。

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

string

省略可。スキーマ解決のためにシステムに送信する質問。

SchemaResult

スキーマ解決の結果。

JSON 表現
{
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
フィールド
datasources[]

object (Datasource)

省略可。スキーマクエリの解決に使用されるデータソース。

Datasource

質問への回答に使用できるデータソース。

JSON 表現
{
  "schema": {
    object (Schema)
  },
  "structSchema": {
    object
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "bigqueryTableReference": {
    object (BigQueryTableReference)
  },
  "studioDatasourceId": string,
  "lookerExploreReference": {
    object (LookerExploreReference)
  },
  "alloyDbReference": {
    object (AlloyDbReference)
  },
  "spannerReference": {
    object (SpannerReference)
  },
  "cloudSqlReference": {
    object (CloudSqlReference)
  },
  "bigtableReference": {
    object (BigtableReference)
  },
  "bigqueryPropertyGraphReference": {
    object (BigQueryPropertyGraphReference)
  },
  "firestoreReference": {
    object (FirestoreReference)
  }
  // End of mutually exclusive fields.
}
フィールド
schema

object (Schema)

省略可。データソースのスキーマ。

structSchema

object (Struct format)

省略可。スキーマの構造体表現。これは、厳密に型指定された schema フィールドで完全に表現できないスキーマを持つデータソースの場合に入力されます。

Looker データソースの場合、これは LookmlModelExplore タイプ(https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore)にマッピングされます。

データソースへの参照。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
bigqueryTableReference

object (BigQueryTableReference)

BigQuery テーブルへの参照。

studioDatasourceId

string

Looker Studio データソースへの参照。

lookerExploreReference

object (LookerExploreReference)

Looker Explore への参照。

alloyDbReference

object (AlloyDbReference)

AlloyDB データベースへの参照。

spannerReference

object (SpannerReference)

Spanner データベースへの参照。

cloudSqlReference

object (CloudSqlReference)

CloudSQL データベースへの参照。

bigtableReference

object (BigtableReference)

Bigtable インスタンスへの参照。

bigqueryPropertyGraphReference

object (BigQueryPropertyGraphReference)

BigQuery プロパティ グラフへの参照。

firestoreReference

object (FirestoreReference)

Firestore データベースへの参照。

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

DataMessage

データの取得中に生成されたメッセージ。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "query": {
    object (DataQuery)
  },
  "generatedSql": string,
  "result": {
    object (DataResult)
  },
  "generatedLookerQuery": {
    object (LookerQuery)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  },
  "matchedQuery": {
    object (MatchedQuery)
  }
  // End of mutually exclusive fields.
}
フィールド
このメッセージに、データ取得用のクエリ、結果、または生成された SQL のいずれが含まれているか。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
query

object (DataQuery)

データ取得クエリ。

generatedSql

string

データを取得するためにシステムによって生成される SQL。

result

object (DataResult)

取得したデータ。

generatedLookerQuery
(deprecated)

object (LookerQuery)

非推奨: 生成された Looker クエリが DataQuery.looker にある。データを取得するためにシステムによって生成される Looker クエリ。

bigQueryJob

object (BigQueryJob)

データを取得するためにシステムによって実行される BigQuery ジョブ。

matchedQuery

object (MatchedQuery)

データを取得するために一致した既存のクエリ。

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

DataQuery

データを取得するためのクエリ。

JSON 表現
{
  "question": string,
  "name": string,
  "datasources": [
    {
      object (Datasource)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "looker": {
    object (LookerQuery)
  }
  // End of mutually exclusive fields.
}
フィールド
question

string

省略可。回答する自然言語の質問。

name

string

省略可。クエリの意図を反映したスネークケースの名前。対応するデータ結果に名前を付け、後の手順で参照できるようにするために使用されます。

  • 例: 「total_sales_by_product」
  • 例: 「sales_for_product_12345」
datasources[]

object (Datasource)

省略可。質問に回答するために使用できるデータソース。

実行するクエリのタイプ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
looker

object (LookerQuery)

省略可。Looker Explore からデータを取得するクエリ。

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

DataResult

取得したデータ。

JSON 表現
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ],
  "formattedData": [
    {
      object
    }
  ]
}
フィールド
name

string

省略可。内容を反映したデータ結果のスネークケース名。この名前は、参照によって結果を渡すために使用され、その意味を示すシグナルとして機能します。

  • 例: 「total_sales_by_product」
  • 例: 「sales_for_product_12345」
schema

object (Schema)

省略可。データのスキーマ。

data[]

object (Struct format)

省略可。データの内容。各行は、スキーマと一致する構造体です。単純な値は文字列として表され、ネストされた構造はリストまたは構造体として表されます。

formattedData[]

object (Struct format)

省略可。該当する場合、データの書式設定された表現。各行は、data フィールド内の同じインデックスの行に直接対応する構造体です。その値は、データソースの仕様に従ってフォーマットされた元のデータの文字列形式です(例: 通貨の場合は「$1,234.56」)。書式設定のない列は、デフォルトで未加工の値表現になります。書式設定ルールが適用されている列がない場合、このフィールドは空白になります。

BigQueryJob

システムによって実行される BigQuery ジョブ。

JSON 表現
{
  "projectId": string,
  "jobId": string,
  "location": string,
  "destinationTable": {
    object (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
フィールド
projectId

string

必須。ジョブが属するプロジェクト。

JobReference をご覧ください。

jobId

string

必須。ジョブの ID。

JobReference をご覧ください。

location

string

省略可。ジョブのロケーション。

JobReference をご覧ください。

destinationTable

object (BigQueryTableReference)

省略可。ジョブのクエリ結果の宛先テーブルへの参照。

JobConfigurationQuery をご覧ください。

schema

object (Schema)

省略可。ジョブのクエリ結果のスキーマ。

JobStatistics2 を参照してください。

MatchedQuery

一致した Query メッセージは、エージェントがコンテキストで提供されたクエリの例の 1 つを現在の質問に適用可能であると判断したことを表します。また、照合プロセス中に追加情報も含まれます。

JSON 表現
{
  "exampleQuery": {
    object (ExampleQuery)
  },
  "queryParameterValues": [
    {
      object (QueryParameterValues)
    }
  ]
}
フィールド
exampleQuery

object (ExampleQuery)

クエリ例に基づいて一致したクエリ。

queryParameterValues[]

object (QueryParameterValues)

クエリ パラメータの抽出された値。

QueryParameterValues

クエリ パラメータ値メッセージは、LLM がサンプルクエリに基づいてユーザーの質問から抽出したクエリ パラメータの値を表します。

JSON 表現
{
  "name": string,
  "value": string
}
フィールド
name

string

必須。パラメータの名前。

value

string

必須。パラメータの値。

AnalysisMessage

分析中に生成されたメッセージ。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "query": {
    object (AnalysisQuery)
  },
  "progressEvent": {
    object (AnalysisEvent)
  }
  // End of mutually exclusive fields.
}
フィールド
このメッセージにクエリまたは分析のイベントのいずれかが含まれているかどうか。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
query

object (AnalysisQuery)

分析クエリ。

progressEvent

object (AnalysisEvent)

分析の進行状況を示すイベント。

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

AnalysisQuery

分析を実行するためのクエリ。

JSON 表現
{
  "question": string,
  "dataResultNames": [
    string
  ]
}
フィールド
question

string

省略可。ユーザーの元の質問に答えるための分析質問。

dataResultNames[]

string

省略可。分析する以前に取得したデータ結果の名前。

AnalysisEvent

分析の進行状況を示すイベント。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "plannerReasoning": string,
  "coderInstruction": string,
  "code": string,
  "executionOutput": string,
  "executionError": string,
  "resultVegaChartJson": string,
  "resultNaturalLanguage": string,
  "resultCsvData": string,
  "resultReferenceData": string,
  "error": string
  // End of mutually exclusive fields.
}
フィールド
分析中に発生したイベントの種類。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
plannerReasoning

string

Python codegen プランナーの推論。

coderInstruction

string

コード生成用に発行される指示。

code

string

生成されるコード。

executionOutput

string

コード実行の出力。

executionError

string

コード実行によるエラー。

resultVegaChartJson

string

結果は Vega グラフの JSON 文字列です。

resultNaturalLanguage

string

結果を NL 文字列として返します。

resultCsvData

string

結果を CSV 文字列として返します。

resultReferenceData

string

データソースへの参照としての結果。

error

string

一般的なエラー メッセージ。

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

ChartMessage

グラフの生成中に生成されたメッセージ。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "query": {
    object (ChartQuery)
  },
  "result": {
    object (ChartResult)
  }
  // End of mutually exclusive fields.
}
フィールド
このメッセージにクエリまたはグラフ生成の結果が含まれているかどうか。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
query

object (ChartQuery)

グラフを生成するためのクエリ。

result

object (ChartResult)

グラフ生成クエリの結果。

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

ChartQuery

グラフを生成するためのクエリ。

JSON 表現
{
  "instructions": string,
  "dataResultName": string
}
フィールド
instructions

string

省略可。グラフを生成するための自然言語による指示。

dataResultName

string

省略可。グラフで使用する、以前に取得したデータ結果の名前。

ChartResult

グラフ生成クエリの結果。

JSON 表現
{
  "vegaConfig": {
    object
  },
  "image": {
    object (Blob)
  }
}
フィールド
vegaConfig

object (Struct format)

省略可。生成された Vega グラフ構成。https://vega.github.io/vega/docs/config/ をご覧ください。

image

object (Blob)

省略可。コンテキストでリクエストされた場合は、グラフのレンダリング。

Blob

MIME タイプのデータの blob。

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

string

必須。メッセージ データの IANA 標準 MIME タイプ。

data

string (bytes format)

必須。バイト単位で表されるデータ。

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

ErrorMessage

ツール呼び出しからのエラー メッセージ。このメッセージは、エージェントがツールを使用しようとしたときに発生したエラーを表すために使用されます。すべてのエラーが致命的であるわけではありません。多くの場合、このエラーは回復可能であり、エージェントはこのエラー メッセージの情報を使用して自己修正し、ツール呼び出しを再試行するか、別のアプローチを試すことができます。

たとえば、データクエリが失敗した場合、エージェントは ErrorMessage を受け取って分析し、修正されたクエリを生成することがあります。

クライアントは、このメッセージを明確な失敗と解釈することに慎重になる必要があります。これは、エージェントがタスクを完了する通常の反復プロセスの一環にすぎない可能性があるためです。これらのエラーをコンテキストなしでエンドユーザーに直接表示すると(「ハード障害」など)、誤解を招く可能性があります。

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

string

出力専用。エラーのテキスト。

クエリの例

派生したクエリと作成されたクエリの例を含むメッセージ。

JSON 表現
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
フィールド
exampleQueries[]

object (ExampleQuery)

省略可。派生したクエリと作成されたクエリの例のリスト。関連性の高い一般的な SQL クエリの例と、場合によってはそれに対応する自然言語クエリが示されます。現在、BigQuery データソースでのみ使用されます。

ClarificationMessage

非推奨: 代わりに TextType.FINAL_RESPONSE を指定した TextMessage を使用してください。ユーザーのクエリを明確にするための質問のメッセージ。これは、システムがユーザーの質問に自信を持って回答できない場合に返されます。

JSON 表現
{
  "questions": [
    {
      object (ClarificationQuestion)
    }
  ]
}
フィールド
questions[]
(deprecated)

object (ClarificationQuestion)

必須。非推奨: 親メッセージは非推奨です。ユーザーに尋ねる一連の確認質問。

ClarificationQuestion

非推奨: 代わりに TextType.FINAL_RESPONSE を指定した TextMessage を使用してください。ユーザーのクエリを明確にするための、ユーザーへの 1 つの質問を表します。

JSON 表現
{
  "question": string,
  "selectionMode": enum (SelectionMode),
  "options": [
    string
  ],
  "clarificationQuestionType": enum (ClarificationQuestionType)
}
フィールド
question
(deprecated)

string

必須。非推奨: 親メッセージは非推奨です。ユーザーに尋ねる自然言語の質問。

selectionMode
(deprecated)

enum (SelectionMode)

必須。非推奨: 親メッセージは非推奨です。この質問の選択モード。

options[]
(deprecated)

string

必須。非推奨: 親メッセージは非推奨です。ユーザーが選択できる個別のオプションのリスト。オプションの数は最大 5 個に制限されています。

clarificationQuestionType
(deprecated)

enum (ClarificationQuestionType)

省略可。非推奨: 親メッセージは非推奨です。明確化のための質問のタイプ。

SelectionMode

非推奨: 親メッセージは非推奨です。明確化のための質問の選択モード。

列挙型
SELECTION_MODE_UNSPECIFIED

非推奨: 親メッセージは非推奨です。選択モードが指定されていません。

SINGLE_SELECT

非推奨: 親メッセージは非推奨です。ユーザーはオプションを 1 つだけ選択できます。

MULTI_SELECT

非推奨: 親メッセージは非推奨です。ユーザーは複数のオプションを選択できます。

ClarificationQuestionType

非推奨: 親メッセージは非推奨です。明確化のための質問の種類。この列挙型は、今後新しい値で拡張される可能性があります。

列挙型
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED

非推奨: 親メッセージは非推奨です。明確化のための質問のタイプが指定されていません。

FILTER_VALUES

非推奨: 親メッセージは非推奨です。明確化のための質問は、フィルタ値に関するものです。

FIELDS

非推奨: 親メッセージは非推奨です。明確化のための質問は、データ フィールドに関するものです。これは、SQL 列、Looker フィールド(ディメンション / メジャー)、ネストされたデータ構造プロパティを含む一般的な用語です。

引用

コンテンツのソース アトリビューション。

JSON 表現
{
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "anchors": [
    {
      object (CitationAnchor)
    }
  ]
}
フィールド
sources[]

object (CitationSource)

出力専用。引用されているソースのリスト。

anchors[]

object (CitationAnchor)

出力専用。引用のアンカーのリスト。

CitationSource

引用元。

JSON 表現
{
  "id": string,
  "title": string,

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

string

出力専用。ソースの固有識別子。この ID はサービスによって生成され、1 つの Citation メッセージのスコープ内で一意です。

title

string

出力専用。ソースのタイトル。

引用のソース。サポートされているタイプのいずれかになります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
uri

string

出力専用。ソースとして使用される URI(ウェブ グラウンディング URL など)。

exampleQuery

object (ExampleQuery)

出力専用。ソースとして使用されるクエリの例。

glossaryTerm

object (GlossaryTerm)

出力専用。ソースとして使用される用語集の用語。

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

CitationAnchor

引用のアンカー。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textMessageAnchor": {
    object (TextMessageCitationAnchor)
  }
  // End of mutually exclusive fields.
}
フィールド
引用のアンカー。サポートされているタイプのいずれかになります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
textMessageAnchor

object (TextMessageCitationAnchor)

出力専用。引用が TextMessage の場合にのみ設定されます。

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

TextMessageCitationAnchor

TextMessage 内の引用アンカー。

JSON 表現
{
  "partIndex": integer,
  "startOffsetBytes": integer,
  "endOffsetBytes": integer,
  "sourceIds": [
    string
  ]
}
フィールド
partIndex

integer

出力専用。TextMessage.parts フィールド内のパートの 0 ベースのインデックス。

startOffsetBytes

integer

出力専用。引用が開始される部分文字列内のオフセット(UTF-8 バイト単位、両端を含む)。例: 「Hello, world」というテキストで「world」が引用されている場合、開始オフセット バイト(両端を含む)は 7、終了オフセット バイト(両端を含まない)は 12 です。

endOffsetBytes

integer

出力専用。引用が終了する部分文字列内のオフセット(UTF-8 バイト単位、終了箇所は含まない)。例: 「Hello, world」というテキストで「world」が引用されている場合、開始オフセット バイト(両端を含む)は 7、終了オフセット バイト(両端を含まない)は 12 です。

sourceIds[]

string

出力専用。引用されたソースの ID。