Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

Recupera o esquema da tabela do BigQuery com exemplos sugeridos de NL-SQL.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Valor principal de RetrieveBigQueryTableSuggestedExamplesRequest. Padrão: projects/{project}/locations/{location}. Por enquanto, use "global" para o local. O valor de local regional será aceito no futuro.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Campos
directLookup[]

object (DirectLookup)

Opcional. Uma lista de parâmetros de pesquisa direta.

Corpo da resposta

Solicitação para recuperar o esquema da tabela do BigQuery com exemplos sugeridos de NL-SQL.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "exampleSuggestions": [
    {
      object (ExampleSuggestion)
    }
  ]
}
Campos
exampleSuggestions[]

object (ExampleSuggestion)

Lista de exemplos sugeridos.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

ExampleSuggestion

Um exemplo sugerido de NL-SQL do BigQuery para a tabela especificada.

Representação JSON 
{
  "nlQuery": string,
  "sql": string,
  "linkedBigqueryTables": [
    string
  ]
}
Campos
nlQuery

string

A consulta em linguagem natural.
sql

string

A resposta SQL para a consulta.
linkedBigqueryTables[]

string

Os recursos de tabela vinculados para o exemplo sugerido.