Method: projects.locations.retrieveBigQueryTableContext

Recupera dados contextuais da tabela do BigQuery para as referências de tabela fornecidas. Os dados contextuais incluem informações do esquema da tabela e valores de exemplo.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Valor principal de RetrieveBigQueryTableContextRequest. 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 
{
  "project": string,
  "query": string,
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Campos
project
(deprecated)

string

Obrigatório.
query

string

Opcional. Consulta do usuário em linguagem natural.
directLookup[]

object (DirectLookup)

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

Corpo da resposta

Resposta para recuperar os dados contextuais da tabela do BigQuery por pesquisa direta.

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

Representação JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "tableCandidates": [
    {
      object (TableCandidate)
    }
  ]
}
Campos
candidates[]
(deprecated)

object (Candidate)

Lista de candidatos recuperados com os metadados agrupados.
tableCandidates[]

object (TableCandidate)

Lista de candidatos recuperados com os metadados agrupados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Candidato

Um candidato recuperado.

Representação JSON 
{
  "linkedResource": string,
  "content": string
}
Campos
linkedResource

string

O nome do recurso totalmente qualificado do candidato no sistema de origem, se aplicável. Por exemplo, para tabelas do BigQuery, o formato é: bigquery.googleapis.com/projects/{projectId}/datasets/{datasetId}/tables/{tableId}
content

string

Conteúdo em formato de string.