Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

Recupera el esquema de la tabla de BigQuery con ejemplos de NL-SQL sugeridos.

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el valor superior de RetrieveBigQueryTableSuggestedExamplesRequest. 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 
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Campos
directLookup[]

object (DirectLookup)

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

Cuerpo de la respuesta

Es una solicitud para recuperar el esquema de la tabla de BigQuery con ejemplos de NL-SQL sugeridos.

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

Representación JSON 
{
  "exampleSuggestions": [
    {
      object (ExampleSuggestion)
    }
  ]
}
Campos
exampleSuggestions[]

object (ExampleSuggestion)

Es la lista de ejemplos sugeridos.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

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

ExampleSuggestion

Es un ejemplo sugerido de NL-SQL de BigQuery para la tabla determinada.

Representación JSON 
{
  "nlQuery": string,
  "sql": string,
  "linkedBigqueryTables": [
    string
  ]
}
Campos
nlQuery

string

Es la consulta en lenguaje natural.
sql

string

Es la respuesta en SQL a la búsqueda.
linkedBigqueryTables[]

string

Son los recursos de la tabla vinculada para el ejemplo sugerido.