Method: projects.locations.retrieval.retrieveBigQueryTableSuggestedExamples

Mengambil skema tabel BigQuery dengan contoh NL-SQL yang disarankan.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nilai induk untuk RetrieveBigQueryTableSuggestedExamplesRequest. Pola: projects/{project}/locations/{location} Untuk lokasi, gunakan "global" untuk saat ini. Nilai lokasi regional akan didukung pada masa mendatang.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "directLookup": [
    {
      object (DirectLookup)
    }
  ]
}
Kolom
directLookup[]

object (DirectLookup)

Opsional. Daftar parameter penelusuran langsung.

Isi respons

Permintaan untuk mengambil skema tabel BigQuery dengan contoh NL-SQL yang disarankan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "exampleSuggestions": [
    {
      object (ExampleSuggestion)
    }
  ]
}
Kolom
exampleSuggestions[]

object (ExampleSuggestion)

Daftar contoh yang disarankan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

ExampleSuggestion

Contoh NL-SQL BigQuery yang disarankan untuk tabel tertentu.

Representasi JSON
{
  "nlQuery": string,
  "sql": string,
  "linkedBigqueryTables": [
    string
  ]
}
Kolom
nlQuery

string

Kueri bahasa alami.

sql

string

Jawaban SQL untuk kueri.

linkedBigqueryTables[]

string

Resource tabel tertaut untuk contoh yang disarankan.