Method: projects.locations.retrieveBigQueryTableContext

Recupera los datos contextuales de la tabla de BigQuery para las referencias de tabla proporcionadas. Los datos contextuales incluyen información del esquema de la tabla y valores de ejemplo.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el valor principal de RetrieveBigQueryTableContextRequest. Patrón: projects/{project}/locations/{location} Por ahora, usa "global" para la ubicación. El valor de ubicación regional se admitirá en el futuro.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "project": string,
  "query": string,
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Campos
project
(deprecated)

string

Obligatorio.
query

string

Opcional. Consulta del usuario en lenguaje natural.
directLookup[]

object (DirectLookup)

Opcional. Es una lista de parámetros de búsqueda directa.

Cuerpo de la respuesta

Es la respuesta para recuperar datos contextuales de la tabla de BigQuery a través de una búsqueda directa.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "tableCandidates": [
    {
      object (TableCandidate)
    }
  ]
}
Campos
candidates[]
(deprecated)

object (Candidate)

Es la lista de candidatos recuperados con sus metadatos incluidos.
tableCandidates[]

object (TableCandidate)

Es la lista de candidatos recuperados con sus metadatos incluidos.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Candidato

Es un candidato recuperado.

Representación JSON 
{
  "linkedResource": string,
  "content": string
}
Campos
linkedResource

string

Es el nombre del recurso completamente calificado del candidato en su sistema de origen, si corresponde. Por ejemplo, para las tablas de BigQuery, el formato es bigquery.googleapis.com/projects/{projectId}/datasets/{datasetId}/tables/{tableId}.
content

string

Es el contenido en formato de cadena.