REST Resource: projects.locations.dataAgents

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 type can be only one of the following:
  "dataAnalyticsAgent": {
    object (DataAnalyticsAgent)
  }
  // End of list of possible types for union field type.
}
Kolom
name

string

Opsional. ID. Nama resource unik DataAgent. Format: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} adalah ID resource dan harus 63 karakter atau kurang serta harus cocok dengan format yang dijelaskan di https://google.aip.dev/122#resource-id-segments

Contoh: projects/1234567890/locations/us-central1/dataAgents/my-agent.

Sebaiknya lewati setelan kolom ini selama pembuatan agen karena kolom ini akan disimpulkan secara otomatis dan diganti dengan {parent}/dataAgents/{dataAgentId}.
displayName

string

Opsional. Nama tampilan yang mudah digunakan.

  • Harus terdiri dari 1-256 karakter.
description

string

Opsional. Deskripsi agen.

  • Harus terdiri dari 1-1024 karakter.
labels

map (key: string, value: string)

Opsional. Label untuk membantu pengguna memfilter agen terkait. Misalnya, "sales", "business", "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 "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Hanya output. Waktu saat agen data dibuat.

Menggunakan RFC 3339, dengan output yang dihasilkan 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".
updateTime

string (Timestamp format)

Hanya output. Waktu saat agen data terakhir diperbarui.

Menggunakan RFC 3339, dengan output yang dihasilkan 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".
deleteTime

string (Timestamp format)

Hanya output. [Khusus output] Waktu saat agen data dihapus sementara.

Menggunakan RFC 3339, dengan output yang dihasilkan 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".
purgeTime

string (Timestamp format)

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, dengan output yang dihasilkan 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".
Kolom union type. Jenis agen. Dapat berupa salah satu dari berikut ini: * Agen analisis data. * Agen rekayasa data type hanya dapat berupa salah satu dari berikut ini:
dataAnalyticsAgent

object (DataAnalyticsAgent)

Agen analisis data.

DataAnalyticsAgent

Pesan yang menjelaskan objek DataAnalyticsAgent.

Representasi JSON 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  },
  "lastPublishedContext": {
    object (Context)
  }
}
Kolom
stagingContext

object (Context)

Opsional. Konteks penyiapan untuk agen. Konteks ini digunakan untuk menguji dan memvalidasi perubahan sebelum dipublikasikan.
publishedContext

object (Context)

Opsional. Konteks yang dipublikasikan untuk agen. Konteks ini digunakan oleh Chat API dalam produksi.
lastPublishedContext

object (Context)

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 ke percakapan ini

Representasi JSON 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Kolom
systemInstruction

string

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

object (DatasourceReferences)

Wajib. Sumber data yang tersedia untuk menjawab pertanyaan.
options

object (ConversationOptions)

Opsional. Opsi tambahan untuk percakapan.
exampleQueries[]

object (ExampleQuery)

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.

DatasourceReferences

Kumpulan referensi ke sumber data.

Representasi JSON 
{

  // Union field references can be only one of the following:
  "bq": {
    object (BigQueryTableReferences)
  },
  "studio": {
    object (StudioDatasourceReferences)
  },
  "looker": {
    object (LookerExploreReferences)
  }
  // End of list of possible types for union field references.
}
Kolom
Kolom union references. Sumber data yang akan digunakan. references hanya ada berupa salah satu diantara berikut:
bq

object (BigQueryTableReferences)

Referensi ke tabel BigQuery.
studio

object (StudioDatasourceReferences)

Referensi ke sumber data Looker Studio.
looker

object (LookerExploreReferences)

Referensi ke Jelajah Looker.

BigQueryTableReferences

Pesan yang merepresentasikan referensi ke tabel BigQuery.

Representasi JSON 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ]
}
Kolom
tableReferences[]

object (BigQueryTableReference)

Wajib. Referensi ke tabel BigQuery.

BigQueryTableReference

Pesan yang merepresentasikan referensi ke satu tabel BigQuery.

Representasi JSON 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
Kolom
projectId

string

Wajib. Project tempat tabel berada.
datasetId

string

Wajib. Set data tempat tabel berada.
tableId

string

Wajib. ID tabel.
schema

object (Schema)

Opsional. Skema sumber data.

Skema

Skema instance Datasource atau QueryResult.

Representasi JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "description": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "filters": [
    {
      object (DataFilter)
    }
  ]
}
Kolom
fields[]

object (Field)

Opsional. Kolom dalam skema.
description

string

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[]

string

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[]

string

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

string

Opsional. Table displayName (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[]

object (DataFilter)

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 (Field)
    }
  ],
  "category": string,
  "valueFormat": string
}
Kolom
name

string

Opsional. Nama kolom.
type

string

Opsional. Jenis kolom.
description

string

Opsional. Deskripsi singkat kolom.
mode

string

Opsional. Mode kolom (misalnya, NULLABLE, REPEATED).
synonyms[]

string

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[]

string

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

string

Opsional. displayName kolom (sama dengan label di
subfields[]

object (Field)

Opsional. Properti rekursif untuk struktur skema bertingkat.
category

string

Opsional. Kategori kolom, tidak wajib, saat ini hanya berguna untuk Looker. Kita menggunakan string untuk menghindari ketergantungan pada paket eksternal dan menjaga agar paket ini tetap mandiri.
valueFormat

string

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 sintaks filter: https://cloud.google.com/looker/docs/filter-expressions

Representasi JSON 
{
  "field": string,
  "value": string,
  "type": enum (DataFilterType)
}
Kolom
field

string

Opsional. Kolom yang akan difilter. Misalnya: ["event_date", "customer_id", "product_category"]
value

string

Opsional. Nilai default yang digunakan untuk filter ini jika filter tidak diganti dalam kueri. Misalnya: ["after 2024-01-01", "123", "-fashion"]
type

enum (DataFilterType)

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 (StudioDatasourceReference)
    }
  ]
}
Kolom
studioReferences[]

object (StudioDatasourceReference)

Referensi ke sumber data studio.

StudioDatasourceReference

Pesan yang merepresentasikan referensi ke satu sumber data Looker Studio.

Representasi JSON 
{
  "datasourceId": string
}
Kolom
datasourceId

string

Wajib. ID sumber data.

LookerExploreReferences

Pesan yang merepresentasikan referensi ke eksplorasi Looker.

Representasi JSON 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
Kolom
exploreReferences[]

object (LookerExploreReference)

Wajib. Referensi ke penjelajahan Looker.
credentials

object (Credentials)

Opsional. Kredensial yang akan digunakan saat memanggil Looker API.

Saat ini mendukung kredensial berbasis token OAuth dan kunci API, seperti yang dijelaskan dalam Autentikasi dengan SDK.

LookerExploreReference

Pesan yang merepresentasikan referensi ke satu penjelajahan Looker.

Representasi JSON 
{
  "lookmlModel": string,
  "explore": string,
  "schema": {
    object (Schema)
  },

  // Union field instance can be only one of the following:
  "lookerInstanceUri": string,
  "privateLookerInstanceInfo": {
    object (PrivateLookerInstanceInfo)
  }
  // End of list of possible types for union field instance.
}
Kolom
lookmlModel

string

Wajib. Model Looker, seperti yang diuraikan dalam Struktur LookML utama. Nama model LookML.
explore

string

Wajib. Jelajah Looker, seperti yang diuraikan dalam Struktur LookML utama. Nama Jelajah LookML.
schema

object (Schema)

Opsional. Skema sumber data.
Kolom union instance. Instance penjelajahan Looker. instance hanya ada berupa salah satu diantara berikut:
lookerInstanceUri

string

Wajib. URL dasar instance Looker.
privateLookerInstanceInfo

object (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

string

ID instance Looker.
serviceDirectoryName

string

Nama direktori layanan instance Looker.

Kredensial

Mewakili berbagai bentuk spesifikasi kredensial.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis kredensial. } kind hanya dapat berupa salah satu dari hal berikut:
oauth

object (OAuthCredentials)

Kredensial OAuth.

OAuthCredentials

Mewakili kredensial OAuth.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis kredensial OAuth. kind hanya ada berupa salah satu diantara berikut:
secret

object (SecretBased)

Kredensial OAuth berbasis rahasia.
token

object (TokenBased)

Kredensial OAuth berbasis token.

SecretBased

Nama secret yang berisi token akses. Menampilkan kredensial OAuth berbasis secret.

Representasi JSON 
{
  "clientId": string,
  "clientSecret": string
}
Kolom
clientId

string

Wajib. ID klien OAuth.
clientSecret

string

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

string

Wajib. Nama secret yang berisi token akses.

ConversationOptions

Opsi untuk percakapan.

Representasi JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
Kolom
chart

object (ChartOptions)

Opsional. Opsi untuk pembuatan diagram.
analysis

object (AnalysisOptions)

Opsional. Opsi untuk analisis.

ChartOptions

Opsi untuk pembuatan diagram.

Representasi JSON 
{
  "image": {
    object (ImageOptions)
  }
}
Kolom
image

object (ImageOptions)

Opsional. Jika ditentukan, agen akan merender diagram yang dibuat menggunakan format yang diberikan. Defaultnya adalah tidak ada gambar.

ImageOptions

Opsi untuk merender gambar diagram yang dibuat.

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "noImage": {
    object (NoImage)
  },
  "svg": {
    object (SvgOptions)
  }
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis gambar yang akan dirender. kind hanya ada berupa salah satu diantara berikut:
noImage

object (NoImage)

Tidak ada gambar.
svg

object (SvgOptions)

Format SVG.

NoImage

Jenis ini tidak memiliki kolom.

Tidak ada gambar.

SvgOptions

Jenis ini tidak memiliki kolom.

Opsi SVG.

AnalysisOptions

Opsi untuk analisis.

Representasi JSON 
{
  "python": {
    object (Python)
  }
}
Kolom
python

object (Python)

Opsional. Opsi untuk analisis Python.

Python

Opsi untuk analisis Python.

Representasi JSON 
{
  "enabled": boolean
}
Kolom
enabled

boolean

Opsional. Apakah analisis Python diaktifkan atau tidak. Nilai defaultnya adalah salah (false).

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,

  // Union field query can be only one of the following:
  "sqlQuery": string
  // End of list of possible types for union field query.
}
Kolom
naturalLanguageQuestion

string

Opsional. Pertanyaan bahasa alami yang mungkin diajukan pengguna. Misalnya: "Berapa banyak pesanan yang dilakukan bulan lalu?"
Kolom union query. Kueri SQL atau Looker yang harus dibuat untuk menjawab kueri bahasa alami. query hanya ada berupa salah satu diantara berikut:
sqlQuery

string

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'"

Metode

create

 Membuat DataAgent baru di project dan lokasi tertentu.

delete

 Menghapus satu DataAgent.

get

 Mendapatkan detail satu DataAgent.

getIamPolicy

 Mendapatkan kebijakan IAM untuk DataAgent

list

 Mencantumkan DataAgent dalam project dan lokasi tertentu.

listAccessible

 Mencantumkan DataAgent yang dapat diakses oleh pemanggil di project dan lokasi tertentu.

patch

 Memperbarui parameter satu DataAgent.

setIamPolicy

 Menetapkan kebijakan IAM untuk DataAgent.