Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

Ruft das BigQuery-Tabellenschema mit vorgeschlagenen NL-SQL-Beispielen ab.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Felder
directLookup[]

object (DirectLookup)

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

Antworttext

Anfrage zum Abrufen des BigQuery-Tabellenschemas mit vorgeschlagenen NL-SQL-Beispielen.

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "exampleSuggestions": [
    {
      object (ExampleSuggestion)
    }
  ]
}
Felder
exampleSuggestions[]

object (ExampleSuggestion)

Liste mit vorgeschlagenen Beispielen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.

ExampleSuggestion

Ein vorgeschlagenes BigQuery NL-SQL-Beispiel für die angegebene Tabelle.

JSON-Darstellung 
{
  "nlQuery": string,
  "sql": string,
  "linkedBigqueryTables": [
    string
  ]
}
Felder
nlQuery

string

Die Abfrage in natürlicher Sprache.
sql

string

Die SQL-Antwort auf die Abfrage.
linkedBigqueryTables[]

string

Die verknüpften Tabellenressourcen für das vorgeschlagene Beispiel.