Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

擷取 BigQuery 資料表結構定義,並提供建議的 NL-SQL 範例。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

這是必要旗標,RetrieveBigQueryTableSuggestedExamplesRequest 的父項值。模式:projects/{project}/locations/{location}目前請使用「global」做為位置。日後將支援區域位置值。

要求主體

要求主體包含下列結構的資料:

JSON 表示法
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
欄位
directLookup[]

object (DirectLookup)

(選用步驟) 直接查詢參數清單。

回應主體

要求擷取 BigQuery 資料表結構定義,並提供建議的 NL-SQL 範例。

如果成功,回應主體會含有以下結構的資料:

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

建議範例的連結表格資源。