- Permintaan HTTP
- Parameter jalur
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- ConversationReference
- DataAgentContext
- ContextVersion
- ClientManagedResourceContext
- LookerSettings
- Kredensial
- OAuthCredentials
- SecretBased
- TokenBased
- ThinkingMode
- Model
Menjawab pertanyaan data dengan membuat aliran objek Message.
Permintaan HTTP
POST https://geminidataanalytics.googleapis.com/v1/{parent=projects/*/locations/*}:chat
URL menggunakan sintaks gRPC Transcoding.
Parameter jalur
| Parameter | |
|---|---|
parent |
Wajib. Nilai induk untuk permintaan chat. Pola: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
| Representasi JSON |
|---|
{ "messages": [ { object ( |
| Kolom | |
|---|---|
messages[] |
Wajib. Konten percakapan saat ini. |
credentials |
Opsional. Kredensial yang akan digunakan saat memanggil sumber data yang ditentukan dalam konteks. Kolom ini dapat digunakan untuk memberikan kredensial untuk berbagai sumber data. Misalnya, saat terhubung ke Looker, saat ini Looker mendukung kredensial berbasis token OAuth dan kunci API, seperti yang dijelaskan dalam Autentikasi dengan SDK. |
thinkingMode |
Opsional. Mode penalaran yang akan digunakan untuk agent loop. Defaultnya adalah THINKING_MODE_UNSPECIFIED jika tidak ditentukan. |
model |
Opsional. Model yang akan digunakan untuk agent loop saat memproses permintaan. Setelan ini hanya berpengaruh jika context.options.model tidak ditetapkan. |
| Penyedia Konteks untuk permintaan chat. Nilainya bisa berupa - inline_context, yaitu konteks yang disediakan secara inline dalam permintaan. data_agent, yaitu referensi ke resource agen data. conversation_reference, yaitu referensi ke percakapan dan konteks yang dipertahankan menggunakan conversation_id dan agent_id. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
inlineContext |
Opsional. Konteks inline untuk permintaan chat. Gunakan ini untuk melakukan chat tanpa status (tanpa persistensi percakapan terkelola dan tanpa Agen) dengan meneruskan semua konteks secara inline. |
conversationReference |
Opsional. Referensi ke percakapan yang dipertahankan dan konteks agen. Gunakan ini untuk melakukan chat dengan Agen menggunakan persistensi percakapan terkelola. |
dataAgentContext |
Opsional. Konteks untuk permintaan chat. Gunakan ini untuk melakukan chat dengan Agen secara stateless, tanpa persistensi percakapan terkelola. |
clientManagedResourceContext |
Opsional. Konteks dengan resource yang dikelola klien. Beberapa klien mungkin tidak menggunakan resource yang dikelola GDA, termasuk percakapan dan agen. Sebagai gantinya, mereka membuat dan mengelola resource percakapan dan agen mereka sendiri. |
| Akhir kolom yang saling eksklusif. | |
| Setelan opsional untuk menyesuaikan perilaku permintaan, khusus untuk sumber data target. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons: | |
lookerSettings |
Opsional. Setelan khusus Looker. |
| Akhir kolom yang saling eksklusif. | |
Isi respons
Jika berhasil, isi respons akan berisi aliran instance Message.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/geminidataanalytics
Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.
ConversationReference
Referensi ke percakapan yang dipertahankan dan konteks agen.
| Representasi JSON |
|---|
{
"conversation": string,
"dataAgentContext": {
object ( |
| Kolom | |
|---|---|
conversation |
Wajib. Nama resource percakapan. Format: |
dataAgentContext |
Wajib. Konteks untuk permintaan chat menggunakan agen data. |
DataAgentContext
Konteks untuk permintaan chat menggunakan agen data.
| Representasi JSON |
|---|
{
"dataAgent": string,
"contextVersion": enum ( |
| Kolom | |
|---|---|
dataAgent |
Wajib. Nama resource agen data. |
contextVersion |
Opsional. Versi konteks yang akan digunakan oleh DCS (misalnya, STAGING, PUBLISHED) |
ContextVersion
Daftar versi konteks yang didukung oleh DCS. Ada dua versi konteks. Hal ini dilakukan untuk mempertahankan pembuatan versi bagi agen data.
| Enum | |
|---|---|
CONTEXT_VERSION_UNSPECIFIED |
Tidak ditentukan atau tidak dikenali. |
STAGING |
Dengan menggunakan versi ini, DCS akan menggunakan konteks penyiapan terbaru untuk agen data. |
PUBLISHED |
Dengan versi ini, DCS akan menggunakan konteks terbaru yang dipublikasikan untuk agen data. |
ClientManagedResourceContext
Konteks dengan resource yang dikelola klien. Beberapa klien mungkin tidak menggunakan resource yang dikelola GDA, termasuk percakapan dan agen. Sebagai gantinya, mereka membuat dan mengelola resource percakapan dan agen mereka sendiri.
| Representasi JSON |
|---|
{
"inlineContext": {
object ( |
| Kolom | |
|---|---|
inlineContext |
Wajib. Konteks untuk permintaan chat. Gunakan ini untuk melakukan chat tanpa percakapan yang dikelola GDA API dan persistensi agen dengan meneruskan semua konteks secara inline. |
conversationId |
Opsional. ID percakapan yang dikelola klien. |
agentId |
Opsional. ID agen yang dikelola klien. |
LookerSettings
Pesan untuk menyimpan setelan kustom khusus Looker.
| Representasi JSON |
|---|
{ "enableDevMode": boolean } |
| Kolom | |
|---|---|
enableDevMode |
Opsional. Apakah akan beroperasi dalam Mode Pengembangan Looker. Jika benar, sesi API akan dialihkan ke ruang kerja "dev", sehingga memungkinkan interaksi dengan perubahan LookML di cabang pengembangan pengguna. Jika salah atau tidak disetel, sesi akan tetap dalam status default (Mode Produksi). Lihat https://cloud.google.com/looker/docs/dev-mode-prod-mode. |
Kredensial
Mewakili berbagai bentuk spesifikasi kredensial.
| Representasi JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"oauth": {
object ( |
| Kolom | |
|---|---|
| Jenis kredensial. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons: | |
oauth |
Kredensial OAuth. |
| Akhir kolom yang saling eksklusif. | |
OAuthCredentials
Merepresentasikan kredensial OAuth.
| Representasi JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "secret": { object ( |
| Kolom | |
|---|---|
| Jenis kredensial OAuth. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
secret |
Kredensial OAuth berbasis rahasia. |
token |
Kredensial OAuth berbasis token. |
| Akhir kolom yang saling eksklusif. | |
SecretBased
Nama secret yang berisi token akses. Mewakili kredensial OAuth berbasis secret.
| Representasi JSON |
|---|
{ "clientId": string, "clientSecret": string } |
| Kolom | |
|---|---|
clientId |
Wajib. Client ID OAuth. |
clientSecret |
Wajib. Rahasia klien OAuth. |
TokenBased
Baca selengkapnya tentang token akses Looker di sini: https://developers.looker.com/api/advanced-usage/looker-api-oauth
| Representasi JSON |
|---|
{ "accessToken": string } |
| Kolom | |
|---|---|
accessToken |
Wajib. Nama secret yang berisi token akses. |
ThinkingMode
Mode berpikir untuk agen.
| Enum | |
|---|---|
THINKING_MODE_UNSPECIFIED |
Nilai default. Untuk sumber data BigQuery dan Looker, agen menggunakan FAST. Untuk semua sumber data lainnya, agen menggunakan THINKING. |
FAST |
Mode cepat, jawaban cepat. |
THINKING |
Mode berpikir, memecahkan masalah yang kompleks. |
Model
Pemilihan model untuk agen bagi pengguna BigQuery.
| Enum | |
|---|---|
MODEL_UNSPECIFIED |
Tidak ada model yang ditentukan. Model pratinjau atau non-pratinjau dapat digunakan. |
LATEST_GA_MODEL |
Gunakan model non-pratinjau terbaru. Hal ini dapat membatasi setelan tingkat permintaan tertentu. |