Method: projects.locations.retrieval.retrieveBigQueryTableContexts

指定されたテーブル参照の BigQuery テーブルのコンテキスト データを取得します。コンテキスト データには、テーブル スキーマ情報とサンプル値が含まれます。

HTTP リクエスト

POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}/retrieval:retrieveBigQueryTableContexts

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

パスパラメータ

パラメータ
parent

string

必須。RetrieveBigQueryTableContextRequest の親の値。パターン: projects/{project}/locations/{location}。ロケーションには、現時点では「global」を使用してください。リージョン ロケーションの値は今後サポートされる予定です。

リクエストの本文

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

JSON 表現 
{
  "query": string,
  "directLookups": [
    {
      object (DirectLookup)
    }
  ]
}
フィールド
query

string

省略可。自然言語でのユーザークエリ。
directLookups[]

object (DirectLookup)

省略可。直接ルックアップ パラメータのリスト。

レスポンスの本文

直接ルックアップで BigQuery テーブルのコンテキスト データを取得するためのレスポンス。

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

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

object (TableCandidate)

取得した候補のリストと、バンドルされたメタデータ。

認可スコープ

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

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

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