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

建议示例的关联表格资源。