Method: projects.locations.queryData

Membuat kueri data dari kueri pengguna dalam bahasa alami.

Permintaan HTTP


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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Resource induk untuk membuat kueri. Format: projects/{project}/locations/{location}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "prompt": string,
  "context": {
    object (QueryDataContext)
  },
  "generationOptions": {
    object (GenerationOptions)
  }
}
Kolom
prompt

string

Wajib. Kueri bahasa alami yang akan dibuat kuerinya. Contoh: "Apa saja 5 produk terlaris bulan ini?"
context

object (QueryDataContext)

Wajib. Konteks untuk kueri data, termasuk sumber data yang akan digunakan.
generationOptions

object (GenerationOptions)

Opsional. Opsi untuk mengontrol perilaku pembuatan dan eksekusi kueri.

Isi respons

Respons yang berisi kueri yang dibuat dan informasi terkait.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "generatedQuery": string,
  "intentExplanation": string,
  "queryResult": {
    object (ExecutedQueryResult)
  },
  "naturalLanguageAnswer": string,
  "disambiguationQuestion": [
    string
  ]
}
Kolom
generatedQuery

string

Kueri yang dihasilkan untuk perintah pengguna tertentu.
intentExplanation

string

Penjelasan bahasa alami dari kueri yang dihasilkan. Diisi jika options.generate_explanation bernilai benar dalam permintaan.
queryResult

object (ExecutedQueryResult)

Hasil menjalankan kueri. Diisi jika options.generate_query_result atau options.generate_natural_language_answer bernilai benar dalam permintaan, dan eksekusi berhasil atau dicoba.
naturalLanguageAnswer

string

Jawaban bahasa alami untuk kueri, berdasarkan queryResult. Diisi jika options.generate_natural_language_answer bernilai benar dalam permintaan dan eksekusi kueri berhasil berdasarkan respons dari executeSql API.
disambiguationQuestion[]

string

Jika ambiguitas terdeteksi dalam kueri dan opsi natural language.generate_disambiguation_question bernilai benar, kolom ini berisi pertanyaan kepada pengguna untuk mendapatkan klarifikasi. Respons yang ditampilkan mewakili upaya terbaik layanan berdasarkan input yang ambigu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

QueryDataContext

Referensi ke sumber data dan konteks yang akan digunakan untuk kueri.

Representasi JSON 
{
  "datasourceReferences": {
    object (DatasourceReferences)
  }
}
Kolom
datasourceReferences

object (DatasourceReferences)

Wajib. Referensi sumber data yang akan digunakan untuk kueri.

GenerationOptions

Opsi untuk mengontrol pembuatan kueri, eksekusi, dan format respons.

Representasi JSON 
{
  "generateQueryResult": boolean,
  "generateNaturalLanguageAnswer": boolean,
  "generateExplanation": boolean,
  "generateDisambiguationQuestion": boolean
}
Kolom
generateQueryResult

boolean

Opsional. Jika benar (true), kueri yang dibuat akan dieksekusi, dan data hasil akan ditampilkan dalam respons.
generateNaturalLanguageAnswer

boolean

Opsional. Jika benar, jawaban dalam bahasa alami berdasarkan hasil eksekusi kueri akan dibuat dan ditampilkan dalam respons.
generateExplanation

boolean

Opsional. Jika benar (true), penjelasan kueri yang dibuat akan ditampilkan dalam respons.
generateDisambiguationQuestion

boolean

Opsional. Jika benar (default salah), layanan dapat menampilkan clarifying_question jika kueri input ambigu.

ExecutedQueryResult

Hasil eksekusi kueri. Desainnya bersifat umum untuk semua dialek.

Representasi JSON 
{
  "columns": [
    {
      object (Column)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totalRowCount": string,
  "partialResult": boolean,
  "queryExecutionError": string
}
Kolom
columns[]

object (Column)

Kolom dalam kumpulan hasil, secara berurutan.
rows[]

object (Row)

Baris yang ditampilkan oleh kueri.
totalRowCount

string (int64 format)

Jumlah total baris dalam kumpulan hasil lengkap, jika diketahui. Jumlah ini dapat berupa estimasi atau jumlah pasti.
partialResult

boolean

Setel ke benar (true) jika baris yang ditampilkan di queryResult adalah subset dari hasil lengkap. Hal ini dapat terjadi, misalnya, jika eksekusi kueri mencapai batas baris. Jika benar, queryResult tidak berisi semua baris. Untuk mengambil hasil lengkap, pertimbangkan untuk menggunakan generatedQuery di QueryDataResponse dan mengeksekusinya di lingkungan Anda sendiri.
queryExecutionError

string

Pesan error jika eksekusi kueri gagal.

Kolom

Menjelaskan satu kolom dalam kumpulan hasil.

Representasi JSON 
{
  "name": string,
  "type": string
}
Kolom
name

string

Nama kolom.
type

string

Jenis kolom (misalnya, "VARCHAR", "INT64", "TIMESTAMP").

Baris

Mewakili satu baris dalam kumpulan hasil.

Representasi JSON 
{
  "values": [
    {
      object (Value)
    }
  ]
}
Kolom
values[]

object (Value)

Nilai dalam baris, yang sesuai secara posisional dengan kolom.

Nilai

Mewakili satu nilai dalam baris.

Representasi JSON 
{
  "value": string
}
Kolom
value

string

Nilai sel, ditampilkan dalam format string. Stempel waktu dapat diformat, misalnya, menggunakan RFC3339Nano. Kolom ini digunakan jika nilainya bukan null.