Alat: update_tool
Memperbarui alat yang ditentukan. Pastikan untuk selalu meneruskan mask update dalam input.
Contoh berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP update_tool.
| Permintaan Curl |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "update_tool", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Skema Input
Pesan permintaan untuk AgentService.UpdateTool.
UpdateToolRequest
| Representasi JSON |
|---|
{
"tool": {
object ( |
| Kolom | |
|---|---|
tool |
Wajib. Alat yang akan diperbarui. |
updateMask |
Opsional. Mask kolom digunakan untuk mengontrol kolom mana yang diperbarui. Jika mask tidak ada, semua kolom akan diperbarui. Ini adalah comma-separated list berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: |
Alat
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| Kolom | |
|---|---|
name |
ID. ID unik alat. Format: -
|
displayName |
Hanya output. Nama tampilan alat, yang berasal dari jenis alat. Misalnya, nama tampilan [ClientFunction][Tool.ClientFunction] berasal dari properti |
executionType |
Opsional. Jenis eksekusi alat. |
createTime |
Hanya output. Stempel waktu saat alat 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. Stempel waktu saat alat 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: |
etag |
ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak. |
generatedSummary |
Hanya output. Jika alat dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan tersebut. |
toolFakeConfig |
Opsional. Konfigurasi untuk perilaku alat dalam mode palsu. |
Kolom union tool_type. Jenis alat. tool_type hanya ada berupa salah satu diantara berikut: |
|
clientFunction |
Opsional. Fungsi klien. |
openApiTool |
Opsional. Alat API terbuka. |
googleSearchTool |
Opsional. Alat penelusuran google. |
connectorTool |
Opsional. Alat Integration Connector. |
dataStoreTool |
Opsional. Alat penyimpanan data. |
pythonFunction |
Opsional. Alat fungsi python. |
mcpTool |
Opsional. Alat MCP. Alat MCP tidak dapat dibuat atau diperbarui secara langsung dan dikelola oleh toolset MCP. |
fileSearchTool |
Opsional. Alat penelusuran file. |
systemTool |
Opsional. Alat sistem. |
widgetTool |
Opsional. Alat widget. |
ClientFunction
| Representasi JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama fungsi. |
description |
Opsional. Deskripsi fungsi. |
parameters |
Opsional. Skema parameter fungsi. |
response |
Opsional. Skema respons fungsi. |
Skema
| Representasi JSON |
|---|
{ "type": enum ( |
| Kolom | |
|---|---|
type |
Wajib. Jenis data. |
properties |
Opsional. Properti Type.OBJECT. Objek yang berisi daftar pasangan |
required[] |
Opsional. Properti wajib Type.OBJECT. |
description |
Opsional. Deskripsi data. |
items |
Opsional. Skema elemen Type.ARRAY. |
nullable |
Opsional. Menunjukkan apakah nilai boleh berupa null. |
uniqueItems |
Opsional. Menunjukkan bahwa item dalam array harus unik. Hanya berlaku untuk TYPE.ARRAY. |
prefixItems[] |
Opsional. Skema elemen awal Type.ARRAY. |
additionalProperties |
Opsional. Dapat berupa boolean atau objek, mengontrol keberadaan properti tambahan. |
anyOf[] |
Opsional. Nilai harus divalidasi terhadap salah satu (satu atau beberapa) subskema dalam daftar. |
enum[] |
Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. Kita dapat menentukan arah sebagai : {type:STRING, format:enum, enum:["TIMUR", "UTARA", "SELATAN", "BARAT"]} 2. Kita dapat menentukan nomor apartemen sebagai : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
Opsional. Nilai default data. |
ref |
Opsional. Memungkinkan referensi tidak langsung antar-node skema. Nilai harus berupa referensi yang valid ke turunan Misalnya, skema berikut menentukan referensi ke node skema bernama "Pet": Nilai properti "pet" adalah referensi ke node skema bernama "Pet". Lihat detailnya di https://json-schema.org/understanding-json-schema/structuring. |
defs |
Opsional. Peta definisi untuk digunakan oleh Objek yang berisi daftar pasangan |
title |
Opsional. Judul skema. |
minItems |
Opsional. Jumlah minimum elemen untuk Type.ARRAY. |
maxItems |
Opsional. Jumlah maksimum elemen untuk Type.ARRAY. |
Kolom union
|
|
minimum |
Opsional. Nilai minimum untuk Type.INTEGER dan Type.NUMBER. |
Kolom union
|
|
maximum |
Opsional. Nilai maksimum untuk Type.INTEGER dan Type.NUMBER. |
PropertiesEntry
| Representasi JSON |
|---|
{
"key": string,
"value": {
object ( |
| Kolom | |
|---|---|
key |
|
value |
|
Nilai
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union kind. Jenis nilai. kind hanya ada berupa salah satu diantara berikut: |
|
nullValue |
Mewakili nilai null. |
numberValue |
Mewakili nilai ganda. |
stringValue |
Mewakili nilai string. |
boolValue |
Mewakili nilai boolean. |
structValue |
Mewakili nilai terstruktur. |
listValue |
Merepresentasikan |
Struct
| Representasi JSON |
|---|
{ "fields": { string: value, ... } } |
| Kolom | |
|---|---|
fields |
Peta tidak berurutan dari nilai yang diketik secara dinamis. Objek yang berisi daftar pasangan |
FieldsEntry
| Representasi JSON |
|---|
{ "key": string, "value": value } |
| Kolom | |
|---|---|
key |
|
value |
|
ListValue
| Representasi JSON |
|---|
{ "values": [ value ] } |
| Kolom | |
|---|---|
values[] |
Kolom berulang dari nilai yang diketik secara dinamis. |
DefsEntry
| Representasi JSON |
|---|
{
"key": string,
"value": {
object ( |
| Kolom | |
|---|---|
key |
|
value |
|
OpenApiTool
| Representasi JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| Kolom | |
|---|---|
openApiSchema |
Wajib. Skema OpenAPI dalam format JSON atau YAML. |
name |
Opsional. Nama alat. Jika tidak diberikan, nama alat akan diambil dari skema OpenAPI, dari |
description |
Opsional. Deskripsi alat. Jika tidak diberikan, deskripsi alat akan berasal dari skema OpenAPI, dari |
apiAuthentication |
Opsional. Informasi autentikasi yang diperlukan oleh API. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang akan dipercayai klien. |
serviceDirectoryConfig |
Opsional. Konfigurasi Direktori Layanan. |
ignoreUnknownFields |
Opsional. Jika benar, agen akan mengabaikan kolom yang tidak diketahui dalam respons API. |
url |
Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di alat dalam dependensi lingkungan selama proses ekspor jika skema berisi URL server. Selama proses impor, jika URL ini ada dalam dependensi lingkungan dan skema memiliki placeholder $env_var, URL ini akan menggantikan placeholder dalam skema. |
ApiAuthentication
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut: |
|
apiKeyConfig |
Opsional. Konfigurasi untuk autentikasi kunci API. |
oauthConfig |
Opsional. Konfigurasi untuk OAuth. |
serviceAgentIdTokenAuthConfig |
Opsional. Konfigurasi untuk autentikasi token ID yang dibuat dari agen layanan CES. |
serviceAccountAuthConfig |
Opsional. Konfigurasi untuk autentikasi akun layanan. |
bearerTokenConfig |
Opsional. Konfigurasi untuk autentikasi token bearer. |
ApiKeyConfig
| Representasi JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| Kolom | |
|---|---|
keyName |
Wajib. Nama parameter atau nama header kunci API. Misalnya, Jika permintaan API adalah "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
Wajib. Nama resource versi secret SecretManager yang menyimpan kunci API. Format: Catatan: Anda harus memberikan peran |
requestLocation |
Wajib. Lokasi kunci dalam permintaan. |
OAuthConfig
| Representasi JSON |
|---|
{
"oauthGrantType": enum ( |
| Kolom | |
|---|---|
oauthGrantType |
Wajib. Jenis pemberian OAuth. |
clientId |
Wajib. Client ID dari penyedia OAuth. |
clientSecretVersion |
Wajib. Nama resource versi secret SecretManager yang menyimpan rahasia klien. Format: Catatan: Anda harus memberikan peran |
tokenEndpoint |
Wajib. Endpoint token di penyedia OAuth untuk ditukar dengan token akses. |
scopes[] |
Opsional. Cakupan OAuth yang akan diberikan. |
ServiceAccountAuthConfig
| Representasi JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| Kolom | |
|---|---|
serviceAccount |
Wajib. Alamat email akun layanan yang digunakan untuk autentikasi. CES menggunakan akun layanan ini untuk menukar token akses dan token akses tersebut kemudian dikirim di header Akun layanan harus memiliki peran |
scopes[] |
Opsional. Cakupan OAuth yang akan diberikan. Jika tidak ditentukan, cakupan default |
BearerTokenConfig
| Representasi JSON |
|---|
{ "token": string } |
| Kolom | |
|---|---|
token |
Wajib. Token pemilik. Harus dalam format |
TlsConfig
| Representasi JSON |
|---|
{
"caCerts": [
{
object ( |
| Kolom | |
|---|---|
caCerts[] |
Wajib. Menentukan daftar sertifikat CA kustom yang diizinkan untuk verifikasi HTTPS. |
CaCert
| Representasi JSON |
|---|
{ "displayName": string, "cert": string } |
| Kolom | |
|---|---|
displayName |
Wajib. Nama sertifikat CA kustom yang diizinkan. Ini dapat digunakan untuk membedakan sertifikat CA kustom. |
cert |
Wajib. Sertifikat CA kustom yang diizinkan (dalam format DER) untuk verifikasi HTTPS. Tindakan ini akan menggantikan trust store SSL default. Jika kosong atau tidak ditentukan, CES akan menggunakan penyimpanan tepercaya default Google untuk memverifikasi sertifikat. Catatan: Pastikan sertifikat server HTTPS ditandatangani dengan "subject alt name". Misalnya, sertifikat dapat ditandatangani sendiri menggunakan perintah berikut, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") String berenkode base64. |
ServiceDirectoryConfig
| Representasi JSON |
|---|
{ "service": string } |
| Kolom | |
|---|---|
service |
Wajib. Nama layanan Service Directory. Format: |
GoogleSearchTool
| Representasi JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat. |
description |
Opsional. Deskripsi tujuan alat. |
contextUrls[] |
Opsional. Konten akan diambil langsung dari URL ini untuk konteks dan perujukan. Contoh: "https://example.com/path.html". Maksimum 20 URL yang diizinkan. |
preferredDomains[] |
Opsional. Menentukan domain untuk membatasi hasil penelusuran. Contoh: "example.com", "another.site". Maksimum 20 domain dapat ditentukan. |
excludeDomains[] |
Opsional. Daftar domain yang akan dikecualikan dari hasil penelusuran. Contoh: "example.com". Maksimum 2.000 domain dapat dikecualikan. |
promptConfig |
Opsional. Petunjuk perintah yang diteruskan ke perencana tentang cara hasil penelusuran harus diproses untuk teks dan suara. |
PromptConfig
| Representasi JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| Kolom | |
|---|---|
textPrompt |
Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan chat. Jika tidak disetel, perintah default akan digunakan. |
voicePrompt |
Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan suara. Jika tidak disetel, perintah default akan digunakan. |
ConnectorTool
| Representasi JSON |
|---|
{ "connection": string, "action": { object ( |
| Kolom | |
|---|---|
connection |
Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: |
action |
Wajib. Tindakan yang akan digunakan alat. |
authConfig |
Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan ConnectorTool akan gagal. Lihat https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override untuk mengetahui detailnya. |
name |
Opsional. Nama alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak. |
description |
Opsional. Deskripsi alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak. |
Tindakan
| Representasi JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| Kolom | |
|---|---|
inputFields[] |
Opsional. Kolom entitas yang akan digunakan sebagai input untuk operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entitas akan digunakan. |
outputFields[] |
Opsional. Kolom entitas yang akan ditampilkan dari operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entity akan ditampilkan. |
Kolom union action_spec. Spesifikasi untuk tindakan yang akan dikonfigurasi agar dapat digunakan oleh alat. action_spec hanya ada berupa salah satu diantara berikut: |
|
connectionActionId |
ID tindakan Koneksi yang akan digunakan alat. |
entityOperation |
Konfigurasi operasi entitas yang akan digunakan alat. |
EntityOperation
| Representasi JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| Kolom | |
|---|---|
entityId |
Wajib. ID entitas. |
operation |
Wajib. Operasi yang akan dilakukan pada entity. |
EndUserAuthConfig
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut: |
|
oauth2AuthCodeConfig |
Autentikasi Kode Otorisasi Oauth 2.0. |
oauth2JwtBearerConfig |
Autentikasi pemberian otorisasi OAuth 2.0 Profil JWT. |
Oauth2AuthCodeConfig
| Representasi JSON |
|---|
{ "oauthToken": string } |
| Kolom | |
|---|---|
oauthToken |
Wajib. Nama parameter token OAuth yang akan diteruskan. Harus dalam format |
Oauth2JwtBearerConfig
| Representasi JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| Kolom | |
|---|---|
issuer |
Wajib. Nama parameter penerbit yang akan diteruskan. Harus dalam format |
subject |
Wajib. Nama parameter subjek yang akan diteruskan. Harus dalam format |
clientKey |
Wajib. Nama parameter klien yang akan diteruskan. Harus dalam format |
DataStoreTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat penyimpanan data. |
description |
Opsional. Deskripsi alat. |
boostSpecs[] |
Opsional. Spesifikasi penguatan untuk menguatkan dokumen tertentu. |
modalityConfigs[] |
Opsional. Konfigurasi modalitas untuk penyimpanan data. |
filterParameterBehavior |
Opsional. Perilaku parameter filter. |
Kolom union search_source. Menentukan sumber penelusuran, baik DataStore tunggal maupun Mesin Telusur. search_source hanya ada berupa salah satu diantara berikut: |
|
dataStoreSource |
Opsional. Menelusuri dalam satu DataStore tertentu. |
engineSource |
Opsional. Menelusuri dalam Engine (berpotensi di beberapa DataStore). |
DataStoreSource
| Representasi JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| Kolom | |
|---|---|
filter |
Opsional. Spesifikasi filter untuk DataStore. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
Opsional. Penyimpanan data. |
DataStore
| Representasi JSON |
|---|
{ "name": string, "type": enum ( |
| Kolom | |
|---|---|
name |
Wajib. Nama lengkap resource DataStore. Format: |
type |
Hanya output. Jenis penyimpanan data. Kolom ini bersifat hanya baca dan diisi oleh server. |
documentProcessingMode |
Hanya output. Mode pemrosesan dokumen untuk koneksi penyimpanan data. Hanya ditetapkan untuk penyimpanan data PUBLIC_WEB dan UNSTRUCTURED. |
displayName |
Hanya output. Nama tampilan penyimpanan data. |
createTime |
Hanya output. Stempel waktu saat penyimpanan 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: |
connectorConfig |
Hanya output. Konfigurasi konektor untuk koneksi penyimpanan data. |
Stempel waktu
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z). |
nanos |
Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nano non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif. |
ConnectorConfig
| Representasi JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| Kolom | |
|---|---|
collection |
Nama resource koleksi tempat penyimpanan data berada. |
collectionDisplayName |
Nama tampilan koleksi tempat penyimpanan data berada. |
dataSource |
Nama sumber data. Contoh: |
EngineSource
| Representasi JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| Kolom | |
|---|---|
engine |
Wajib. Nama lengkap resource Engine. Format: |
dataStoreSources[] |
Opsional. Digunakan untuk menargetkan DataStore tertentu dalam Engine. Jika kosong, penelusuran berlaku untuk semua DataStore yang terkait dengan Engine. |
filter |
Opsional. Filter yang diterapkan pada penelusuran di seluruh Mesin Telusur. Tidak relevan dan tidak digunakan jika 'data_store_sources' diberikan. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
BoostSpecs
| Representasi JSON |
|---|
{
"dataStores": [
string
],
"spec": [
{
object ( |
| Kolom | |
|---|---|
dataStores[] |
Wajib. Penyimpanan Data tempat konfigurasi peningkatan diterapkan. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Wajib. Daftar spesifikasi peningkat. |
BoostSpec
| Representasi JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| Kolom | |
|---|---|
conditionBoostSpecs[] |
Wajib. Daftar spesifikasi peningkat. |
ConditionBoostSpec
| Representasi JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| Kolom | |
|---|---|
condition |
Wajib. Ekspresi yang menentukan kondisi peninggian. Sintaksisnya sama dengan sintaksis ekspresi filter. Saat ini, satu-satunya kondisi yang didukung adalah daftar kode bahasa BCP-47. Contoh: Untuk meningkatkan saran dalam bahasa Inggris atau Prancis: (lang_code: ANY("en", "fr")) |
boost |
Opsional. Kekuatan peningkat, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan peringkat. Nilai defaultnya adalah 0.0. Menetapkan ke 1.0 akan memberikan promosi besar pada saran. Namun, hasil teratas tidak selalu merupakan saran yang dipromosikan. Menyetel ke -1,0 akan menurunkan saran secara signifikan. Namun, saran lain yang relevan mungkin masih ditampilkan. Menyetel ke 0,0 berarti tidak ada peningkatan yang diterapkan. Kondisi peningkatan diabaikan. |
boostControlSpec |
Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan. |
BoostControlSpec
| Representasi JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| Kolom | |
|---|---|
fieldName |
Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat. |
attributeType |
Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Untuk nilai numerik, caranya cukup mudah, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah. |
controlPoints[] |
Opsional. Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolation_type di atas) melewati titik kontrol yang tercantum di sini. |
ControlPoint
| Representasi JSON |
|---|
{ "attributeValue": string, "boostAmount": number } |
| Kolom | |
|---|---|
attributeValue |
Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD |
boostAmount |
Opsional. Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attribute_value dievaluasi ke nilai yang ditentukan di atas. |
ModalityConfig
| Representasi JSON |
|---|
{ "modalityType": enum ( |
| Kolom | |
|---|---|
modalityType |
Wajib. Jenis modalitas. |
rewriterConfig |
Opsional. Konfigurasi penulis ulang. |
summarizationConfig |
Opsional. Konfigurasi ringkasan. |
groundingConfig |
Opsional. Konfigurasi perujukan. |
RewriterConfig
| Representasi JSON |
|---|
{
"modelSettings": {
object ( |
| Kolom | |
|---|---|
modelSettings |
Wajib. Konfigurasi untuk model LLM. |
prompt |
Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan. |
disabled |
Opsional. Apakah penulis ulang dinonaktifkan. |
ModelSettings
| Representasi JSON |
|---|
{ "model": string, // Union field |
| Kolom | |
|---|---|
model |
Opsional. Model LLM yang harus digunakan agen. Jika tidak disetel, agen akan mewarisi model dari agen induknya. |
Kolom union
|
|
temperature |
Opsional. Jika disetel, suhu ini akan digunakan untuk model LLM. Temperatur mengontrol keacakan respons model. Temperatur yang lebih rendah menghasilkan respons yang lebih dapat diprediksi. Suhu yang lebih tinggi menghasilkan respons yang lebih kreatif. |
SummarizationConfig
| Representasi JSON |
|---|
{
"modelSettings": {
object ( |
| Kolom | |
|---|---|
modelSettings |
Opsional. Konfigurasi untuk model LLM. |
prompt |
Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan. |
disabled |
Opsional. Apakah ringkasan dinonaktifkan. |
GroundingConfig
| Representasi JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| Kolom | |
|---|---|
groundingLevel |
Opsional. Nilai minimum perujukan jawaban berdasarkan sumber yang diambil. Nilai memiliki rentang yang dapat dikonfigurasi [1, 5]. Tingkat ini digunakan untuk menentukan batas keterujukan jawaban, yang berarti bahwa semua respons dengan skor keterujukan di bawah batas akan kembali menampilkan hanya cuplikan yang relevan. Misalnya, tingkat 3 berarti skor perujukan harus 3 atau lebih tinggi agar respons ditampilkan. |
disabled |
Opsional. Apakah perujukan dinonaktifkan. |
PythonFunction
| Representasi JSON |
|---|
{ "name": string, "pythonCode": string, "description": string } |
| Kolom | |
|---|---|
name |
Opsional. Nama fungsi Python yang akan dijalankan. Harus cocok dengan nama fungsi Python yang ditentukan dalam kode python. Peka huruf besar/kecil. Jika nama tidak diberikan, fungsi pertama yang ditentukan dalam kode python akan digunakan. |
pythonCode |
Opsional. Kode Python yang akan dieksekusi untuk alat. |
description |
Hanya output. Deskripsi fungsi Python, di-parsing dari docstring kode python. |
McpTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "inputSchema": { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat MCP. |
description |
Opsional. Deskripsi alat MCP. |
inputSchema |
Opsional. Skema argumen input alat MCP. |
outputSchema |
Opsional. Skema argumen output alat MCP. |
serverAddress |
Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transport HTTP yang dapat di-streaming yang didukung. Ini sama dengan server_address di McpToolset. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya. |
apiAuthentication |
Opsional. Informasi autentikasi yang diperlukan untuk menjalankan alat terhadap server MCP. Untuk autentikasi token pembawa, token hanya berlaku untuk eksekusi alat, bukan untuk alat listingan. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien. |
serviceDirectoryConfig |
Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter. |
FileSearchTool
| Representasi JSON |
|---|
{
"corpusType": enum ( |
| Kolom | |
|---|---|
corpusType |
Opsional. Jenis korpus. Default-nya adalah FULLY_MANAGED. |
name |
Wajib. Nama alat. |
description |
Opsional. Deskripsi alat. |
fileCorpus |
Opsional. Korpus tempat file disimpan. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
SystemTool
| Representasi JSON |
|---|
{ "name": string, "description": string } |
| Kolom | |
|---|---|
name |
Wajib. Nama alat sistem. |
description |
Hanya output. Deskripsi alat sistem. |
WidgetTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| Kolom | |
|---|---|
name |
Wajib. Nama tampilan alat widget. |
description |
Opsional. Deskripsi alat widget. |
widgetType |
Opsional. Jenis alat widget. Jika tidak ditentukan, jenis defaultnya adalah CUSTOMIZED. |
Kolom union input. Input alat widget. input hanya ada berupa salah satu diantara berikut: |
|
parameters |
Opsional. Parameter input alat widget. |
ToolFakeConfig
| Representasi JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| Kolom | |
|---|---|
enableFakeMode |
Opsional. Apakah alat menggunakan mode palsu. |
Kolom union tool_response. Respons bersifat statis atau disediakan oleh fungsi python. tool_response hanya ada berupa salah satu diantara berikut: |
|
codeBlock |
Opsional. Blok kode yang akan dieksekusi, bukan panggilan alat yang sebenarnya. |
CodeBlock
| Representasi JSON |
|---|
{ "pythonCode": string } |
| Kolom | |
|---|---|
pythonCode |
Wajib. Kode Python yang akan dipanggil dalam mode palsu alat. Tanda tangan fungsi Python yang diharapkan - Untuk menangkap semua panggilan alat: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Untuk menangkap panggilan alat tertentu: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Jika fungsi menampilkan None, alat yang sebenarnya akan dipanggil. |
FieldMask
| Representasi JSON |
|---|
{ "paths": [ string ] } |
| Kolom | |
|---|---|
paths[] |
Kumpulan jalur mask kolom. |
Skema Output
Alat mewakili tindakan yang dapat dilakukan agen CES untuk mencapai tujuan tertentu.
Alat
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| Kolom | |
|---|---|
name |
ID. ID unik alat. Format: -
|
displayName |
Hanya output. Nama tampilan alat, yang berasal dari jenis alat. Misalnya, nama tampilan [ClientFunction][Tool.ClientFunction] berasal dari properti |
executionType |
Opsional. Jenis eksekusi alat. |
createTime |
Hanya output. Stempel waktu saat alat 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. Stempel waktu saat alat 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: |
etag |
ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak. |
generatedSummary |
Hanya output. Jika alat dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan tersebut. |
toolFakeConfig |
Opsional. Konfigurasi untuk perilaku alat dalam mode palsu. |
Kolom union tool_type. Jenis alat. tool_type hanya ada berupa salah satu diantara berikut: |
|
clientFunction |
Opsional. Fungsi klien. |
openApiTool |
Opsional. Alat API terbuka. |
googleSearchTool |
Opsional. Alat penelusuran google. |
connectorTool |
Opsional. Alat Integration Connector. |
dataStoreTool |
Opsional. Alat penyimpanan data. |
pythonFunction |
Opsional. Alat fungsi python. |
mcpTool |
Opsional. Alat MCP. Alat MCP tidak dapat dibuat atau diperbarui secara langsung dan dikelola oleh toolset MCP. |
fileSearchTool |
Opsional. Alat penelusuran file. |
systemTool |
Opsional. Alat sistem. |
widgetTool |
Opsional. Alat widget. |
ClientFunction
| Representasi JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama fungsi. |
description |
Opsional. Deskripsi fungsi. |
parameters |
Opsional. Skema parameter fungsi. |
response |
Opsional. Skema respons fungsi. |
Skema
| Representasi JSON |
|---|
{ "type": enum ( |
| Kolom | |
|---|---|
type |
Wajib. Jenis data. |
properties |
Opsional. Properti Type.OBJECT. Objek yang berisi daftar pasangan |
required[] |
Opsional. Properti wajib Type.OBJECT. |
description |
Opsional. Deskripsi data. |
items |
Opsional. Skema elemen Type.ARRAY. |
nullable |
Opsional. Menunjukkan apakah nilai boleh berupa null. |
uniqueItems |
Opsional. Menunjukkan bahwa item dalam array harus unik. Hanya berlaku untuk TYPE.ARRAY. |
prefixItems[] |
Opsional. Skema elemen awal Type.ARRAY. |
additionalProperties |
Opsional. Dapat berupa boolean atau objek, mengontrol keberadaan properti tambahan. |
anyOf[] |
Opsional. Nilai harus divalidasi terhadap salah satu (satu atau beberapa) subskema dalam daftar. |
enum[] |
Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. Kita dapat menentukan arah sebagai : {type:STRING, format:enum, enum:["TIMUR", "UTARA", "SELATAN", "BARAT"]} 2. Kita dapat menentukan nomor apartemen sebagai : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
Opsional. Nilai default data. |
ref |
Opsional. Memungkinkan referensi tidak langsung antar-node skema. Nilai harus berupa referensi yang valid ke turunan Misalnya, skema berikut menentukan referensi ke node skema bernama "Pet": Nilai properti "pet" adalah referensi ke node skema bernama "Pet". Lihat detailnya di https://json-schema.org/understanding-json-schema/structuring. |
defs |
Opsional. Peta definisi untuk digunakan oleh Objek yang berisi daftar pasangan |
title |
Opsional. Judul skema. |
minItems |
Opsional. Jumlah minimum elemen untuk Type.ARRAY. |
maxItems |
Opsional. Jumlah maksimum elemen untuk Type.ARRAY. |
Kolom union
|
|
minimum |
Opsional. Nilai minimum untuk Type.INTEGER dan Type.NUMBER. |
Kolom union
|
|
maximum |
Opsional. Nilai maksimum untuk Type.INTEGER dan Type.NUMBER. |
PropertiesEntry
| Representasi JSON |
|---|
{
"key": string,
"value": {
object ( |
| Kolom | |
|---|---|
key |
|
value |
|
Nilai
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union kind. Jenis nilai. kind hanya ada berupa salah satu diantara berikut: |
|
nullValue |
Mewakili nilai null. |
numberValue |
Mewakili nilai ganda. |
stringValue |
Mewakili nilai string. |
boolValue |
Mewakili nilai boolean. |
structValue |
Mewakili nilai terstruktur. |
listValue |
Merepresentasikan |
Struct
| Representasi JSON |
|---|
{ "fields": { string: value, ... } } |
| Kolom | |
|---|---|
fields |
Peta tidak berurutan dari nilai yang diketik secara dinamis. Objek yang berisi daftar pasangan |
FieldsEntry
| Representasi JSON |
|---|
{ "key": string, "value": value } |
| Kolom | |
|---|---|
key |
|
value |
|
ListValue
| Representasi JSON |
|---|
{ "values": [ value ] } |
| Kolom | |
|---|---|
values[] |
Kolom berulang dari nilai yang diketik secara dinamis. |
DefsEntry
| Representasi JSON |
|---|
{
"key": string,
"value": {
object ( |
| Kolom | |
|---|---|
key |
|
value |
|
OpenApiTool
| Representasi JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| Kolom | |
|---|---|
openApiSchema |
Wajib. Skema OpenAPI dalam format JSON atau YAML. |
name |
Opsional. Nama alat. Jika tidak diberikan, nama alat akan diambil dari skema OpenAPI, dari |
description |
Opsional. Deskripsi alat. Jika tidak diberikan, deskripsi alat akan berasal dari skema OpenAPI, dari |
apiAuthentication |
Opsional. Informasi autentikasi yang diperlukan oleh API. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang akan dipercayai klien. |
serviceDirectoryConfig |
Opsional. Konfigurasi Direktori Layanan. |
ignoreUnknownFields |
Opsional. Jika benar, agen akan mengabaikan kolom yang tidak diketahui dalam respons API. |
url |
Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di alat dalam dependensi lingkungan selama proses ekspor jika skema berisi URL server. Selama proses impor, jika URL ini ada dalam dependensi lingkungan dan skema memiliki placeholder $env_var, URL ini akan menggantikan placeholder dalam skema. |
ApiAuthentication
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut: |
|
apiKeyConfig |
Opsional. Konfigurasi untuk autentikasi kunci API. |
oauthConfig |
Opsional. Konfigurasi untuk OAuth. |
serviceAgentIdTokenAuthConfig |
Opsional. Konfigurasi untuk autentikasi token ID yang dibuat dari agen layanan CES. |
serviceAccountAuthConfig |
Opsional. Konfigurasi untuk autentikasi akun layanan. |
bearerTokenConfig |
Opsional. Konfigurasi untuk autentikasi token bearer. |
ApiKeyConfig
| Representasi JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| Kolom | |
|---|---|
keyName |
Wajib. Nama parameter atau nama header kunci API. Misalnya, Jika permintaan API adalah "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
Wajib. Nama resource versi secret SecretManager yang menyimpan kunci API. Format: Catatan: Anda harus memberikan peran |
requestLocation |
Wajib. Lokasi kunci dalam permintaan. |
OAuthConfig
| Representasi JSON |
|---|
{
"oauthGrantType": enum ( |
| Kolom | |
|---|---|
oauthGrantType |
Wajib. Jenis pemberian OAuth. |
clientId |
Wajib. Client ID dari penyedia OAuth. |
clientSecretVersion |
Wajib. Nama resource versi secret SecretManager yang menyimpan rahasia klien. Format: Catatan: Anda harus memberikan peran |
tokenEndpoint |
Wajib. Endpoint token di penyedia OAuth untuk ditukar dengan token akses. |
scopes[] |
Opsional. Cakupan OAuth yang akan diberikan. |
ServiceAccountAuthConfig
| Representasi JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| Kolom | |
|---|---|
serviceAccount |
Wajib. Alamat email akun layanan yang digunakan untuk autentikasi. CES menggunakan akun layanan ini untuk menukar token akses dan token akses tersebut kemudian dikirim di header Akun layanan harus memiliki peran |
scopes[] |
Opsional. Cakupan OAuth yang akan diberikan. Jika tidak ditentukan, cakupan default |
BearerTokenConfig
| Representasi JSON |
|---|
{ "token": string } |
| Kolom | |
|---|---|
token |
Wajib. Token pemilik. Harus dalam format |
TlsConfig
| Representasi JSON |
|---|
{
"caCerts": [
{
object ( |
| Kolom | |
|---|---|
caCerts[] |
Wajib. Menentukan daftar sertifikat CA kustom yang diizinkan untuk verifikasi HTTPS. |
CaCert
| Representasi JSON |
|---|
{ "displayName": string, "cert": string } |
| Kolom | |
|---|---|
displayName |
Wajib. Nama sertifikat CA kustom yang diizinkan. Ini dapat digunakan untuk membedakan sertifikat CA kustom. |
cert |
Wajib. Sertifikat CA kustom yang diizinkan (dalam format DER) untuk verifikasi HTTPS. Tindakan ini akan menggantikan trust store SSL default. Jika kosong atau tidak ditentukan, CES akan menggunakan penyimpanan tepercaya default Google untuk memverifikasi sertifikat. Catatan: Pastikan sertifikat server HTTPS ditandatangani dengan "subject alt name". Misalnya, sertifikat dapat ditandatangani sendiri menggunakan perintah berikut, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") String berenkode base64. |
ServiceDirectoryConfig
| Representasi JSON |
|---|
{ "service": string } |
| Kolom | |
|---|---|
service |
Wajib. Nama layanan Service Directory. Format: |
GoogleSearchTool
| Representasi JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat. |
description |
Opsional. Deskripsi tujuan alat. |
contextUrls[] |
Opsional. Konten akan diambil langsung dari URL ini untuk konteks dan perujukan. Contoh: "https://example.com/path.html". Maksimum 20 URL yang diizinkan. |
preferredDomains[] |
Opsional. Menentukan domain untuk membatasi hasil penelusuran. Contoh: "example.com", "another.site". Maksimum 20 domain dapat ditentukan. |
excludeDomains[] |
Opsional. Daftar domain yang akan dikecualikan dari hasil penelusuran. Contoh: "example.com". Maksimum 2.000 domain dapat dikecualikan. |
promptConfig |
Opsional. Petunjuk perintah yang diteruskan ke perencana tentang cara hasil penelusuran harus diproses untuk teks dan suara. |
PromptConfig
| Representasi JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| Kolom | |
|---|---|
textPrompt |
Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan chat. Jika tidak disetel, perintah default akan digunakan. |
voicePrompt |
Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan suara. Jika tidak disetel, perintah default akan digunakan. |
ConnectorTool
| Representasi JSON |
|---|
{ "connection": string, "action": { object ( |
| Kolom | |
|---|---|
connection |
Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: |
action |
Wajib. Tindakan yang akan digunakan alat. |
authConfig |
Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan ConnectorTool akan gagal. Lihat https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override untuk mengetahui detailnya. |
name |
Opsional. Nama alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak. |
description |
Opsional. Deskripsi alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak. |
Tindakan
| Representasi JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| Kolom | |
|---|---|
inputFields[] |
Opsional. Kolom entitas yang akan digunakan sebagai input untuk operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entitas akan digunakan. |
outputFields[] |
Opsional. Kolom entitas yang akan ditampilkan dari operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entity akan ditampilkan. |
Kolom union action_spec. Spesifikasi untuk tindakan yang akan dikonfigurasi agar dapat digunakan oleh alat. action_spec hanya ada berupa salah satu diantara berikut: |
|
connectionActionId |
ID tindakan Koneksi yang akan digunakan alat. |
entityOperation |
Konfigurasi operasi entitas yang akan digunakan alat. |
EntityOperation
| Representasi JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| Kolom | |
|---|---|
entityId |
Wajib. ID entitas. |
operation |
Wajib. Operasi yang akan dilakukan pada entity. |
EndUserAuthConfig
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut: |
|
oauth2AuthCodeConfig |
Autentikasi Kode Otorisasi Oauth 2.0. |
oauth2JwtBearerConfig |
Autentikasi pemberian otorisasi OAuth 2.0 Profil JWT. |
Oauth2AuthCodeConfig
| Representasi JSON |
|---|
{ "oauthToken": string } |
| Kolom | |
|---|---|
oauthToken |
Wajib. Nama parameter token OAuth yang akan diteruskan. Harus dalam format |
Oauth2JwtBearerConfig
| Representasi JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| Kolom | |
|---|---|
issuer |
Wajib. Nama parameter penerbit yang akan diteruskan. Harus dalam format |
subject |
Wajib. Nama parameter subjek yang akan diteruskan. Harus dalam format |
clientKey |
Wajib. Nama parameter klien yang akan diteruskan. Harus dalam format |
DataStoreTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat penyimpanan data. |
description |
Opsional. Deskripsi alat. |
boostSpecs[] |
Opsional. Spesifikasi penguatan untuk menguatkan dokumen tertentu. |
modalityConfigs[] |
Opsional. Konfigurasi modalitas untuk penyimpanan data. |
filterParameterBehavior |
Opsional. Perilaku parameter filter. |
Kolom union search_source. Menentukan sumber penelusuran, baik DataStore tunggal maupun Mesin Telusur. search_source hanya ada berupa salah satu diantara berikut: |
|
dataStoreSource |
Opsional. Menelusuri dalam satu DataStore tertentu. |
engineSource |
Opsional. Menelusuri dalam Engine (berpotensi di beberapa DataStore). |
DataStoreSource
| Representasi JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| Kolom | |
|---|---|
filter |
Opsional. Spesifikasi filter untuk DataStore. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
Opsional. Penyimpanan data. |
DataStore
| Representasi JSON |
|---|
{ "name": string, "type": enum ( |
| Kolom | |
|---|---|
name |
Wajib. Nama lengkap resource DataStore. Format: |
type |
Hanya output. Jenis penyimpanan data. Kolom ini bersifat hanya baca dan diisi oleh server. |
documentProcessingMode |
Hanya output. Mode pemrosesan dokumen untuk koneksi penyimpanan data. Hanya ditetapkan untuk penyimpanan data PUBLIC_WEB dan UNSTRUCTURED. |
displayName |
Hanya output. Nama tampilan penyimpanan data. |
createTime |
Hanya output. Stempel waktu saat penyimpanan 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: |
connectorConfig |
Hanya output. Konfigurasi konektor untuk koneksi penyimpanan data. |
Stempel waktu
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z). |
nanos |
Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nano non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif. |
ConnectorConfig
| Representasi JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| Kolom | |
|---|---|
collection |
Nama resource koleksi tempat penyimpanan data berada. |
collectionDisplayName |
Nama tampilan koleksi tempat penyimpanan data berada. |
dataSource |
Nama sumber data. Contoh: |
EngineSource
| Representasi JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| Kolom | |
|---|---|
engine |
Wajib. Nama lengkap resource Engine. Format: |
dataStoreSources[] |
Opsional. Digunakan untuk menargetkan DataStore tertentu dalam Engine. Jika kosong, penelusuran berlaku untuk semua DataStore yang terkait dengan Engine. |
filter |
Opsional. Filter yang diterapkan pada penelusuran di seluruh Mesin Telusur. Tidak relevan dan tidak digunakan jika 'data_store_sources' diberikan. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
BoostSpecs
| Representasi JSON |
|---|
{
"dataStores": [
string
],
"spec": [
{
object ( |
| Kolom | |
|---|---|
dataStores[] |
Wajib. Penyimpanan Data tempat konfigurasi peningkatan diterapkan. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Wajib. Daftar spesifikasi peningkat. |
BoostSpec
| Representasi JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| Kolom | |
|---|---|
conditionBoostSpecs[] |
Wajib. Daftar spesifikasi peningkat. |
ConditionBoostSpec
| Representasi JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| Kolom | |
|---|---|
condition |
Wajib. Ekspresi yang menentukan kondisi peninggian. Sintaksisnya sama dengan sintaksis ekspresi filter. Saat ini, satu-satunya kondisi yang didukung adalah daftar kode bahasa BCP-47. Contoh: Untuk meningkatkan saran dalam bahasa Inggris atau Prancis: (lang_code: ANY("en", "fr")) |
boost |
Opsional. Kekuatan peningkat, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan peringkat. Nilai defaultnya adalah 0.0. Menetapkan ke 1.0 akan memberikan promosi besar pada saran. Namun, hasil teratas tidak selalu merupakan saran yang dipromosikan. Menyetel ke -1,0 akan menurunkan saran secara signifikan. Namun, saran lain yang relevan mungkin masih ditampilkan. Menyetel ke 0,0 berarti tidak ada peningkatan yang diterapkan. Kondisi peningkatan diabaikan. |
boostControlSpec |
Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan. |
BoostControlSpec
| Representasi JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| Kolom | |
|---|---|
fieldName |
Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat. |
attributeType |
Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Untuk nilai numerik, caranya cukup mudah, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah. |
controlPoints[] |
Opsional. Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolation_type di atas) melewati titik kontrol yang tercantum di sini. |
ControlPoint
| Representasi JSON |
|---|
{ "attributeValue": string, "boostAmount": number } |
| Kolom | |
|---|---|
attributeValue |
Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD |
boostAmount |
Opsional. Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attribute_value dievaluasi ke nilai yang ditentukan di atas. |
ModalityConfig
| Representasi JSON |
|---|
{ "modalityType": enum ( |
| Kolom | |
|---|---|
modalityType |
Wajib. Jenis modalitas. |
rewriterConfig |
Opsional. Konfigurasi penulis ulang. |
summarizationConfig |
Opsional. Konfigurasi ringkasan. |
groundingConfig |
Opsional. Konfigurasi perujukan. |
RewriterConfig
| Representasi JSON |
|---|
{
"modelSettings": {
object ( |
| Kolom | |
|---|---|
modelSettings |
Wajib. Konfigurasi untuk model LLM. |
prompt |
Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan. |
disabled |
Opsional. Apakah penulis ulang dinonaktifkan. |
ModelSettings
| Representasi JSON |
|---|
{ "model": string, // Union field |
| Kolom | |
|---|---|
model |
Opsional. Model LLM yang harus digunakan agen. Jika tidak disetel, agen akan mewarisi model dari agen induknya. |
Kolom union
|
|
temperature |
Opsional. Jika disetel, suhu ini akan digunakan untuk model LLM. Temperatur mengontrol keacakan respons model. Temperatur yang lebih rendah menghasilkan respons yang lebih dapat diprediksi. Suhu yang lebih tinggi menghasilkan respons yang lebih kreatif. |
SummarizationConfig
| Representasi JSON |
|---|
{
"modelSettings": {
object ( |
| Kolom | |
|---|---|
modelSettings |
Opsional. Konfigurasi untuk model LLM. |
prompt |
Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan. |
disabled |
Opsional. Apakah ringkasan dinonaktifkan. |
GroundingConfig
| Representasi JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| Kolom | |
|---|---|
groundingLevel |
Opsional. Nilai minimum perujukan jawaban berdasarkan sumber yang diambil. Nilai memiliki rentang yang dapat dikonfigurasi [1, 5]. Tingkat ini digunakan untuk menentukan batas keterujukan jawaban, yang berarti bahwa semua respons dengan skor keterujukan di bawah batas akan kembali menampilkan hanya cuplikan yang relevan. Misalnya, tingkat 3 berarti skor perujukan harus 3 atau lebih tinggi agar respons ditampilkan. |
disabled |
Opsional. Apakah perujukan dinonaktifkan. |
PythonFunction
| Representasi JSON |
|---|
{ "name": string, "pythonCode": string, "description": string } |
| Kolom | |
|---|---|
name |
Opsional. Nama fungsi Python yang akan dijalankan. Harus cocok dengan nama fungsi Python yang ditentukan dalam kode python. Peka huruf besar/kecil. Jika nama tidak diberikan, fungsi pertama yang ditentukan dalam kode python akan digunakan. |
pythonCode |
Opsional. Kode Python yang akan dieksekusi untuk alat. |
description |
Hanya output. Deskripsi fungsi Python, di-parsing dari docstring kode python. |
McpTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "inputSchema": { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat MCP. |
description |
Opsional. Deskripsi alat MCP. |
inputSchema |
Opsional. Skema argumen input alat MCP. |
outputSchema |
Opsional. Skema argumen output alat MCP. |
serverAddress |
Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transport HTTP yang dapat di-streaming yang didukung. Ini sama dengan server_address di McpToolset. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya. |
apiAuthentication |
Opsional. Informasi autentikasi yang diperlukan untuk menjalankan alat terhadap server MCP. Untuk autentikasi token pembawa, token hanya berlaku untuk eksekusi alat, bukan untuk alat listingan. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien. |
serviceDirectoryConfig |
Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter. |
FileSearchTool
| Representasi JSON |
|---|
{
"corpusType": enum ( |
| Kolom | |
|---|---|
corpusType |
Opsional. Jenis korpus. Default-nya adalah FULLY_MANAGED. |
name |
Wajib. Nama alat. |
description |
Opsional. Deskripsi alat. |
fileCorpus |
Opsional. Korpus tempat file disimpan. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
SystemTool
| Representasi JSON |
|---|
{ "name": string, "description": string } |
| Kolom | |
|---|---|
name |
Wajib. Nama alat sistem. |
description |
Hanya output. Deskripsi alat sistem. |
WidgetTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| Kolom | |
|---|---|
name |
Wajib. Nama tampilan alat widget. |
description |
Opsional. Deskripsi alat widget. |
widgetType |
Opsional. Jenis alat widget. Jika tidak ditentukan, jenis defaultnya adalah CUSTOMIZED. |
Kolom union input. Input alat widget. input hanya ada berupa salah satu diantara berikut: |
|
parameters |
Opsional. Parameter input alat widget. |
ToolFakeConfig
| Representasi JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| Kolom | |
|---|---|
enableFakeMode |
Opsional. Apakah alat menggunakan mode palsu. |
Kolom union tool_response. Respons bersifat statis atau disediakan oleh fungsi python. tool_response hanya ada berupa salah satu diantara berikut: |
|
codeBlock |
Opsional. Blok kode yang akan dieksekusi, bukan panggilan alat yang sebenarnya. |
CodeBlock
| Representasi JSON |
|---|
{ "pythonCode": string } |
| Kolom | |
|---|---|
pythonCode |
Wajib. Kode Python yang akan dipanggil dalam mode palsu alat. Tanda tangan fungsi Python yang diharapkan - Untuk menangkap semua panggilan alat: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Untuk menangkap panggilan alat tertentu: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Jika fungsi menampilkan None, alat yang sebenarnya akan dipanggil. |
Anotasi Alat
Petunjuk Destruktif: ✅ | Petunjuk Idempoten: ❌ | Petunjuk Hanya Baca: ❌ | Petunjuk Dunia Terbuka: ❌