Method: projects.locations.retrieveBigQueryTableContext

Récupère les données contextuelles des tables BigQuery pour les références de table fournies. Les données contextuelles incluent des informations sur le schéma de la table ainsi que des exemples de valeurs.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Valeur parente pour RetrieveBigQueryTableContextRequest. 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 
{
  "project": string,
  "query": string,
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Champs
project
(deprecated)

string

Obligatoire.
query

string

Facultatif. Requête utilisateur en langage naturel.
directLookup[]

object (DirectLookup)

Facultatif. Liste des paramètres de recherche directe.

Corps de la réponse

Réponse permettant de récupérer les données contextuelles d'une table BigQuery via une recherche directe.

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

Représentation JSON 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "tableCandidates": [
    {
      object (TableCandidate)
    }
  ]
}
Champs
candidates[]
(deprecated)

object (Candidate)

Liste des candidats récupérés avec leurs métadonnées groupées.
tableCandidates[]

object (TableCandidate)

Liste des candidats récupérés avec leurs métadonnées groupées.

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.

Candidat

Candidat récupéré.

Représentation JSON 
{
  "linkedResource": string,
  "content": string
}
Champs
linkedResource

string

Nom complet de la ressource du candidat dans son système source, le cas échéant. Par exemple, pour les tables BigQuery, le format est bigquery.googleapis.com/projects/{projectId}/datasets/{datasetId}/tables/{tableId}.
content

string

Contenu au format de chaîne.