Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

Récupère le schéma de la table BigQuery avec des exemples suggérés de conversions langage naturel-SQL.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Valeur parente pour RetrieveBigQueryTableSuggestedExamplesRequest. Format : projects/{project}/locations/{location} Pour l'emplacement ("location"), utilisez "global" pour le moment. Une valeur régionale pour "location" sera acceptée à l'avenir.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Champs
directLookup[]

object (DirectLookup)

Facultatif. Liste des paramètres de recherche directe.

Corps de la réponse

Demande de récupération du schéma de la table BigQuery avec des exemples suggérés de conversions langage naturel-SQL.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "exampleSuggestions": [
    {
      object (ExampleSuggestion)
    }
  ]
}
Champs
exampleSuggestions[]

object (ExampleSuggestion)

Liste d'exemples suggérés.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la Authentication Overview.

ExampleSuggestion

Exemple BigQuery suggéré de conversion langage naturel-SQL pour la table donnée.

Représentation JSON 
{
  "nlQuery": string,
  "sql": string,
  "linkedBigqueryTables": [
    string
  ]
}
Champs
nlQuery

string

Requête en langage naturel.
sql

string

Réponse SQL à la requête.
linkedBigqueryTables[]

string

Ressources de la table associée pour l'exemple suggéré.