Method: projects.locations.retrieveBigQueryTableContext

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

リクエストの本文

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

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

string

必須。
query

string

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

object (DirectLookup)

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

レスポンスの本文

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

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

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

object (Candidate)

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

object (TableCandidate)

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

認可スコープ

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

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

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

候補

取得された候補。

JSON 表現 
{
  "linkedResource": string,
  "content": string
}
フィールド
linkedResource

string

ソースシステム内の候補の完全修飾リソース名（該当する場合）。たとえば、BigQuery テーブルの場合、形式は bigquery.googleapis.com/projects/{projectId}/datasets/{datasetId}/tables/{tableId}
content

string

文字列形式のコンテンツ。