Method: projects.locations.retrieveBigQueryTableContext

Ruft Kontextdaten für BigQuery-Tabelle für die angegebenen Tabellenreferenzen ab. Kontextbezogene Daten umfassen Tabellenschemainformationen sowie Beispielwerte.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Übergeordneter Wert für RetrieveBigQueryTableContextRequest. Muster: projects/{project}/locations/{location} Verwenden Sie für den Standort vorerst „global“. Der Wert für den regionalen Standort wird in Zukunft unterstützt.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "project": string,
  "query": string,
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Felder
project
(deprecated)

string

Erforderlich.
query

string

Optional. Nutzerabfrage in natürlicher Sprache.
directLookup[]

object (DirectLookup)

Optional. Eine Liste der Parameter für die direkte Suche.

Antworttext

Antwort zum Abrufen von Kontextdaten für BigQuery-Tabelle über die direkte Suche.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "tableCandidates": [
    {
      object (TableCandidate)
    }
  ]
}
Felder
candidates[]
(deprecated)

object (Candidate)

Liste der abgerufenen Kandidaten mit den zugehörigen Metadaten.
tableCandidates[]

object (TableCandidate)

Liste der abgerufenen Kandidaten mit den zugehörigen Metadaten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.

Kandidat

Ein abgerufener Kandidat.

JSON-Darstellung 
{
  "linkedResource": string,
  "content": string
}
Felder
linkedResource

string

Der vollständig qualifizierte Ressourcenname des Kandidaten im zugehörigen Quellsystem, falls zutreffend. Für BigQuery-Tabellen lautet das Format beispielsweise: bigquery.googleapis.com/projects/{projectId}/datasets/{datasetId}/tables/{tableId}
content

string

Inhalte im Stringformat.