- Resource: DataAgent
- DataAnalyticsAgent
- Konteks
- DatasourceReferences
- BigQueryTableReferences
- BigQueryTableReference
- Skema
- Kolom
- DataFilter
- DataFilterType
- StudioDatasourceReferences
- StudioDatasourceReference
- LookerExploreReferences
- LookerExploreReference
- PrivateLookerInstanceInfo
- ConversationOptions
- AnalysisOptions
- Python
- DatasourceOptions
- Model
- ExampleQuery
- QueryParameter
- LookerGoldenQuery
- LookerQuery
- Filter
- GlossaryTerm
- SchemaRelationship
- SchemaPaths
- Source
- UserFunctions
- BigQueryRoutine
- BigQueryRoutineReference
- Metode
Resource: DataAgent
Pesan yang menjelaskan objek DataAgent.
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "description": string, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "purgeTime": string, // Union field |
| Kolom | |
|---|---|
name |
Opsional. ID. Nama resource unik DataAgent. Format: Contoh: Sebaiknya lewati penetapan kolom ini selama pembuatan agen karena kolom ini akan disimpulkan secara otomatis dan diganti dengan {parent}/dataAgents/{dataAgentId}. |
displayName |
Opsional. Nama tampilan yang mudah digunakan.
|
description |
Opsional. Deskripsi agen.
|
labels |
Opsional. Label untuk membantu pengguna memfilter agen terkait. Misalnya, "penjualan", "bisnis", "etl", dan sebagainya. Label catatan hanya digunakan untuk pemfilteran, bukan untuk kebijakan. Lihat dokumentasi label untuk mengetahui detail selengkapnya tentang penggunaan label. Objek yang berisi daftar pasangan |
createTime |
Hanya output. Waktu saat agen data dibuat. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
updateTime |
Hanya output. Waktu saat agen data terakhir diperbarui. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
deleteTime |
Hanya output. [Khusus output] Waktu saat agen data dihapus sementara. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
purgeTime |
Hanya output. Stempel waktu dalam UTC saat agen data ini dianggap telah berakhir. Ini selalu diberikan pada output, terlepas dari apa yang dikirim pada input. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
Kolom union type. Jenis agen. Dapat berupa salah satu dari berikut: * Agen analisis data. * Agen rekayasa data type hanya dapat berupa salah satu dari berikut ini: |
|
dataAnalyticsAgent |
Agen analisis data. |
kmsKey |
Opsional. Kunci enkripsi yang dikelola pelanggan (CMEK) untuk digunakan dalam mengenkripsi resource DataAgent. CryptoKey Cloud KMS harus berada di lokasi yang sama dengan DataAgent. Format yang diharapkan adalah |
DataAnalyticsAgent
Pesan yang menjelaskan objek DataAnalyticsAgent.
| Representasi JSON |
|---|
{ "stagingContext": { object ( |
| Kolom | |
|---|---|
stagingContext |
Opsional. Konteks penyiapan untuk agen. Konteks ini digunakan untuk menguji dan memvalidasi perubahan sebelum dipublikasikan. |
publishedContext |
Opsional. Konteks yang dipublikasikan untuk agen. Konteks ini digunakan oleh Chat API dalam produksi. |
lastPublishedContext |
Hanya output. Konteks terakhir yang dipublikasikan untuk agen. Ini adalah kolom hanya output yang diisi oleh sistem saat konteks yang dipublikasikan diperbarui. Tindakan ini digunakan untuk memulihkan agen ke status sebelumnya. |
Konteks
Kumpulan konteks yang akan diterapkan pada percakapan ini
| Representasi JSON |
|---|
{ "systemInstruction": string, "datasourceReferences": { object ( |
| Kolom | |
|---|---|
systemInstruction |
Opsional. Titik entri dasar bagi pemilik data yang membuat pengetahuan domain untuk Agen. Alasan: Jargon bisnis (misalnya, Pendapatan YTD dihitung sebagai…, Usia Pensiun adalah 65 tahun di Amerika Serikat, dll.) dan petunjuk sistem (misalnya, jawab seperti Bajak Laut) dapat membantu model memahami konteks bisnis seputar pertanyaan pengguna. |
datasourceReferences |
Wajib. Sumber data yang tersedia untuk menjawab pertanyaan. |
options |
Opsional. Opsi tambahan untuk percakapan. |
exampleQueries[] |
Opsional. Daftar contoh kueri, 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 dan sumber data database (alloydb, cloudsql, spanner). |
lookerGoldenQueries[] |
Opsional. Daftar kueri emas, yang memberikan contoh kueri Looker yang relevan dan umum digunakan serta kueri bahasa alaminya yang sesuai (jika ada). Hanya didukung untuk sumber data Looker. |
glossaryTerms[] |
Opsional. Definisi istilah (saat ini, hanya yang dibuat pengguna) Tidak didukung untuk sumber data database (alloydb, cloudsql, spanner). |
schemaRelationships[] |
Opsional. Hubungan antara skema tabel, termasuk kolom yang dirujuk dan merujuk. |
userFunctions |
Opsional. Kumpulan fungsi pengguna yang akan disertakan dalam konteks. |
DatasourceReferences
Kumpulan referensi ke sumber data.
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union references. Sumber data yang akan digunakan. references hanya ada berupa salah satu diantara berikut: |
|
bq |
Referensi ke tabel BigQuery. |
studio |
Referensi ke sumber data Looker Studio. |
looker |
Referensi ke Eksplorasi Looker. |
BigQueryTableReferences
Pesan yang merepresentasikan referensi ke tabel BigQuery dan grafik properti. Setidaknya salah satu dari tableReferences, propertyGraphReferences, atau searchScope harus diisi.
| Representasi JSON |
|---|
{
"tableReferences": [
{
object ( |
| Kolom | |
|---|---|
tableReferences[] |
Opsional. Referensi ke tabel BigQuery. |
BigQueryTableReference
Pesan yang merepresentasikan referensi ke satu tabel BigQuery.
| Representasi JSON |
|---|
{
"projectId": string,
"datasetId": string,
"tableId": string,
"schema": {
object ( |
| Kolom | |
|---|---|
projectId |
Wajib. Project tempat tabel berada. |
datasetId |
Wajib. Set data tempat tabel berada. |
tableId |
Wajib. ID tabel. |
schema |
Opsional. Skema sumber data. |
Skema
Skema instance Datasource atau QueryResult.
| Representasi JSON |
|---|
{ "fields": [ { object ( |
| Kolom | |
|---|---|
fields[] |
Opsional. Kolom dalam skema. |
description |
Opsional. Deskripsi tekstual tentang konten dan tujuan tabel. Misalnya: "Berisi informasi tentang pesanan pelanggan di toko e-commerce kami." Saat ini hanya digunakan untuk sumber data BigQuery. |
synonyms[] |
Opsional. Daftar nama alternatif atau sinonim yang dapat digunakan untuk merujuk ke tabel. Misalnya: ["penjualan", "pesanan", "pembelian"]. Saat ini hanya digunakan untuk sumber data BigQuery. |
tags[] |
Opsional. Daftar tag atau kata kunci yang terkait dengan tabel, yang digunakan untuk kategorisasi. Misalnya: ["transaction", "revenue", "customer_data"]. Saat ini hanya digunakan untuk sumber data BigQuery. |
displayName |
Opsional. displayName tabel (sama dengan label di cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), tidak wajib, saat ini hanya Looker yang memiliki kolom ini. |
filters[] |
Opsional. Filter pada data pokok sumber data. Saat ini hanya digunakan untuk sumber data Looker. |
Kolom
Kolom dalam skema.
| Representasi JSON |
|---|
{
"name": string,
"type": string,
"description": string,
"mode": string,
"synonyms": [
string
],
"tags": [
string
],
"displayName": string,
"subfields": [
{
object ( |
| Kolom | |
|---|---|
name |
Opsional. Nama kolom. |
type |
Opsional. Jenis kolom. |
description |
Opsional. Deskripsi singkat kolom. |
mode |
Opsional. Mode kolom (misalnya, NULLABLE, REPEATED). |
synonyms[] |
Opsional. Daftar nama alternatif atau sinonim yang dapat digunakan untuk merujuk ke kolom ini. Misalnya: ["id", "customerid", "cust_id"]. Saat ini hanya digunakan untuk sumber data BigQuery. |
tags[] |
Opsional. Daftar tag atau kata kunci yang terkait dengan kolom, digunakan untuk kategorisasi. Misalnya: ["identifier", "customer", "pii"]. Saat ini hanya digunakan untuk sumber data BigQuery. |
displayName |
Opsional. Field displayName (sama dengan label di |
subfields[] |
Opsional. Properti rekursif untuk struktur skema bertingkat. |
category |
Opsional. Kategori kolom, tidak wajib, saat ini hanya berguna untuk Looker. |
valueFormat |
Opsional. Khusus Looker. Format nilai kolom. Ref: https://cloud.google.com/looker/docs/reference/param-field-value-format |
DataFilter
Filter pada data pokok sumber data. Dokumentasi sintaksis filter: https://cloud.google.com/looker/docs/filter-expressions
| Representasi JSON |
|---|
{
"field": string,
"value": string,
"type": enum ( |
| Kolom | |
|---|---|
field |
Opsional. Kolom yang akan difilter. Misalnya: ["event_date", "customer_id", "product_category"] |
value |
Opsional. Nilai default yang digunakan untuk filter ini jika filter tidak diganti dalam kueri. Misalnya: ["after 2024-01-01", "123", "-fashion"] |
type |
Opsional. Jenis filter yang ada di sumber data, seperti ALWAYS_FILTER. |
DataFilterType
Jenis filter yang ada di sumber data, seperti ALWAYS_FILTER.
| Enum | |
|---|---|
DATA_FILTER_TYPE_UNSPECIFIED |
Jenis filter tidak ditentukan. |
ALWAYS_FILTER |
Filter yang dikonfigurasi pengguna, dan kueri apa pun ke Jelajah akan selalu menerapkan filter ini secara default. Saat ini hanya digunakan untuk sumber data Looker. |
StudioDatasourceReferences
Pesan yang merepresentasikan referensi ke sumber data Looker Studio.
| Representasi JSON |
|---|
{
"studioReferences": [
{
object ( |
| Kolom | |
|---|---|
studioReferences[] |
Opsional. Referensi ke sumber data studio. |
StudioDatasourceReference
Pesan yang merepresentasikan referensi ke satu sumber data Looker Studio.
| Representasi JSON |
|---|
{ "datasourceId": string } |
| Kolom | |
|---|---|
datasourceId |
Wajib. ID sumber data. |
LookerExploreReferences
Pesan yang merepresentasikan referensi ke eksplorasi Looker.
| Representasi JSON |
|---|
{
"exploreReferences": [
{
object ( |
| Kolom | |
|---|---|
exploreReferences[] |
Wajib. Referensi ke penjelajahan Looker. |
LookerExploreReference
Pesan yang merepresentasikan referensi ke satu penjelajahan Looker.
| Representasi JSON |
|---|
{ "lookmlModel": string, "explore": string, "schema": { object ( |
| Kolom | |
|---|---|
lookmlModel |
Wajib. Model Looker, seperti yang diuraikan dalam Struktur LookML utama. Nama model LookML. |
explore |
Wajib. Eksplorasi Looker, seperti yang diuraikan dalam Struktur LookML utama. Nama Eksplorasi LookML. |
schema |
Opsional. Skema sumber data. |
Kolom union instance. Instance penjelajahan Looker. instance hanya ada berupa salah satu diantara berikut: |
|
lookerInstanceUri |
Wajib. URL dasar instance Looker. |
privateLookerInstanceInfo |
Info instance Looker pribadi. |
PrivateLookerInstanceInfo
Pesan yang merepresentasikan info instance Looker pribadi diperlukan jika instance Looker berada di belakang jaringan pribadi.
| Representasi JSON |
|---|
{ "lookerInstanceId": string, "serviceDirectoryName": string } |
| Kolom | |
|---|---|
lookerInstanceId |
ID instance Looker. |
serviceDirectoryName |
Nama direktori layanan instance Looker. |
ConversationOptions
Opsi untuk percakapan.
| Representasi JSON |
|---|
{ "analysis": { object ( |
| Kolom | |
|---|---|
analysis |
Opsional. Opsi untuk analisis. |
datasource |
Opsional. Opsi untuk sumber data. |
model |
Opsional. Model yang akan digunakan untuk loop agen. |
AnalysisOptions
Opsi untuk analisis.
| Representasi JSON |
|---|
{
"python": {
object ( |
| Kolom | |
|---|---|
python |
Opsional. Opsi untuk analisis Python. |
Python
Opsi untuk analisis Python.
| Representasi JSON |
|---|
{ "enabled": boolean } |
| Kolom | |
|---|---|
enabled |
Opsional. Apakah akan mengaktifkan analisis Python atau tidak. Nilai defaultnya adalah salah (false). |
DatasourceOptions
Opsi untuk konfigurasi sumber data.
| Representasi JSON |
|---|
{ "bigQueryMaxBilledBytes": string } |
| Kolom | |
|---|---|
bigQueryMaxBilledBytes |
Opsional. Opsi ini hanya berlaku untuk sumber data yang memerlukan kueri BigQuery. Membatasi byte yang ditagih untuk setiap tugas kueri BigQuery. Kueri yang akan ditagih untuk byte di luar batas ini akan gagal (tanpa menimbulkan biaya). Jika tidak ditentukan, tidak ada batas yang akan diterapkan. |
Model
Model yang diizinkan untuk agen/percakapan.
| Enum | |
|---|---|
MODEL_UNSPECIFIED |
Tidak ada model yang ditentukan. Model dapat ditetapkan pada permintaan chat, atau model default akan digunakan. |
LATEST_GA_MODEL |
Gunakan model non-pratinjau terbaru. Hal ini dapat membatasi setelan tingkat permintaan tertentu. |
ExampleQuery
Contoh kueri SQL yang relevan dan umum digunakan serta kueri bahasa alaminya yang sesuai dapat ditampilkan secara opsional. Saat ini hanya digunakan untuk sumber data BigQuery.
| Representasi JSON |
|---|
{ "naturalLanguageQuestion": string, "parameters": [ { object ( |
| Kolom | |
|---|---|
naturalLanguageQuestion |
Opsional. Pertanyaan dalam bahasa alami yang mungkin diajukan pengguna. Misalnya: "Berapa banyak pesanan yang dilakukan bulan lalu?" |
parameters[] |
Opsional. Daftar parameter kueri. Contoh: Kueri SQL berparameter "SELECT * FROM my_table WHERE id = @id" dapat dicocokkan dengan nilai ID apa pun. |
Kolom union query. Kueri SQL atau Looker yang harus dibuat untuk menjawab kueri bahasa alami. query hanya ada berupa salah satu diantara berikut: |
|
sqlQuery |
Opsional. Kueri SQL yang harus dibuat untuk menjawab pertanyaan bahasa alami. Misalnya: "SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'" |
QueryParameter
Pesan parameter kueri merepresentasikan parameter yang dapat digunakan untuk memparameterkan kueri SQL.
| Representasi JSON |
|---|
{ "name": string, "description": string, "dataType": string } |
| Kolom | |
|---|---|
name |
Wajib. Nama referensi parameter dalam kueri SQL. |
description |
Opsional. Deskripsi parameter yang dapat digunakan oleh LLM untuk mengekstrak nilai parameter dari pertanyaan pengguna. |
dataType |
Wajib. Jenis data parameter, misalnya "STRING", "INT64", "DATE", dll. Untuk nilai yang valid, lihat dokumentasi BigQuery. Nilai ini akan digunakan untuk mengisi google.cloud.bigquery.v2.QueryParameterType.type. |
LookerGoldenQuery
Kueri emas untuk Looker, termasuk pertanyaan bahasa alami dan Kueri Looker yang sesuai. Serupa dengan ExampleQuery.
| Representasi JSON |
|---|
{
"naturalLanguageQuestions": [
string
],
"lookerQuery": {
object ( |
| Kolom | |
|---|---|
naturalLanguageQuestions[] |
Opsional. Pertanyaan bahasa alami yang mungkin diajukan pengguna. Misalnya: "Berapa banyak pesanan yang dilakukan bulan lalu?" |
lookerQuery |
Opsional. Kueri Looker yang sesuai dengan pertanyaan bahasa alami. |
LookerQuery
Objek Kueri Looker dokumentasi Looker API.
| Representasi JSON |
|---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
| Kolom | |
|---|---|
model |
Wajib. Model LookML yang digunakan untuk membuat kueri. |
explore |
Wajib. Eksplorasi LookML yang digunakan untuk membuat kueri. |
fields[] |
Opsional. Kolom yang akan diambil dari eksplorasi. |
filters[] |
Opsional. Filter yang akan diterapkan ke penjelajahan. |
sorts[] |
Opsional. Pengurutan yang akan diterapkan pada eksplorasi. |
limit |
Opsional. Batas dalam kueri. |
queryId |
Opsional. ID utama untuk resource kueri di Looker, yang digunakan untuk operasi API. Dipetakan ke |
clientId |
Opsional. ID alfanumerik singkat untuk kueri, yang digunakan untuk link berbagi dan URL Jelajahi (misalnya, dalam parameter |
Filter
Filter kueri Looker.
| Representasi JSON |
|---|
{ "field": string, "value": string } |
| Kolom | |
|---|---|
field |
Wajib. Kolom yang akan difilter. |
value |
Opsional. Nilai untuk kolom yang akan difilter. Opsional sehingga kita dapat mempertahankan nilai default sebagai string kosong, yang penting untuk mendapatkan URL Eksplorasi Looker yang valid dan berfungsi. |
GlossaryTerm
Definisi istilah dalam domain tertentu.
| Representasi JSON |
|---|
{ "displayName": string, "description": string, "labels": [ string ] } |
| Kolom | |
|---|---|
displayName |
Wajib. Nama tampilan yang mudah digunakan untuk istilah glosarium yang sedang didefinisikan. Misalnya: "CTR", "rasio konversi", "tertunda" |
description |
Wajib. Deskripsi atau arti istilah. Misalnya: "Rasio klik-tayang", "Persentase pengguna yang menyelesaikan tindakan yang diinginkan", "Pesanan yang menunggu diproses". |
labels[] |
Opsional. Daftar label tujuan umum yang terkait dengan istilah ini. Misalnya: ["rasio klik-tayang", "klik-tayang", "menunggu"] |
SchemaRelationship
Hubungan antara dua tabel, termasuk kolom yang dirujuk dan merujuk. Ini adalah konteks turunan yang diambil dari Insight Set Data Dataplex.
| Representasi JSON |
|---|
{ "leftSchemaPaths": { object ( |
| Kolom | |
|---|---|
leftSchemaPaths |
Daftar kolom yang diurutkan untuk gabungan dari tabel pertama. Ukuran daftar ini harus sama dengan |
rightSchemaPaths |
Daftar kolom yang diurutkan untuk gabungan dari tabel kedua. Ukuran daftar ini harus sama dengan |
sources[] |
Opsional. Sumber yang menghasilkan edge relasi skema. |
confidenceScore |
Opsional. Skor keyakinan untuk hubungan yang disarankan. Tepi yang ditambahkan secara manual memiliki skor keyakinan tertinggi. |
SchemaPaths
Menampilkan kumpulan jalur yang diurutkan dalam skema tabel.
| Representasi JSON |
|---|
{ "tableFqn": string, "paths": [ string ] } |
| Kolom | |
|---|---|
tableFqn |
Nama lengkap resource tabel yang memenuhi syarat layanan Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |
paths[] |
Daftar jalur yang diurutkan dalam skema tabel. |
Sumber
Sumber yang menghasilkan tepi relasi skema.
| Enum | |
|---|---|
SOURCE_UNSPECIFIED |
Sumber hubungan skema tidak ditentukan. |
BIGQUERY_JOB_HISTORY |
Sumber hubungan skema adalah histori tugas BigQuery. |
LLM_SUGGESTED |
Sumber hubungan skema adalah saran LLM. |
BIGQUERY_TABLE_CONSTRAINTS |
Sumber hubungan skema adalah batasan tabel BigQuery. |
UserFunctions
Kumpulan fungsi pengguna yang akan disertakan dalam konteks.
| Representasi JSON |
|---|
{
"bqRoutines": [
{
object ( |
| Kolom | |
|---|---|
bqRoutines[] |
Daftar rutinitas BigQuery yang akan disertakan dalam konteks. |
BigQueryRoutine
Referensi ke rutinitas BigQuery.
| Representasi JSON |
|---|
{
"routineReference": {
object ( |
| Kolom | |
|---|---|
routineReference |
Referensi ke rutinitas BigQuery. |
description |
Penggantian atau penambahan pengguna ke deskripsi, untuk memberi tahu agen kapan harus menggunakan UDF. |
BigQueryRoutineReference
Referensi ke rutinitas BigQuery.
| Representasi JSON |
|---|
{ "projectId": string, "datasetId": string, "routineId": string } |
| Kolom | |
|---|---|
projectId |
Project ID rutin. |
datasetId |
ID set data dari rutinitas. |
routineId |
ID rutinitas. |
Metode |
|
|---|---|
|
Membuat DataAgent baru di project dan lokasi tertentu. |
|
Membuat DataAgent baru di project dan lokasi tertentu secara serentak. |
|
Menghapus satu DataAgent. |
|
Menghapus satu DataAgent secara serentak. |
|
Mendapatkan detail satu DataAgent. |
|
Mendapatkan kebijakan IAM untuk DataAgent |
|
Mencantumkan DataAgent di project dan lokasi tertentu. |
|
Mencantumkan DataAgent yang dapat diakses oleh pemanggil di project dan lokasi tertentu. |
|
Memperbarui parameter satu DataAgent. |
|
Menetapkan kebijakan IAM untuk DataAgent. |
|
Memperbarui parameter satu DataAgent secara sinkron. |