Message

Pesan dari interaksi antara pengguna dan sistem.

Representasi JSON 
{
  "timestamp": string,
  "messageId": string,

  // Union field kind can be only one of the following:
  "userMessage": {
    object (UserMessage)
  },
  "systemMessage": {
    object (SystemMessage)
  }
  // End of list of possible types for union field kind.
}
Kolom
timestamp

string (Timestamp format)

Hanya output. Untuk pesan pengguna, ini adalah waktu saat sistem menerima pesan. Untuk pesan sistem, ini adalah waktu saat sistem membuat pesan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
messageId

string

Opsional. ID unik pesan dalam percakapan untuk persistensi.
Kolom union kind. Jenis pesan. kind hanya ada berupa salah satu diantara berikut:
userMessage

object (UserMessage)

Pesan dari pengguna yang berinteraksi dengan sistem.
systemMessage

object (SystemMessage)

Pesan dari sistem sebagai respons terhadap pengguna.

UserMessage

Pesan dari pengguna yang berinteraksi dengan sistem.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "text": string
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis konten dalam pesan pengguna. kind hanya ada berupa salah satu diantara berikut:
text

string

Teks harus menggunakan kolom ini, bukan blob.

SystemMessage

Pesan dari sistem sebagai respons terhadap pengguna. Pesan ini juga dapat berupa pesan dari pengguna sebagai konteks historis untuk percakapan multi-giliran dengan sistem.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "text": {
    object (TextMessage)
  },
  "schema": {
    object (SchemaMessage)
  },
  "data": {
    object (DataMessage)
  },
  "analysis": {
    object (AnalysisMessage)
  },
  "chart": {
    object (ChartMessage)
  },
  "error": {
    object (ErrorMessage)
  },
  "exampleQueries": {
    object (ExampleQueries)
  },
  "clarification": {
    object (ClarificationMessage)
  }
  // End of list of possible types for union field kind.
  "groupId": integer
}
Kolom
Kolom union kind. Jenis konten dalam pesan sistem. kind hanya ada berupa salah satu diantara berikut:
text

object (TextMessage)

Respons bahasa alami langsung terhadap pesan pengguna.
schema

object (SchemaMessage)

Pesan yang dihasilkan selama penyelesaian skema.
data

object (DataMessage)

Pesan yang dihasilkan selama pengambilan data.
analysis

object (AnalysisMessage)

Pesan yang dihasilkan selama analisis.
chart

object (ChartMessage)

Pesan yang dihasilkan selama pembuatan diagram.
error

object (ErrorMessage)

Pesan error.
exampleQueries

object (ExampleQueries)

Opsional. Pesan yang berisi contoh kueri.
clarification
(deprecated)

object (ClarificationMessage)

Opsional. Tidak digunakan lagi: Gunakan TextMessage dengan TextType.FINAL_RESPONSE sebagai gantinya. Pesan yang berisi pertanyaan klarifikasi.
groupId

integer

Mengidentifikasi grup tempat peristiwa berada. Peristiwa serupa dianggap relevan secara logis satu sama lain dan harus ditampilkan bersama di UI.

TextMessage

Pesan teks multi-bagian.

Representasi JSON 
{
  "parts": [
    string
  ],
  "textType": enum (TextType),
  "thoughtSignature": string
}
Kolom
parts[]

string

Opsional. Bagian-bagian pesan.
textType

enum (TextType)

Opsional. Jenis pesan teks.
thoughtSignature

string (bytes format)

Opsional. Tanda tangan buram untuk pemikiran sehingga dapat digunakan kembali dalam permintaan berikutnya.

String berenkode base64.

TextType

Jenis pesan teks.

Enum
TEXT_TYPE_UNSPECIFIED Jenis teks default.
FINAL_RESPONSE Teks adalah respons akhir terhadap pertanyaan pengguna.
THOUGHT Teks adalah pemikiran dari model.
PROGRESS Teks adalah pesan informasi tentang progres agen, seperti alat yang dipanggil. Hal ini berbeda dengan proses pemikiran internal agen (THOUGHT) dan jawaban akhir kepada pengguna (FINAL_RESPONSE). Pesan ini memberikan insight tentang tindakan agen.

SchemaMessage

Pesan yang dihasilkan selama penyelesaian skema.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (SchemaQuery)
  },
  "result": {
    object (SchemaResult)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Apakah pesan ini berisi kueri atau hasil resolusi skema. kind hanya ada berupa salah satu diantara berikut:
query

object (SchemaQuery)

Kueri resolusi skema.
result

object (SchemaResult)

Hasil kueri resolusi skema.

SchemaQuery

Kueri untuk menyelesaikan skema yang relevan dengan pertanyaan yang diajukan.

Representasi JSON 
{
  "question": string
}
Kolom
question

string

Opsional. Pertanyaan yang akan dikirim ke sistem untuk penyelesaian skema.

SchemaResult

Hasil penyelesaian skema.

Representasi JSON 
{
  "datasources": [
    {
      object (Datasource)
    }
  ]
}
Kolom
datasources[]

object (Datasource)

Opsional. Sumber data yang digunakan untuk menyelesaikan kueri skema.

Sumber data

Sumber data yang dapat digunakan untuk menjawab pertanyaan.

Representasi JSON 
{
  "schema": {
    object (Schema)
  },
  "structSchema": {
    object
  },

  // Union field reference can be only one of the following:
  "bigqueryTableReference": {
    object (BigQueryTableReference)
  },
  "studioDatasourceId": string,
  "lookerExploreReference": {
    object (LookerExploreReference)
  },
  "alloyDbReference": {
    object (AlloyDbReference)
  },
  "spannerReference": {
    object (SpannerReference)
  },
  "cloudSqlReference": {
    object (CloudSqlReference)
  }
  // End of list of possible types for union field reference.
}
Kolom
schema

object (Schema)

Opsional. Skema sumber data.
structSchema

object (Struct format)

Opsional. Representasi struct dari skema. Kolom ini diisi untuk sumber data dengan skema yang tidak dapat sepenuhnya diwakili oleh kolom schema yang berjenis data kuat.

Untuk sumber data Looker, ini dipetakan ke jenis LookmlModelExplore: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore
Kolom union reference. Referensi ke sumber data. reference hanya ada berupa salah satu diantara berikut:
bigqueryTableReference

object (BigQueryTableReference)

Referensi ke tabel BigQuery.
studioDatasourceId

string

Referensi ke sumber data Looker Studio.
lookerExploreReference

object (LookerExploreReference)

Referensi ke penjelajahan Looker.
alloyDbReference

object (AlloyDbReference)

Referensi ke database AlloyDB.
spannerReference

object (SpannerReference)

Referensi ke database Spanner.
cloudSqlReference

object (CloudSqlReference)

Referensi ke database CloudSQL.

DataMessage

Pesan yang dihasilkan selama pengambilan data.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (DataQuery)
  },
  "generatedSql": string,
  "result": {
    object (DataResult)
  },
  "generatedLookerQuery": {
    object (LookerQuery)
  },
  "bigQueryJob": {
    object (BigQueryJob)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Apakah pesan ini berisi kueri, hasil, atau SQL yang dihasilkan untuk pengambilan data. kind hanya ada berupa salah satu diantara berikut:
query

object (DataQuery)

Kueri pengambilan data.
generatedSql

string

SQL yang dihasilkan oleh sistem untuk mengambil data.
result

object (DataResult)

Data yang diambil.
generatedLookerQuery
(deprecated)

object (LookerQuery)

Kueri Looker yang dihasilkan oleh sistem untuk mengambil data. Tidak digunakan lagi: kueri Looker yang dihasilkan kini berada di DataQuery.looker.
bigQueryJob

object (BigQueryJob)

Tugas BigQuery yang dijalankan oleh sistem untuk mengambil data.

DataQuery

Kueri untuk mengambil data.

Representasi JSON 
{
  "question": string,
  "name": string,
  "datasources": [
    {
      object (Datasource)
    }
  ],

  // Union field query_type can be only one of the following:
  "looker": {
    object (LookerQuery)
  }
  // End of list of possible types for union field query_type.
}
Kolom
question

string

Opsional. Pertanyaan dalam bahasa alami yang perlu dijawab.
name

string

Opsional. Nama snake case untuk kueri yang mencerminkan maksudnya. Digunakan untuk memberi nama hasil data yang sesuai, sehingga dapat dirujuk pada langkah-langkah berikutnya.

  • Contoh: "total_sales_by_product"
  • Contoh: "sales_for_product_12345"
datasources[]

object (Datasource)

Opsional. Sumber data yang tersedia untuk menjawab pertanyaan.
Kolom union query_type. Jenis kueri yang akan dieksekusi. query_type hanya ada berupa salah satu diantara berikut:
looker

object (LookerQuery)

Opsional. Kueri untuk mengambil data dari eksplorasi Looker.

DataResult

Data yang diambil.

Representasi JSON 
{
  "name": string,
  "schema": {
    object (Schema)
  },
  "data": [
    {
      object
    }
  ],
  "formattedData": [
    {
      object
    }
  ]
}
Kolom
name

string

Opsional. Nama snake_case untuk hasil data yang mencerminkan isinya. Nama ini digunakan untuk meneruskan hasil berdasarkan referensi, dan berfungsi sebagai sinyal tentang artinya.

  • Contoh: "total_sales_by_product"
  • Contoh: "sales_for_product_12345"
schema

object (Schema)

Opsional. Skema data.
data[]

object (Struct format)

Opsional. Konten data. Setiap baris adalah struct yang cocok dengan skema. Nilai sederhana direpresentasikan sebagai string, sedangkan struktur bertingkat direpresentasikan sebagai daftar atau struct.
formattedData[]

object (Struct format)

Opsional. Representasi data yang diformat, jika ada. Setiap baris adalah struct yang secara langsung sesuai dengan baris pada indeks yang sama dalam kolom data. Nilainya adalah representasi string dari data asli, yang diformat sesuai dengan spesifikasi sumber data (misalnya, "$1.234,56" untuk mata uang). Kolom tanpa format akan menggunakan representasi nilai mentahnya secara default. Jika tidak ada kolom yang memiliki aturan pemformatan, kolom ini akan kosong.

BigQueryJob

Tugas BigQuery yang dieksekusi oleh sistem.

Representasi JSON 
{
  "projectId": string,
  "jobId": string,
  "location": string,
  "destinationTable": {
    object (BigQueryTableReference)
  },
  "schema": {
    object (Schema)
  }
}
Kolom
projectId

string

Wajib. Project tempat tugas berada.

Lihat JobReference.
jobId

string

Wajib. ID tugas.

Lihat JobReference.
location

string

Opsional. Lokasi tugas.

Lihat JobReference.
destinationTable

object (BigQueryTableReference)

Opsional. Referensi ke tabel tujuan hasil kueri tugas.

Lihat JobConfigurationQuery.
schema

object (Schema)

Opsional. Skema hasil kueri tugas.

Lihat JobStatistics2.

AnalysisMessage

Pesan yang dihasilkan selama analisis.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (AnalysisQuery)
  },
  "progressEvent": {
    object (AnalysisEvent)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Apakah pesan ini berisi kueri atau salah satu peristiwa dari analisis. kind hanya ada berupa salah satu diantara berikut:
query

object (AnalysisQuery)

Kueri analisis.
progressEvent

object (AnalysisEvent)

Peristiwa yang menunjukkan progres analisis.

AnalysisQuery

Kueri untuk melakukan analisis.

Representasi JSON 
{
  "question": string,
  "dataResultNames": [
    string
  ]
}
Kolom
question

string

Opsional. Pertanyaan analisis untuk membantu menjawab pertanyaan awal pengguna.
dataResultNames[]

string

Opsional. Nama hasil data yang sebelumnya diambil untuk dianalisis.

AnalysisEvent

Peristiwa yang menunjukkan progres analisis.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "plannerReasoning": string,
  "coderInstruction": string,
  "code": string,
  "executionOutput": string,
  "executionError": string,
  "resultVegaChartJson": string,
  "resultNaturalLanguage": string,
  "resultCsvData": string,
  "resultReferenceData": string,
  "error": string
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis peristiwa yang terjadi selama analisis. kind hanya ada berupa salah satu diantara berikut:
plannerReasoning

string

Alasan perencana codegen Python.
coderInstruction

string

Petunjuk yang dikeluarkan untuk pembuatan kode.
code

string

Kode yang dihasilkan.
executionOutput

string

Output dari eksekusi kode.
executionError

string

Error dari eksekusi kode.
resultVegaChartJson

string

Hasil sebagai string JSON diagram Vega.
resultNaturalLanguage

string

Hasil sebagai string NL.
resultCsvData

string

Hasil sebagai string CSV.
resultReferenceData

string

Hasil sebagai referensi ke sumber data.
error

string

Pesan error umum.

ChartMessage

Pesan yang dihasilkan selama pembuatan diagram.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "query": {
    object (ChartQuery)
  },
  "result": {
    object (ChartResult)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Apakah pesan ini berisi kueri atau hasil pembuatan diagram. kind hanya ada berupa salah satu diantara berikut:
query

object (ChartQuery)

Kueri untuk membuat diagram.
result

object (ChartResult)

Hasil kueri pembuatan diagram.

ChartQuery

Kueri untuk membuat diagram.

Representasi JSON 
{
  "instructions": string,
  "dataResultName": string
}
Kolom
instructions

string

Opsional. Petunjuk bahasa alami untuk membuat diagram.
dataResultName

string

Opsional. Nama hasil data yang sebelumnya diambil untuk digunakan dalam diagram.

ChartResult

Hasil kueri pembuatan diagram.

Representasi JSON 
{
  "vegaConfig": {
    object
  },
  "image": {
    object (Blob)
  }
}
Kolom
vegaConfig

object (Struct format)

Opsional. Konfigurasi diagram Vega yang dibuat. Lihat https://vega.github.io/vega/docs/config/
image

object (Blob)

Opsional. Rendering diagram jika ini diminta dalam konteks.

Blob

Blob data dengan jenis MIME.

Representasi JSON 
{
  "mimeType": string,
  "data": string
}
Kolom
mimeType

string

Wajib. Jenis MIME standar IANA dari data pesan.
data

string (bytes format)

Wajib. Data yang ditampilkan sebagai byte.

String berenkode base64.

ErrorMessage

Pesan error dari panggilan alat. Pesan ini digunakan untuk menunjukkan error yang terjadi saat agen mencoba menggunakan alat. Penting untuk diperhatikan bahwa tidak semua error bersifat fatal. Banyak yang dapat dipulihkan, dan agen dapat menggunakan informasi dari pesan error ini untuk mengoreksi diri sendiri dan mencoba lagi panggilan alat atau mencoba pendekatan yang berbeda.

Misalnya, jika kueri data gagal, agen dapat menerima ErrorMessage, menganalisisnya, lalu membuat kueri yang telah diperbaiki.

Klien harus berhati-hati dalam menafsirkan pesan ini sebagai kegagalan yang pasti. Ini dapat menjadi bagian dari proses iteratif normal agen dalam menyelesaikan tugas. Menampilkan error ini langsung kepada pengguna akhir tanpa konteks (misalnya, sebagai "kegagalan berat") dapat menyesatkan.

Representasi JSON 
{
  "text": string
}
Kolom
text

string

Hanya output. Teks error.

ExampleQueries

Pesan yang berisi contoh kueri turunan dan buatan pengguna.

Representasi JSON 
{
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Kolom
exampleQueries[]

object (ExampleQuery)

Opsional. Daftar contoh kueri turunan dan buatan, yang memberikan contoh kueri SQL yang relevan dan umum digunakan serta kueri bahasa alaminya yang sesuai, jika ada. Saat ini hanya digunakan untuk sumber data BigQuery.

ClarificationMessage

Tidak digunakan lagi: Gunakan TextMessage dengan TextType.FINAL_RESPONSE sebagai gantinya. Pesan pertanyaan untuk membantu mengklarifikasi kueri pengguna. Respons ini ditampilkan saat sistem tidak dapat menjawab pertanyaan pengguna dengan yakin.

Representasi JSON 
{
  "questions": [
    {
      object (ClarificationQuestion)
    }
  ]
}
Kolom
questions[]
(deprecated)

object (ClarificationQuestion)

Wajib. Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Sekumpulan pertanyaan klarifikasi untuk diajukan kepada pengguna.

ClarificationQuestion

Tidak digunakan lagi: Gunakan TextMessage dengan TextType.FINAL_RESPONSE sebagai gantinya. Menampilkan satu pertanyaan kepada pengguna untuk membantu mengklarifikasi kueri mereka.

Representasi JSON 
{
  "question": string,
  "selectionMode": enum (SelectionMode),
  "options": [
    string
  ],
  "clarificationQuestionType": enum (ClarificationQuestionType)
}
Kolom
question
(deprecated)

string

Wajib. Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Pertanyaan bahasa alami yang akan diajukan kepada pengguna.
selectionMode
(deprecated)

enum (SelectionMode)

Wajib. Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Mode pemilihan untuk pertanyaan ini.
options[]
(deprecated)

string

Wajib. Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Daftar opsi berbeda yang dapat dipilih pengguna. Jumlah opsi dibatasi hingga maksimum 5.
clarificationQuestionType
(deprecated)

enum (ClarificationQuestionType)

Opsional. Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Jenis pertanyaan klarifikasi.

SelectionMode

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Mode pemilihan untuk pertanyaan klarifikasi.

Enum
SELECTION_MODE_UNSPECIFIED

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Mode pemilihan tidak ditentukan.
SINGLE_SELECT

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Pengguna hanya dapat memilih satu opsi.
MULTI_SELECT

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Pengguna dapat memilih beberapa opsi.

ClarificationQuestionType

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Jenis pertanyaan klarifikasi. Enum ini dapat diperluas dengan nilai baru pada masa mendatang.

Enum
CLARIFICATION_QUESTION_TYPE_UNSPECIFIED

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Jenis pertanyaan klarifikasi tidak ditentukan.
FILTER_VALUES

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Pertanyaan klarifikasi adalah untuk nilai filter.
FIELDS

Tidak digunakan lagi: Pesan induk tidak digunakan lagi. Pertanyaan klarifikasi adalah untuk kolom data. Ini adalah istilah umum yang mencakup kolom SQL, kolom Looker (dimensi/ukuran), atau properti struktur data bertingkat.