Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

推奨される NL-SQL の例を含む BigQuery テーブル スキーマを取得します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

リクエストの本文

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

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

object (DirectLookup)

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

レスポンスの本文

推奨される NL-SQL の例を含む BigQuery テーブル スキーマを取得するリクエスト。

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

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

object (ExampleSuggestion)

推奨される例のリスト。

認可スコープ

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

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

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

ExampleSuggestion

指定されたテーブルの BigQuery NL-SQL の推奨される例。

JSON 表現 
{
  "nlQuery": string,
  "sql": string,
  "linkedBigqueryTables": [
    string
  ]
}
フィールド
nlQuery

string

自然言語クエリ。
sql

string

クエリに対する SQL の回答。
linkedBigqueryTables[]

string

推奨される例のリンクされたテーブル リソース。