Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

Retrieves BigQuery table schema with suggested NL-SQL examples.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent value for RetrieveBigQueryTableSuggestedExamplesRequest. Pattern: projects/{project}/locations/{location} For location, use "global" for now. Regional location value will be supported in the future.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Fields
directLookup[]

object (DirectLookup)

Optional. A list of direct lookup parameters.

Response body

Request for retrieving BigQuery table schema with suggested NL-SQL examples.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "exampleSuggestions": [
    {
      object (ExampleSuggestion)
    }
  ]
}
Fields
exampleSuggestions[]

object (ExampleSuggestion)

List of suggested examples.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ExampleSuggestion

A suggested BigQuery NL-SQL example for the given table.

JSON representation 
{
  "nlQuery": string,
  "sql": string,
  "linkedBigqueryTables": [
    string
  ]
}
Fields
nlQuery

string

The natural language query.
sql

string

The SQL answer to the query.
linkedBigqueryTables[]

string

The linked table resources for the suggested example.