MCP Tools Reference: ces.googleapis.com

Alat: create_app_version

Membuat versi aplikasi baru di aplikasi yang diberikan.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP create_app_version.

Permintaan Curl 
curl --location 'https://ces.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "create_app_version",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Skema Input

Pesan permintaan untuk AgentService.CreateAppVersion

CreateAppVersionRequest

Representasi JSON 
{
  "parent": string,
  "appVersionId": string,
  "appVersion": {
    object (AppVersion)
  }
}
Kolom
parent

string

Wajib. Nama resource aplikasi untuk membuat versi aplikasi.
appVersionId

string

Opsional. ID yang akan digunakan untuk versi aplikasi, yang akan menjadi komponen akhir nama resource versi aplikasi. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk versi aplikasi.
appVersion

object (AppVersion)

Wajib. Versi aplikasi yang akan dibuat.

AppVersion

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "snapshot": {
    object (AppSnapshot)
  },
  "etag": string
}
Kolom
name

string

ID. ID unik versi aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
displayName

string

Opsional. Nama tampilan versi aplikasi.
description

string

Opsional. Deskripsi versi aplikasi.
creator

string

Hanya output. Email pengguna yang membuat versi aplikasi.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat versi aplikasi 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
snapshot

object (AppSnapshot)

Hanya output. Snapshot aplikasi saat versi dibuat.
etag

string

Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

Stempel waktu

Representasi JSON 
{
  "seconds": string,
  "nanos": integer
}
Kolom
seconds

string (int64 format)

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

integer

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 nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif.

AppSnapshot

Representasi JSON 
{
  "app": {
    object (App)
  },
  "agents": [
    {
      object (Agent)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "examples": [
    {
      object (Example)
    }
  ],
  "guardrails": [
    {
      object (Guardrail)
    }
  ],
  "toolsets": [
    {
      object (Toolset)
    }
  ]
}
Kolom
app

object (App)

Opsional. Setelan dasar untuk aplikasi.
agents[]

object (Agent)

Opsional. Daftar agen di aplikasi.
tools[]

object (Tool)

Opsional. Daftar alat di aplikasi.
examples[]

object (Example)

Opsional. Daftar contoh dalam aplikasi.
guardrails[]

object (Guardrail)

Opsional. Daftar pembatasan dalam aplikasi.
toolsets[]

object (Toolset)

Opsional. Daftar toolset di aplikasi.

Aplikasi

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
Kolom
name

string

ID. ID unik aplikasi. Format: projects/{project}/locations/{location}/apps/{app}
displayName

string

Wajib. Nama tampilan aplikasi.
description

string

Opsional. Deskripsi aplikasi yang dapat dibaca manusia.
pinned

boolean

Opsional. Apakah aplikasi disematkan dalam daftar aplikasi.
rootAgent

string

Opsional. Agen root adalah titik entri aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Opsional. Setelan bahasa aplikasi.
timeZoneSettings

object (TimeZoneSettings)

Opsional. Setelan TimeZone aplikasi.
audioProcessingConfig

object (AudioProcessingConfig)

Opsional. Konfigurasi pemrosesan audio aplikasi.
loggingSettings

object (LoggingSettings)

Opsional. Setelan pencatatan log aplikasi.
errorHandlingSettings

object (ErrorHandlingSettings)

Opsional. Menangani error setelan aplikasi.
modelSettings

object (ModelSettings)

Opsional. Setelan model LLM default untuk aplikasi. Setiap resource (misalnya, agen, pembatas) dapat mengganti konfigurasi ini sesuai kebutuhan.
toolExecutionMode

enum (ToolExecutionMode)

Opsional. Mode eksekusi alat untuk aplikasi. Jika tidak diberikan, defaultnya adalah PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Opsional. Batas evaluasi untuk aplikasi.
variableDeclarations[]

object (VariableDeclaration)

Opsional. Deklarasi variabel.
predefinedVariableDeclarations[]

object (VariableDeclaration)

Hanya output. Deklarasi variabel yang telah ditentukan sebelumnya untuk aplikasi.
globalInstruction

string

Opsional. Petunjuk untuk semua agen di aplikasi. Anda dapat menggunakan petunjuk ini untuk menyiapkan identitas atau kepribadian yang stabil di semua agen.
guardrails[]

string

Opsional. Daftar pembatasan untuk aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Opsional. Setelan penyimpanan data untuk aplikasi.
defaultChannelProfile

object (ChannelProfile)

Opsional. Profil saluran default yang digunakan oleh aplikasi.
metadata

map (key: string, value: string)

Opsional. Metadata tentang aplikasi. Kolom ini dapat digunakan untuk menyimpan informasi tambahan yang relevan dengan detail atau penggunaan yang dimaksudkan dari aplikasi.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat aplikasi 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: "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. Stempel waktu saat aplikasi 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
deploymentCount

integer

Hanya output. Jumlah deployment di aplikasi.
clientCertificateSettings

object (ClientCertificateSettings)

Opsional. Setelan sertifikat klien default untuk aplikasi.
vpcScSettings

object (VpcScSettings)

Opsional. Setelan VPC-SC untuk aplikasi.
locked

boolean

Opsional. Menunjukkan apakah aplikasi dikunci untuk perubahan. Jika aplikasi dikunci, modifikasi pada resource aplikasi akan ditolak.
validationErrors[]

string

Hanya output. Kesalahan konfigurasi atau peringatan di aplikasi.
dashboardSettings

object (DashboardSettings)

Opsional. Setelan dasbor khusus aplikasi untuk menautkan dan mengonfigurasi dasbor Contact Center Insights.

LanguageSettings

Representasi JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Kolom
defaultLanguageCode

string

Opsional. Kode bahasa default aplikasi.
supportedLanguageCodes[]

string

Opsional. Daftar kode bahasa yang didukung oleh aplikasi, selain default_language_code.
enableMultilingualSupport

boolean

Opsional. Mengaktifkan dukungan multibahasa. Jika benar (true), agen di aplikasi akan menggunakan petunjuk bawaan untuk meningkatkan penanganan input multibahasa.
fallbackAction
(deprecated)

string

Opsional. Tidak digunakan lagi: Fitur ini tidak lagi didukung. Gunakan enable_multilingual_support sebagai gantinya untuk meningkatkan penanganan input multibahasa. Tindakan yang harus dilakukan saat agen menerima input dalam bahasa yang tidak didukung.

Tindakan ini dapat berupa tindakan standar atau panggilan alat kustom. Nilai yang valid adalah: - Nama lengkap resource alat, yang memicu eksekusi alat tertentu. - Tindakan sistem yang telah ditentukan sebelumnya, seperti "eskalasikan" atau "keluar", yang memicu sinyal EndSession dengan metadata yang sesuai untuk mengakhiri percakapan.

TimeZoneSettings

Representasi JSON 
{
  "timeZone": string
}
Kolom
timeZone

string

Opsional. Zona waktu aplikasi dari database zona waktu, misalnya, America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Representasi JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  }
}
Kolom
synthesizeSpeechConfigs

map (key: string, value: object (SynthesizeSpeechConfig))

Opsional. Konfigurasi cara respons agen harus disintesis, pemetaan dari kode bahasa ke SynthesizeSpeechConfig.

Jika konfigurasi untuk kode bahasa yang ditentukan tidak ditemukan, konfigurasi untuk kode bahasa root akan digunakan. Misalnya, jika peta berisi "en-us" dan "en", dan kode bahasa yang ditentukan adalah "en-gb", maka konfigurasi "en" akan digunakan.

Catatan: Kode bahasa tidak peka huruf besar/kecil.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Opsional. Mengonfigurasi perilaku agen untuk aktivitas interupsi pengguna.
inactivityTimeout

string (Duration format)

Opsional. Durasi tidak aktif pengguna (tidak ada ucapan atau interaksi) sebelum agen meminta pengguna untuk berinteraksi kembali. Jika tidak disetel, agen tidak akan meminta pengguna untuk berinteraksi kembali.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Opsional. Konfigurasi untuk suara sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan.

SynthesizeSpeechConfigsEntry

Representasi JSON 
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
Kolom
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Representasi JSON 
{
  "voice": string,
  "voiceSampleGcsUri": string,
  "speakingRate": number,
  "model": string,
  "instruction": string,
  "consentAudioGcsUri": string
}
Kolom
voice

string

Opsional. Nama suara. Jika tidak disetel, layanan akan memilih suara berdasarkan parameter lain seperti language_code.

Untuk mengetahui daftar suara yang tersedia, lihat Suara dan bahasa yang didukung dari Cloud Text-to-Speech.
voiceSampleGcsUri
(deprecated)

string

Opsional. Tidak digunakan lagi: Gunakan custom_voice_samples di AudioProcessingConfig sebagai gantinya.

Cloud Storage URI ke sampel audio untuk kloning suara. Contoh audio harus berupa file WAV 24 kHz satu saluran.

Catatan: Pastikan agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com memiliki izin storage.objects.get ke objek Cloud Storage.
speakingRate

number

Opsional. Kecepatan bicara dalam rentang [0,25, 2,0]. 1,0 adalah kecepatan native normal yang didukung oleh suara tertentu. 2,0 adalah dua kali lebih cepat, dan 0,5 adalah setengahnya. Nilai di luar rentang [0,25, 2,0] akan menampilkan error.
model

string

Opsional. Model yang digunakan untuk menyintesis audio. Nilai yang saat ini didukung: - "gemini-3.1-flash-tts-preview" Jika kosong, Chirp3-HD akan digunakan.
instruction

string

Opsional. Petunjuk yang digunakan untuk menyintesis ucapan saat menggunakan model generatif.
consentAudioGcsUri
(deprecated)

string

Opsional. Tidak digunakan lagi: Gunakan custom_voice_samples di AudioProcessingConfig sebagai gantinya.

Cloud Storage URI untuk audio izin bagi kloning suara.

BargeInConfig

Representasi JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Kolom
disableBargeIn
(deprecated)

boolean

Opsional. Tidak digunakan lagi: disable_barge_in tidak digunakan lagi dan digantikan dengan disable_barge_in_control di ChannelProfile.

Menonaktifkan interupsi pengguna saat agen sedang berbicara. Jika benar (true), input pengguna selama pemutaran respons agen akan diabaikan.
bargeInAwareness

boolean

Opsional. Jika diaktifkan, agen akan menyesuaikan respons berikutnya berdasarkan asumsi bahwa pengguna belum mendengar pesan agen sebelumnya secara keseluruhan. Hal ini tidak boleh digunakan dalam skenario saat respons agen ditampilkan secara visual.

Durasi

Representasi JSON 
{
  "seconds": string,
  "nanos": integer
}
Kolom
seconds

string (int64 format)

Detik yang ditandatangani dari rentang waktu. Harus dari -315.576.000.000 hingga +315.576.000.000 inklusif. Catatan: batas ini dihitung dari: 60 dtk/mnt * 60 mnt/j * 24 j/hr * 365,25 hr/thn * 10.000 thn
nanos

integer

Pecahan detik bertanda pada resolusi nanodetik rentang waktu. Durasi kurang dari satu detik ditampilkan dengan kolom seconds 0 dan kolom nanos positif atau negatif. Untuk durasi satu detik atau lebih, nilai non-nol untuk kolom nanos harus memiliki tanda yang sama dengan kolom seconds. Harus dari -999.999.999 hingga +999.999.999 inklusif.

AmbientSoundConfig

Representasi JSON 
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
Kolom
volumeGainDb

number

Opsional. Peningkatan volume (dalam dB) volume native normal yang didukung oleh suara bising di sekitar, dalam rentang [-96,0, 16,0]. Jika tidak disetel, atau disetel ke nilai 0,0 (dB), akan diputar pada amplitudo sinyal native normal. Nilai -6,0 (dB) akan diputar dengan sekitar setengah amplitudo sinyal native normal. Nilai +6,0 (dB) akan diputar dengan amplitudo sinyal native normal sekitar dua kali lipat. Sebaiknya jangan melebihi +10 (dB) karena biasanya tidak ada peningkatan efektif dalam kenyaringan untuk nilai yang lebih besar dari itu.
Kolom union source. Suara bising di sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan. source hanya ada berupa salah satu diantara berikut:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

Opsional. Tidak digunakan lagi: prebuilt_ambient_noise tidak digunakan lagi dan digantikan dengan prebuilt_ambient_sound.
gcsUri

string

Opsional. Suara bising di sekitar sebagai file WAV 16 kHz satu saluran yang disimpan di Cloud Storage.

Catatan: Pastikan agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com memiliki izin storage.objects.get ke objek Cloud Storage.
prebuiltAmbientSound

string

Opsional. Nama suara sekitar bawaan. Nilai yang valid adalah: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

LoggingSettings

Representasi JSON 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "unredactedAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "unredactedBigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
Kolom
redactionConfig

object (RedactionConfig)

Opsional. Konfigurasi cara data sensitif harus disamarkan.
audioRecordingConfig

object (AudioRecordingConfig)

Opsional. Konfigurasi cara interaksi audio harus direkam. Audio dapat disamarkan sesuai konfigurasi di RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Opsional. Mengonfigurasi rekaman tambahan audio yang tidak disamarkan. Salinan ini dapat digunakan untuk mempertahankan salinan audio mentah saat penyensoran audio adalah enabled, biasanya untuk tujuan audit atau pemantauan.
bigqueryExportSettings

object (BigQueryExportSettings)

Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan tunduk pada penyamaran seperti yang dikonfigurasi di RedactionConfig.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan yang tidak disamarkan akan diekspor ke tabel BigQuery jika diaktifkan.
cloudLoggingSettings

object (CloudLoggingSettings)

Opsional. Setelan untuk menjelaskan perilaku Cloud Logging untuk aplikasi.
conversationLoggingSettings

object (ConversationLoggingSettings)

Opsional. Setelan untuk menjelaskan perilaku logging percakapan untuk aplikasi.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Opsional. Konfigurasi cara interaksi audio harus direkam untuk evaluasi. Secara default, perekaman audio tidak diaktifkan untuk sesi evaluasi.
metricAnalysisSettings

object (MetricAnalysisSettings)

Opsional. Setelan untuk menjelaskan perilaku pengumpulan data percakapan untuk pipeline analisis LLM untuk aplikasi.

RedactionConfig

Representasi JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Kolom
enableRedaction

boolean

Opsional. Jika benar (true), penyamaran akan diterapkan dalam berbagai skenario logging, termasuk histori percakapan, Cloud Logging, dan rekaman audio.
inspectTemplate

string

Opsional. Nama template inspeksi DLP untuk mengonfigurasi deteksi jenis data sensitif.

Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate

string

Opsional. Nama template de-identifikasi DLP untuk memberikan petunjuk tentang cara melakukan de-identifikasi konten.

Format: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

Representasi JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Kolom
gcsBucket

string

Opsional. Bucket Cloud Storage untuk menyimpan rekaman audio sesi. URI harus diawali dengan "gs://".

Pilih lokasi bucket yang memenuhi persyaratan residensi data Anda.

Catatan: Jika bucket Cloud Storage berada di project yang berbeda dari aplikasi, Anda harus memberikan izin storage.objects.create ke agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Opsional. Awalan jalur Cloud Storage untuk rekaman audio.

Awalan ini dapat menyertakan placeholder berikut, yang akan diganti secara dinamis pada waktu penayangan: - $project: project ID - $location: lokasi aplikasi - $app: ID aplikasi - $date: tanggal sesi dalam format YYYY-MM-DD - $session: ID sesi

Jika awalan jalur tidak ditentukan, awalan default $project/$location/$app/$date/$session/ akan digunakan.

BigQueryExportSettings

Representasi JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Kolom
enabled

boolean

Opsional. Menunjukkan apakah BigQuery Export diaktifkan.
project

string

Opsional. Project ID set data BigQuery yang akan diekspor datanya.

Catatan: Jika set data BigQuery berada di project yang berbeda dengan aplikasi, Anda harus memberikan peran roles/bigquery.admin kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Opsional. ID set data BigQuery untuk mengekspor data.

CloudLoggingSettings

Representasi JSON 
{
  "enableCloudLogging": boolean
}
Kolom
enableCloudLogging

boolean

Opsional. Apakah akan mengaktifkan Cloud Logging untuk sesi.

ConversationLoggingSettings

Representasi JSON 
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
Kolom
disableConversationLogging

boolean

Opsional. Apakah akan menonaktifkan logging percakapan untuk sesi.
retentionWindow

string (Duration format)

Opsional. Mengontrol periode retensi untuk percakapan. Jika tidak disetel, percakapan akan dipertahankan selama 365 hari.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

MetricAnalysisSettings

Representasi JSON 
{
  "llmMetricsOptedOut": boolean
}
Kolom
llmMetricsOptedOut

boolean

Opsional. Apakah akan mengumpulkan data percakapan untuk metrik analisis LLM. Jika benar (true), data percakapan tidak akan dikumpulkan untuk metrik analisis llm; jika tidak, data percakapan akan dikumpulkan.

ErrorHandlingSettings

Representasi JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
Kolom
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Opsional. Strategi yang akan digunakan untuk penanganan error.
fallbackResponseConfig

object (FallbackResponseConfig)

Opsional. Konfigurasi untuk menangani respons penggantian.
endSessionConfig

object (EndSessionConfig)

Opsional. Konfigurasi untuk mengakhiri sesi jika terjadi error sistem (misalnya, error LLM).

FallbackResponseConfig

Representasi JSON 
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Kolom
customFallbackMessages

map (key: string, value: string)

Opsional. Pesan penggantian jika terjadi error sistem (misalnya, error LLM), dipetakan berdasarkan kode bahasa yang didukung.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts

integer

Opsional. Jumlah maksimum upaya penggantian yang harus dilakukan sebelum agen memancarkan Sinyal EndSession.

CustomFallbackMessagesEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

EndSessionConfig

Representasi JSON 
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
Kolom

Kolom union _escalate_session.

_escalate_session hanya dapat berupa salah satu dari hal berikut:
escalateSession

boolean

Opsional. Apakah akan meningkatkan sesi di EndSession. Jika sesi dilanjutkan, metadata in EndSession akan berisi session_escalated = true. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent untuk mengetahui detailnya.

ModelSettings

Representasi JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
Kolom
model

string

Opsional. Model LLM yang harus digunakan agen. Jika tidak disetel, agen akan mewarisi model dari agen induknya.

Kolom union _temperature.

_temperature hanya dapat berupa salah satu dari hal berikut:
temperature

number

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. Temperatur yang lebih tinggi menghasilkan respons yang lebih kreatif.

EvaluationMetricsThresholds

Representasi JSON 
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Kolom
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Opsional. Nilai minimum metrik evaluasi emas.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Opsional. Tidak digunakan lagi: Gunakan golden_hallucination_metric_behavior sebagai gantinya. Perilaku metrik halusinasi saat ini digunakan untuk evaluasi utama.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opsional. Perilaku metrik halusinasi untuk evaluasi golden dataset.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opsional. Perilaku metrik halusinasi untuk evaluasi skenario.

GoldenEvaluationMetricsThresholds

Representasi JSON 
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
Kolom
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

Opsional. Nilai minimum metrik tingkat belokan.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Opsional. Nilai minimum metrik tingkat ekspektasi.
toolMatchingSettings

object (ToolMatchingSettings)

Opsional. Setelan pencocokan alat. Panggilan alat tambahan adalah panggilan alat yang ada dalam eksekusi, tetapi tidak cocok dengan panggilan alat apa pun dalam ekspektasi standar.

TurnLevelMetricsThresholds

Representasi JSON 
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
Kolom
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Opsional. Saluran kemiripan semantik yang akan digunakan untuk evaluasi.

Kolom union _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold hanya dapat berupa salah satu dari hal berikut:
semanticSimilaritySuccessThreshold

integer

Opsional. Ambang batas keberhasilan untuk kemiripan semantik. Harus berupa bilangan bulat antara 0 dan 4. Defaultnya adalah >= 3.

Kolom union _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold hanya dapat berupa salah satu dari hal berikut:
overallToolInvocationCorrectnessThreshold

number

Opsional. Ambang batas keberhasilan untuk kebenaran pemanggilan alat secara keseluruhan. Harus berupa float antara 0 dan 1. Defaultnya adalah 1.0.

ExpectationLevelMetricsThresholds

Representasi JSON 
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
Kolom

Kolom union _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold hanya dapat berupa salah satu dari hal berikut:
toolInvocationParameterCorrectnessThreshold

number

Opsional. Ambang batas keberhasilan untuk kebenaran parameter pemanggilan alat individual. Harus berupa float antara 0 dan 1. Defaultnya adalah 1.0.

ToolMatchingSettings

Representasi JSON 
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
Kolom
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Opsional. Perilaku untuk panggilan alat tambahan. Nilai defaultnya adalah GAGAL.

VariableDeclaration

Representasi JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Kolom
name

string

Wajib. Nama variabel. Nama harus diawali dengan huruf atau garis bawah dan hanya berisi huruf, angka, atau garis bawah.
description

string

Wajib. Deskripsi variabel.
schema

object (Schema)

Wajib. Skema variabel.

Skema

Representasi JSON 
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
Kolom
type

enum (Type)

Wajib. Jenis data.
properties

map (key: string, value: object (Schema))

Opsional. Properti Type.OBJECT.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]

string

Opsional. Properti wajib Type.OBJECT.
description

string

Opsional. Deskripsi data.
items

object (Schema)

Opsional. Skema elemen Type.ARRAY.
nullable

boolean

Opsional. Menunjukkan apakah nilai boleh berupa null.
uniqueItems

boolean

Opsional. Menunjukkan bahwa item dalam array harus unik. Hanya berlaku untuk TYPE.ARRAY.
prefixItems[]

object (Schema)

Opsional. Skema elemen awal Type.ARRAY.
additionalProperties

object (Schema)

Opsional. Dapat berupa boolean atau objek, mengontrol keberadaan properti tambahan.
anyOf[]

object (Schema)

Opsional. Nilai harus divalidasi terhadap salah satu (satu atau beberapa) subskema dalam daftar.
enum[]

string

Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. Kita dapat menentukan arah sebagai : {type:STRING, format:enum, enum:["TIMUR", NORTH", "SELATAN", "BARAT"]} 2. Kita dapat menentukan nomor apartemen sebagai : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Opsional. Nilai default data.
ref

string

Opsional. Memungkinkan referensi tidak langsung antar-node skema. Nilai harus berupa referensi yang valid ke turunan defs akar.

Misalnya, skema berikut menentukan referensi ke node skema bernama "Pet":

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

Nilai properti "pet" adalah referensi ke node skema bernama "Pet". Lihat detailnya di https://json-schema.org/understanding-json-schema/structuring.
defs

map (key: string, value: object (Schema))

Opsional. Peta definisi untuk digunakan oleh ref. Hanya diizinkan di root skema.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title

string

Opsional. Judul skema.
minItems

string (int64 format)

Opsional. Jumlah minimum elemen untuk Type.ARRAY.
maxItems

string (int64 format)

Opsional. Jumlah maksimum elemen untuk Type.ARRAY.

Kolom union _minimum.

_minimum hanya dapat berupa salah satu dari hal berikut:
minimum

number

Opsional. Nilai minimum untuk Type.INTEGER dan Type.NUMBER.

Kolom union _maximum.

_maximum hanya dapat berupa salah satu dari hal berikut:
maximum

number

Opsional. Nilai maksimum untuk Type.INTEGER dan Type.NUMBER.

PropertiesEntry

Representasi JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Kolom
key

string
value

object (Schema)

Nilai

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis nilai. kind hanya ada berupa salah satu diantara berikut:
nullValue

null

Mewakili JSON null.
numberValue

number

Mewakili angka JSON. Tidak boleh NaN, Infinity, atau -Infinity, karena tidak didukung dalam JSON. Hal ini juga tidak dapat merepresentasikan nilai Int64 besar, karena format JSON umumnya tidak mendukungnya dalam jenis angka.
stringValue

string

Mewakili string JSON.
boolValue

boolean

Mewakili boolean JSON (literal true atau false dalam JSON).
structValue

object (Struct format)

Mewakili objek JSON.
listValue

array (ListValue format)

Mewakili array JSON.

Struct

Representasi JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Kolom
fields

map (key: string, value: value (Value format))

Peta tidak berurutan dari nilai yang diketik secara dinamis.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Representasi JSON 
{
  "key": string,
  "value": value
}
Kolom
key

string
value

value (Value format)

ListValue

Representasi JSON 
{
  "values": [
    value
  ]
}
Kolom
values[]

value (Value format)

Kolom berulang dari nilai yang diketik secara dinamis.

DefsEntry

Representasi JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Kolom
key

string
value

object (Schema)

DataStoreSettings

Representasi JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
Kolom
engines[]

object (Engine)

Hanya output. Mesin untuk aplikasi.

Mesin

Representasi JSON 
{
  "name": string,
  "type": enum (Type)
}
Kolom
name

string

Hanya output. Nama resource mesin. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Hanya output. Jenis mesin.

ChannelProfile

Representasi JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
Kolom
profileId

string

Opsional. ID unik profil channel.
channelType

enum (ChannelType)

Opsional. Jenis profil channel.
personaProperty

object (PersonaProperty)

Opsional. Properti persona profil channel.
webWidgetConfig

object (WebWidgetConfig)

Opsional. Konfigurasi untuk widget web.
whatsappConfig

object (WhatsAppConfig)

Opsional. Konfigurasi khusus untuk deployment WhatsApp.
instagramConfig

object (InstagramConfig)

Opsional. Konfigurasi khusus untuk deployment Instagram.

Kolom union _disable_dtmf.

_disable_dtmf hanya dapat berupa salah satu dari hal berikut:
disableDtmf

boolean

Opsional. Apakah akan menonaktifkan DTMF (dual-tone multi-frequency).

Kolom union _disable_barge_in_control.

_disable_barge_in_control hanya dapat berupa salah satu dari hal berikut:
disableBargeInControl

boolean

Opsional. Apakah akan menonaktifkan kontrol penyela pengguna dalam percakapan. - true: Interupsi pengguna dinonaktifkan saat agen berbicara. - false: Agen mempertahankan kontrol otomatis atas kapan pengguna dapat melakukan interupsi.

Kolom union _noise_suppression_level.

_noise_suppression_level hanya dapat berupa salah satu dari hal berikut:
noiseSuppressionLevel

string

Opsional. Tingkat peredam bising profil saluran. Nilai yang tersedia adalah "low", "moderate", "high", "very_high".

PersonaProperty

Representasi JSON 
{
  "persona": enum (Persona)
}
Kolom
persona

enum (Persona)

Opsional. Persona channel.

WebWidgetConfig

Representasi JSON 
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Kolom
modality

enum (Modality)

Opsional. Modalitas widget web.
theme

enum (Theme)

Opsional. Tema widget web.
webWidgetTitle

string

Opsional. Judul widget web.
securitySettings

object (SecuritySettings)

Opsional. Setelan keamanan widget web.

SecuritySettings

Representasi JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Kolom
enablePublicAccess

boolean

Opsional. Menunjukkan apakah akses publik ke widget web diaktifkan. Jika true, widget web akan dapat diakses secara publik. Jika false, widget web harus diintegrasikan dengan sistem autentikasi dan otorisasi Anda sendiri untuk menampilkan kredensial yang valid untuk mengakses agen CES.
enableOriginCheck

boolean

Opsional. Menunjukkan apakah pemeriksaan origin untuk widget web diaktifkan. Jika true, widget web akan memeriksa asal situs yang memuat widget web dan hanya mengizinkannya dimuat di asal yang sama atau salah satu asal yang diizinkan.
allowedOrigins[]

string

Opsional. Origin yang diizinkan untuk menghosting widget web. Asal ditentukan oleh RFC 6454. Jika kosong, semua origin diizinkan. Maksimum 100 origin yang diizinkan. Contoh: "https://example.com"
enableRecaptcha

boolean

Opsional. Menunjukkan apakah verifikasi reCAPTCHA untuk widget web diaktifkan.

WhatsAppConfig

Representasi JSON 
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Kolom
wabaId

string

Wajib. ID Akun WhatsApp Business.
phoneNumberId

string

Wajib. ID nomor telepon Meta.
phoneNumber

string

Opsional. Nomor telepon dalam format E.164.
displayName

string

Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnailUrl

string

Hanya output. URL thumbnail profil bisnis Meta yang diambil.
description

string

Hanya output. Deskripsi halaman atau profil bisnis Meta.

InstagramConfig

Representasi JSON 
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Kolom
instagramAccountId

string

Wajib. ID Akun Instagram.
displayName

string

Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnailUrl

string

Hanya output. URL thumbnail profil bisnis Meta yang diambil.
description

string

Hanya output. Deskripsi halaman atau profil bisnis Meta.

MetadataEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

ClientCertificateSettings

Representasi JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Kolom
tlsCertificate

string

Wajib. Sertifikat TLS yang dienkode dalam format PEM. String ini harus menyertakan baris header awal dan footer akhir.
privateKey

string

Wajib. Nama resource versi rahasia SecretManager yang menyimpan kunci pribadi yang dienkode dalam format PEM. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Opsional. Nama resource versi rahasia SecretManager yang menyimpan frasa sandi untuk mendekripsi kunci pribadi. Harus dibiarkan tidak disetel jika kunci pribadi tidak dienkripsi. Format: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Representasi JSON 
{
  "allowedOrigins": [
    string
  ]
}
Kolom
allowedOrigins[]

string

Opsional. Asal HTTP(s) yang diizinkan yang dapat dipanggil langsung oleh alat OpenAPI di Aplikasi saat Kontrol Layanan VPC diaktifkan. String ini harus sama persis dengan asal, termasuk port jika ditentukan. Misalnya, "https://example.com" atau "https://example.com:443". Daftar ini belum berlaku untuk alat Python yang dapat melakukan panggilan HTTP langsung.

DashboardSettings

Representasi JSON 
{
  "defaultDashboard": string
}
Kolom
defaultDashboard

string

Opsional. Nama resource dasbor Contact Center Insights default yang terkait dengan aplikasi. Dasbor ini adalah dasbor yang akan ditampilkan saat pengguna membuka tampilan Pemantauan untuk aplikasi.

Format: projects/{project}/locations/{location}/dashboards/{dashboard}

Agen

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],
  "validationErrors": [
    string
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  }
  // End of list of possible types for union field agent_type.
}
Kolom
name

string

ID. ID unik agen. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Wajib. Nama tampilan agen.
description

string

Opsional. Deskripsi agen yang dapat dibaca manusia.
modelSettings

object (ModelSettings)

Opsional. Konfigurasi untuk model LLM.
instruction

string

Opsional. Petunjuk untuk model LLM guna memandu perilaku agen.
tools[]

string

Opsional. Daftar alat yang tersedia untuk agen. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]

string

Opsional. Daftar agen turunan di struktur agen. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
afterAgentCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
beforeModelCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
afterModelCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
beforeToolCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
afterToolCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi setelah alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat agen 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: "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. Stempel waktu saat agen 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
guardrails[]

string

Opsional. Daftar batasan untuk agen. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
toolsets[]

object (AgentToolset)

Opsional. Daftar toolset untuk agen.
generatedSummary

string

Hanya output. Jika agen dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan.
transferRules[]

object (TransferRule)

Opsional. Aturan transfer agen. Jika ada beberapa aturan yang cocok, aturan pertama dalam daftar akan digunakan.
validationErrors[]

string

Hanya output. Kesalahan konfigurasi atau error di agen yang dapat memengaruhi kualitas agen.
Kolom union agent_type. Jenis agen. agent_type hanya ada berupa salah satu diantara berikut:
llmAgent

object (LlmAgent)

Opsional. Jenis agen default.
remoteDialogflowAgent

object (RemoteDialogflowAgent)

Opsional. Agen Dialogflow jarak jauh yang akan digunakan untuk eksekusi agen. Jika kolom ini disetel, semua properti tingkat agen lainnya akan diabaikan.

Catatan: Jika agen Dialogflow berada dalam project yang berbeda dengan aplikasi, Anda harus memberikan roles/dialogflow.client ke agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

RemoteDialogflowAgent

Representasi JSON 
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean,
  "languageCodeVariable": string
}
Kolom
agent

string

Wajib. Nama resource agen Dialogflow. Format: projects/{project}/locations/{location}/agents/{agent}
flowId

string

Opsional. ID alur untuk alur di agen Dialogflow.
environmentId

string

Opsional. ID lingkungan agen Dialogflow yang akan digunakan untuk eksekusi agen. Jika tidak ditentukan, lingkungan draf akan digunakan.
inputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama variabel aplikasi ke nama parameter sesi Dialogflow yang akan dikirim ke agen Dialogflow sebagai input.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
outputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama parameter sesi Dialogflow ke nama variabel aplikasi yang akan dikirim kembali ke agen CES setelah eksekusi agen Dialogflow berakhir.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
respectResponseInterruptionSettings

boolean

Opsional. Menunjukkan apakah akan mematuhi setelan gangguan tingkat pesan yang dikonfigurasi di agen Dialogflow.

  • Jika salah (false): semua pesan respons dari agen Dialogflow mengikuti setelan interupsi tingkat aplikasi.
  • Jika benar (true): hanya pesan respons dengan allow_playback_interruption yang disetel ke benar (true) yang dapat disela, semua pesan lainnya mengikuti setelan penyelaan tingkat aplikasi.
languageCodeVariable

string

Opsional. Nama variabel yang berisi kode bahasa yang akan digunakan untuk sesi Dialogflow. Jika tidak ditentukan, kode bahasa default agen Dialogflow akan digunakan.

InputVariableMappingEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

OutputVariableMappingEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

Callback

Representasi JSON 
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
Kolom
description

string

Opsional. Deskripsi callback yang dapat dibaca manusia.
disabled

boolean

Opsional. Apakah callback dinonaktifkan. Panggilan balik yang dinonaktifkan akan diabaikan oleh agen.
proactiveExecutionEnabled

boolean

Opsional. Jika diaktifkan, callback juga akan dieksekusi pada output model perantara. Setelan ini hanya memengaruhi callback setelah model. AKTIFKAN DENGAN HATI-HATI. Biasanya, callback setelah model hanya perlu dieksekusi setelah menerima semua respons model. Mengaktifkan eksekusi proaktif dapat berimplikasi negatif pada biaya dan latensi eksekusi, dan hanya boleh diaktifkan dalam situasi yang jarang terjadi.
Kolom union callback. Callback yang akan dieksekusi. callback hanya ada berupa salah satu diantara berikut:
pythonCode

string

Wajib. Kode python yang akan dieksekusi untuk callback.

AgentToolset

Representasi JSON 
{
  "toolset": string,
  "toolIds": [
    string
  ]
}
Kolom
toolset

string

Wajib. Nama resource toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]

string

Opsional. ID alat untuk memfilter toolset.

TransferRule

Representasi JSON 
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
Kolom
childAgent

string

Wajib. Nama resource agen turunan tempat aturan diterapkan. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

enum (Direction)

Wajib. Arah transfer.
Kolom union rule_type. Jenis aturan. rule_type hanya ada berupa salah satu diantara berikut:
deterministicTransfer

object (DeterministicTransfer)

Opsional. Aturan yang langsung ditransfer ke agen target saat kondisi terpenuhi.
disablePlannerTransfer

object (DisablePlannerTransfer)

Opsional. Aturan yang mencegah perencana mentransfer ke agen target.

DeterministicTransfer

Representasi JSON 
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
Kolom
Kolom union condition_type. Kondisi yang akan dievaluasi. condition_type hanya ada berupa salah satu diantara berikut:
expressionCondition

object (ExpressionCondition)

Opsional. Aturan yang mengevaluasi kondisi status sesi. Jika kondisi bernilai benar, transfer akan terjadi.
pythonCodeCondition

object (PythonCodeCondition)

Opsional. Aturan yang menggunakan blok kode Python untuk mengevaluasi kondisi. Jika kondisi bernilai benar, transfer akan terjadi.

ExpressionCondition

Representasi JSON 
{
  "expression": string
}
Kolom
expression

string

Wajib. Representasi string dari kondisi cloud.api.Expression.

PythonCodeCondition

Representasi JSON 
{
  "pythonCode": string
}
Kolom
pythonCode

string

Wajib. Kode python yang akan dieksekusi.

DisablePlannerTransfer

Representasi JSON 
{
  "expressionCondition": {
    object (ExpressionCondition)
  }
}
Kolom
expressionCondition

object (ExpressionCondition)

Wajib. Jika kondisi bernilai benar, perencana tidak akan diizinkan untuk mentransfer ke agen target.

Alat

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
Kolom
name

string

ID. Nama resource alat. Format:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} untuk alat mandiri.
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} untuk alat yang diambil dari toolset.

Alat ini bersifat dinamis dan hanya menghasilkan output; alat ini tidak dapat dirujuk secara langsung jika alat diperlukan.
displayName

string

Hanya output. Nama tampilan alat, yang berasal dari jenis alat. Misalnya, nama tampilan [ClientFunction][Tool.ClientFunction] berasal dari properti name-nya.
executionType

enum (ExecutionType)

Opsional. Jenis eksekusi alat.
timeout

string (Duration format)

Opsional. Waktu tunggu untuk eksekusi alat. Jika tidak ditetapkan, waktu tunggu default adalah 30 detik untuk alat SYNCHRONOUS dan 60 detik untuk alat ASYNCHRONOUS.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
createTime

string (Timestamp format)

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: "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. 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
generatedSummary

string

Hanya output. Jika alat dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan.
toolFakeConfig

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

object (ClientFunction)

Opsional. Fungsi klien.
openApiTool

object (OpenApiTool)

Opsional. Alat API terbuka.
googleSearchTool

object (GoogleSearchTool)

Opsional. Alat penelusuran google.
connectorTool

object (ConnectorTool)

Opsional. Alat Integration Connector.
dataStoreTool

object (DataStoreTool)

Opsional. Alat penyimpanan data.
pythonFunction

object (PythonFunction)

Opsional. Alat fungsi python.
mcpTool

object (McpTool)

Opsional. Alat MCP. Alat MCP tidak dapat dibuat atau diperbarui secara langsung dan dikelola oleh toolset MCP.
fileSearchTool

object (FileSearchTool)

Opsional. Alat penelusuran file.
systemTool

object (SystemTool)

Opsional. Alat sistem.
agentTool

object (AgentTool)

Opsional. Alat agen.
widgetTool

object (WidgetTool)

Opsional. Alat widget.
remoteAgentTool

object (RemoteAgentTool)

Opsional. Alat agen jarak jauh.

ClientFunction

Representasi JSON 
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
Kolom
name

string

Wajib. Nama fungsi.
description

string

Opsional. Deskripsi fungsi.
parameters

object (Schema)

Opsional. Skema parameter fungsi.
response

object (Schema)

Opsional. Skema respons fungsi.

OpenApiTool

Representasi JSON 
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Kolom
openApiSchema

string

Wajib. Skema OpenAPI dalam format JSON atau YAML.
name

string

Opsional. Nama alat. Jika tidak diberikan, nama alat akan diambil dari skema OpenAPI, dari operation.operationId.
description

string

Opsional. Deskripsi alat. Jika tidak diberikan, deskripsi alat akan diambil dari skema OpenAPI, dari operation.description atau operation.summary.
apiAuthentication

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan oleh API.
tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang akan dipercayai klien.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan.
ignoreUnknownFields

boolean

Opsional. Jika benar (true), agen akan mengabaikan kolom yang tidak diketahui dalam respons API.
url

string

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 auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
Kolom
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut:
apiKeyConfig

object (ApiKeyConfig)

Opsional. Konfigurasi untuk autentikasi kunci API.
oauthConfig

object (OAuthConfig)

Opsional. Konfigurasi untuk OAuth.
serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Opsional. Konfigurasi untuk autentikasi token ID yang dibuat dari agen layanan CES.
serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Opsional. Konfigurasi untuk autentikasi akun layanan.
bearerTokenConfig

object (BearerTokenConfig)

Opsional. Konfigurasi untuk autentikasi token pembawa.

ApiKeyConfig

Representasi JSON 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
Kolom
keyName

string

Wajib. Nama parameter atau nama header kunci API. Misalnya, Jika permintaan API adalah "https://example.com/act?X-Api-Key=", "X-Api-Key" akan menjadi nama parameter.
apiKeySecretVersion

string

Wajib. Nama resource versi secret SecretManager yang menyimpan kunci API. Format: projects/{project}/secrets/{secret}/versions/{version}

Catatan: Anda harus memberikan peran roles/secretmanager.secretAccessor kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
requestLocation

enum (RequestLocation)

Wajib. Lokasi kunci dalam permintaan.

OAuthConfig

Representasi JSON 
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
Kolom
oauthGrantType

enum (OauthGrantType)

Wajib. Jenis pemberian izin OAuth.
clientId

string

Wajib. ID klien dari penyedia OAuth.
clientSecretVersion

string

Wajib. Nama resource versi secret SecretManager yang menyimpan rahasia klien. Format: projects/{project}/secrets/{secret}/versions/{version}

Catatan: Anda harus memberikan peran roles/secretmanager.secretAccessor kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
tokenEndpoint

string

Wajib. Endpoint token di penyedia OAuth untuk ditukar dengan token akses.
scopes[]

string

Opsional. Cakupan OAuth yang akan diberikan.

ServiceAccountAuthConfig

Representasi JSON 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
Kolom
serviceAccount

string

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 Authorization permintaan.

Akun layanan harus memiliki peran roles/iam.serviceAccountTokenCreator yang diberikan kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]

string

Opsional. Cakupan OAuth yang akan diberikan. Jika tidak ditentukan, cakupan default https://www.googleapis.com/auth/cloud-platform akan digunakan.

BearerTokenConfig

Representasi JSON 
{
  "token": string
}
Kolom
token

string

Wajib. Token pemilik. Harus dalam format $context.variables.<name_of_variable>.

TlsConfig

Representasi JSON 
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
Kolom
caCerts[]

object (CaCert)

Wajib. Menentukan daftar sertifikat CA kustom yang diizinkan untuk verifikasi HTTPS.

CaCert

Representasi JSON 
{
  "displayName": string,
  "cert": string
}
Kolom
displayName

string

Wajib. Nama sertifikat CA kustom yang diizinkan. Ini dapat digunakan untuk membedakan sertifikat CA kustom.
cert

string (bytes format)

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

string

Wajib. Nama layanan Service Directory. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Lokasi direktori layanan harus sama dengan lokasi aplikasi.

GoogleSearchTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (PromptConfig)
  }
}
Kolom
name

string

Wajib. Nama alat.
description

string

Opsional. Deskripsi tujuan alat.
contextUrls[]

string

Opsional. Konten akan diambil langsung dari URL ini untuk konteks dan perujukan. Contoh: "https://example.com/path.html". Maksimum 20 URL yang diizinkan.
preferredDomains[]

string

Opsional. Menentukan domain untuk membatasi hasil penelusuran. Contoh: "example.com", "another.site". Maksimum 20 domain dapat ditentukan.
excludeDomains[]

string

Opsional. Daftar domain yang akan dikecualikan dari hasil penelusuran. Contoh: "example.com". Maksimum 2.000 domain dapat dikecualikan.
promptConfig

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

string

Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan chat. Jika tidak disetel, perintah default akan digunakan.
voicePrompt

string

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 (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
Kolom
connection

string

Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: projects/{project}/locations/{location}/connections/{connection}
action

object (Action)

Wajib. Tindakan yang akan digunakan alat.
authConfig

object (EndUserAuthConfig)

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

string

Opsional. Nama alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini.
description

string

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 action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
Kolom
inputFields[]

string

Opsional. Kolom entitas yang akan digunakan sebagai input untuk operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entitas akan digunakan.
outputFields[]

string

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

string

ID tindakan Koneksi yang akan digunakan alat.
entityOperation

object (EntityOperation)

Konfigurasi operasi entitas yang akan digunakan alat.

EntityOperation

Representasi JSON 
{
  "entityId": string,
  "operation": enum (OperationType)
}
Kolom
entityId

string

Wajib. ID entitas.
operation

enum (OperationType)

Wajib. Operasi yang akan dilakukan pada entity.

EndUserAuthConfig

Representasi JSON 
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
Kolom
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

Autentikasi Kode Otorisasi Oauth 2.0.
oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Autentikasi Pemberian Otorisasi OAuth 2.0 Profil JWT.

Oauth2AuthCodeConfig

Representasi JSON 
{
  "oauthToken": string
}
Kolom
oauthToken

string

Wajib. Nama parameter token OAuth yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Representasi JSON 
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
Kolom
issuer

string

Wajib. Nama parameter penerbit yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.
subject

string

Wajib. Nama parameter subjek yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.
clientKey

string

Wajib. Nama parameter klien yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.

DataStoreTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
Kolom
name

string

Wajib. Nama alat penyimpanan data.
description

string

Opsional. Deskripsi alat.
boostSpecs[]

object (BoostSpecs)

Opsional. Spesifikasi penguatan untuk menguatkan dokumen tertentu.
modalityConfigs[]

object (ModalityConfig)

Opsional. Konfigurasi modalitas untuk penyimpanan data.
filterParameterBehavior

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

object (DataStoreSource)

Opsional. Menelusuri dalam satu DataStore tertentu.
engineSource

object (EngineSource)

Opsional. Menelusuri dalam Mesin (berpotensi di beberapa DataStore).

DataStoreSource

Representasi JSON 
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
Kolom
filter

string

Opsional. Spesifikasi filter untuk DataStore. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
dataStore

object (DataStore)

Opsional. Penyimpanan data.

DataStore

Representasi JSON 
{
  "name": string,
  "type": enum (DataStoreType),
  "documentProcessingMode": enum (DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (ConnectorConfig)
  }
}
Kolom
name

string

Wajib. Nama lengkap resource DataStore. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

enum (DataStoreType)

Hanya output. Jenis penyimpanan data. Kolom ini bersifat hanya baca dan diisi oleh server.
documentProcessingMode

enum (DocumentProcessingMode)

Hanya output. Mode pemrosesan dokumen untuk koneksi penyimpanan data. Hanya ditetapkan untuk penyimpanan data PUBLIC_WEB dan UNSTRUCTURED.
displayName

string

Hanya output. Nama tampilan penyimpanan data.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
connectorConfig

object (ConnectorConfig)

Hanya output. Konfigurasi konektor untuk koneksi penyimpanan data.

ConnectorConfig

Representasi JSON 
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
Kolom
collection

string

Nama resource koleksi tempat penyimpanan data berada.
collectionDisplayName

string

Nama tampilan koleksi tempat penyimpanan data berada.
dataSource

string

Nama sumber data. Contoh: salesforce, jira, confluence, bigquery.

EngineSource

Representasi JSON 
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreSource)
    }
  ],
  "filter": string
}
Kolom
engine

string

Wajib. Nama lengkap resource Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
dataStoreSources[]

object (DataStoreSource)

Opsional. Digunakan untuk menargetkan DataStore tertentu dalam Engine. Jika kosong, penelusuran berlaku untuk semua DataStore yang terkait dengan Engine.
filter

string

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 (BoostSpec)
    }
  ]
}
Kolom
dataStores[]

string

Wajib. Penyimpanan Data tempat konfigurasi peningkatan diterapkan. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]

object (BoostSpec)

Wajib. Daftar spesifikasi peningkat.

BoostSpec

Representasi JSON 
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
Kolom
conditionBoostSpecs[]

object (ConditionBoostSpec)

Wajib. Daftar spesifikasi peningkat.

ConditionBoostSpec

Representasi JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
Kolom
condition

string

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

number

Opsional. Kekuatan pendorong, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Nilai defaultnya adalah 0.0.

Menyetel ke 1.0 akan memberikan promosi besar pada saran. Namun, hasil teratas tidak selalu merupakan saran yang dipromosikan.

Menetapkan 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

object (BoostControlSpec)

Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan.

BoostControlSpec

Representasi JSON 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Kolom
fieldName

string

Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
attributeType

enum (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, prosesnya sederhana, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
controlPoints[]

object (ControlPoint)

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

string

Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]].
boostAmount

number

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 (ModalityType),
  "rewriterConfig": {
    object (RewriterConfig)
  },
  "summarizationConfig": {
    object (SummarizationConfig)
  },
  "groundingConfig": {
    object (GroundingConfig)
  },
  "snippetsConfig": {
    object (SnippetsConfig)
  }
}
Kolom
modalityType

enum (ModalityType)

Wajib. Jenis modalitas.
rewriterConfig

object (RewriterConfig)

Opsional. Konfigurasi penulis ulang.
summarizationConfig

object (SummarizationConfig)

Opsional. Konfigurasi ringkasan.
groundingConfig

object (GroundingConfig)

Opsional. Konfigurasi perujukan.
snippetsConfig

object (SnippetsConfig)

Opsional. Konfigurasi cuplikan.

RewriterConfig

Representasi JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Kolom
modelSettings

object (ModelSettings)

Wajib. Konfigurasi untuk model LLM.
prompt

string

Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan.
disabled

boolean

Opsional. Apakah penulis ulang dinonaktifkan.

SummarizationConfig

Representasi JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Kolom
modelSettings

object (ModelSettings)

Opsional. Konfigurasi untuk model LLM.
prompt

string

Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan.
disabled

boolean

Opsional. Apakah ringkasan dinonaktifkan.

GroundingConfig

Representasi JSON 
{
  "groundingLevel": number,
  "disabled": boolean
}
Kolom
groundingLevel

number

Opsional. Ambang batas 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

boolean

Opsional. Apakah perujukan dinonaktifkan.

SnippetsConfig

Representasi JSON 
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
Kolom
enableSnippets

boolean

Opsional. Apakah cuplikan diaktifkan atau tidak.
maxSnippets

integer

Opsional. Jumlah cuplikan yang akan ditampilkan per kueri. Jika tidak disetel, secara default akan menampilkan semua cuplikan dari layanan.

PythonFunction

Representasi JSON 
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
Kolom
name

string

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

string

Opsional. Kode Python yang akan dieksekusi untuk alat.
description

string

Hanya output. Deskripsi fungsi Python, di-parsing dari docstring kode python.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Service Directory untuk alat.

McpTool

Representasi JSON 
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (State)
}
Kolom
name

string

Wajib. Nama alat MCP.
nameOverride

string

Opsional. Penggantian nama alat MCP. Bagian ini diisi jika nama diganti oleh penggantian Toolset.
description

string

Opsional. Deskripsi alat MCP.
inputSchema

object (Schema)

Opsional. Skema argumen input alat MCP.
outputSchema

object (Schema)

Opsional. Skema argumen output alat MCP.
serverAddress

string

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. Hal ini sama dengan server_address di McpToolset. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
apiAuthentication

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

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
customHeaders

map (key: string, value: string)

Opsional. Header kustom yang akan dikirim dalam permintaan ke server MCP. Nilai harus dalam format $context.variables.<name_of_variable> dan dapat ditetapkan dalam variabel sesi. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection untuk mengetahui detail selengkapnya.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Hanya output. Status ketersediaan dinamis alat di server eksternal.

CustomHeadersEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

FileSearchTool

Representasi JSON 
{
  "corpusType": enum (CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
Kolom
corpusType

enum (CorpusType)

Opsional. Jenis korpus. Default-nya adalah FULLY_MANAGED.
name

string

Wajib. Nama alat.
description

string

Opsional. Deskripsi alat.
fileCorpus

string

Opsional. Korpus tempat file disimpan. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

SystemTool

Representasi JSON 
{
  "name": string,
  "description": string
}
Kolom
name

string

Wajib. Nama alat sistem.
description

string

Hanya output. Deskripsi alat sistem.

AgentTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "agent": string
}
Kolom
name

string

Wajib. Nama alat agen.
description

string

Opsional. Deskripsi tujuan alat.
agent

string

Opsional. Nama resource agen yang menjadi titik entri alat. Format: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
Kolom
name

string

Wajib. Nama tampilan alat widget.
description

string

Opsional. Deskripsi alat widget.
widgetType

enum (WidgetType)

Opsional. Jenis alat widget. Jika tidak ditentukan, jenis defaultnya adalah CUSTOMIZED.
uiConfig

object (Struct format)

Opsional. Konfigurasi untuk merender widget.
dataMapping

object (DataMapping)

Opsional. Pemetaan yang menentukan cara data dari alat sumber dipetakan ke parameter input widget.
textResponseConfig

object (TextResponseConfig)

Opsional. Konfigurasi untuk respons teks yang selalu disertakan.
Kolom union input. Input alat widget. input hanya ada berupa salah satu diantara berikut:
parameters

object (Schema)

Opsional. Parameter input alat widget.

DataMapping

Representasi JSON 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (Mode),
  "pythonScript": string
}
Kolom
sourceToolName

string

Opsional. Nama resource alat yang menyediakan data untuk widget (misalnya, alat penelusuran atau fungsi kustom). Format: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
fieldMappings

map (key: string, value: string)

Opsional. Peta kolom parameter input widget ke kolom output yang sesuai dari alat sumber.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
pythonFunction

object (PythonFunction)

Opsional. Konfigurasi untuk fungsi Python yang digunakan untuk mengubah output alat sumber ke dalam format input widget.
mode

enum (Mode)

Opsional. Mode pemetaan data.
pythonScript
(deprecated)

string

Tidak digunakan lagi: Gunakan python_function sebagai gantinya.

FieldMappingsEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

TextResponseConfig

Representasi JSON 
{
  "type": enum (Type),
  "staticText": string,
  "textResponseInstruction": string
}
Kolom
type

enum (Type)

Opsional. Strategi untuk memberikan respons teks.
staticText

string

Opsional. Respons teks statis yang akan ditampilkan saat jenisnya adalah STATIC.
textResponseInstruction

string

Opsional. Petunjuk untuk LLM tentang cara menghasilkan respons teks. Digunakan sebagai deskripsi untuk parameter respons teks jika jenisnya adalah LLM_GENERATED.

RemoteAgentTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  }
}
Kolom
name

string

Wajib. Nama alat.
description

string

Wajib. Deskripsi alat.
agentCard

object (AgentCard)

Wajib. Kartu agen dari agen jarak jauh yang dipanggil oleh alat ini.
apiAuthentication

object (ApiAuthentication)

Opsional. Konfigurasi autentikasi untuk memanggil agen jarak jauh.

AgentCard

Representasi JSON 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
Kolom
name

string

Wajib. Nama agen yang dapat dibaca manusia.
description

string

Wajib. Deskripsi domain tindakan/ruang solusi agen.
supportedInterfaces[]

object (AgentInterface)

Wajib. Daftar antarmuka yang didukung dan diurutkan. Entri pertama lebih disukai.
version

string

Wajib. Versi agen.
skills[]

object (AgentSkill)

Wajib. Keahlian mewakili unit kemampuan yang dapat dilakukan agen. Hal ini mungkin agak abstrak, tetapi mewakili serangkaian tindakan yang lebih terfokus yang kemungkinan besar akan berhasil dilakukan agen.

AgentInterface

Representasi JSON 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
Kolom
url

string

Wajib. URL tempat antarmuka ini tersedia. Harus berupa URL HTTPS absolut yang valid dalam produksi. Contoh: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocolBinding

string

Wajib. Binding protokol yang didukung di URL ini. Ini adalah string formulir terbuka, yang dapat dengan mudah diperluas untuk binding protokol lainnya. Plugin inti yang didukung secara resmi adalah JSONRPC, GRPC, dan HTTP+JSON.
tenant

string

ID tenant yang akan digunakan dalam permintaan saat memanggil agen.
protocolVersion

string

Wajib. Versi A2A protocol yang diekspos oleh antarmuka ini. Gunakan versi minor terbaru yang didukung per versi utama. Contoh: "0.3", "1.0"

AgentSkill

Representasi JSON 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
Kolom
id

string

Wajib. ID unik untuk kemampuan agen.
name

string

Wajib. Nama keahlian yang dapat dibaca manusia.
description

string

Wajib. Deskripsi mendetail tentang skill.
tags[]

string

Wajib. Sekumpulan kata kunci yang menjelaskan kemampuan skill.
examples[]

string

Contoh perintah atau skenario yang dapat ditangani oleh kemampuan ini.
inputModes[]

string

Kumpulan jenis media input yang didukung untuk skill ini, yang menggantikan default agen.
outputModes[]

string

Kumpulan jenis media output yang didukung untuk skill ini, yang menggantikan default agen.

ToolFakeConfig

Representasi JSON 
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
Kolom
enableFakeMode

boolean

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

object (CodeBlock)

Opsional. Blok kode yang akan dieksekusi, bukan panggilan alat yang sebenarnya.

CodeBlock

Representasi JSON 
{
  "pythonCode": string
}
Kolom
pythonCode

string

Wajib. Kode Python yang akan dipanggil dalam mode tiruan 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 sebenarnya akan dipanggil.

Contoh

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
Kolom
name

string

ID. ID unik contoh. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
displayName

string

Wajib. Nama tampilan contoh.
description

string

Opsional. Deskripsi contoh yang dapat dibaca manusia.
entryAgent

string

Opsional. Agen yang awalnya menangani percakapan. Jika tidak ditentukan, contoh ini merepresentasikan percakapan yang ditangani oleh agen root. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

object (Message)

Opsional. Kumpulan pesan yang membentuk percakapan.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat contoh 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: "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. Stempel waktu saat contoh 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
invalid

boolean

Hanya output. Contoh dapat menjadi tidak valid jika resource yang dirujuk dihapus. Contoh yang tidak valid tidak akan digunakan sebagai contoh few-shot.
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

Pesan

Representasi JSON 
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
Kolom
role

string

Opsional. Peran dalam percakapan, misalnya, pengguna, agen.
chunks[]

object (Chunk)

Opsional. Konten pesan sebagai serangkaian bagian.
eventTime

string (Timestamp format)

Opsional. Stempel waktu saat pesan dikirim atau diterima. Tidak boleh digunakan jika pesan adalah bagian dari example.

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

Chunk

Representasi JSON 
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
Kolom
Kolom union data. Data potongan. data hanya ada berupa salah satu diantara berikut:
text

string

Opsional. Data teks.
transcript

string

Opsional. Transkrip yang terkait dengan audio.
blob

object (Blob)

Opsional. Data blob.
payload

object (Struct format)

Opsional. Data payload kustom.
image

object (Image)

Opsional. Data gambar.
toolCall

object (ToolCall)

Opsional. Permintaan eksekusi alat.
toolResponse

object (ToolResponse)

Opsional. Respons eksekusi alat.
agentTransfer

object (AgentTransfer)

Opsional. Peristiwa transfer agen.
updatedVariables

object (Struct format)

Struct merepresentasikan variabel yang diperbarui dalam percakapan, yang dikelompokkan berdasarkan nama variabel.
defaultVariables

object (Struct format)

Struct merepresentasikan variabel default di awal percakapan, yang dikelompokkan berdasarkan nama variabel.

Blob

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

string

Wajib. Jenis MIME standar IANA dari data sumber.
data

string (bytes format)

Wajib. Byte mentah blob.

String berenkode base64.

Gambar

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

string

Wajib. Jenis MIME standar IANA dari data sumber. Jenis gambar yang didukung meliputi: * image/png * image/jpeg * image/webp
data

string (bytes format)

Wajib. Byte mentah gambar.

String berenkode base64.

ToolCall

Representasi JSON 
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Kolom
id

string

Opsional. ID unik panggilan alat. Jika diisi, klien harus menampilkan hasil eksekusi dengan ID yang cocok di ToolResponse.
displayName

string

Hanya output. Nama tampilan alat.
args

object (Struct format)

Opsional. Parameter dan nilai input untuk alat dalam format objek JSON.
parentToolCallId

string

Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
agentName

string

Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Arsitek Kontrak". Kosong saat dikeluarkan oleh agen root.
Kolom union tool_identifier. ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari set alat. tool_identifier hanya ada berupa salah satu diantara berikut:
tool

string

Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Opsional. Alat toolset yang akan dieksekusi.

ToolsetTool

Representasi JSON 
{
  "toolset": string,
  "toolId": string
}
Kolom
toolset

string

Wajib. Nama resource Toolset dari mana alat ini berasal. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolId

string

Opsional. ID alat untuk memfilter alat yang akan diambil skemanya.

ToolResponse

Representasi JSON 
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Kolom
id

string

Opsional. ID yang cocok dari tool call yang menjadi tujuan respons.
displayName

string

Hanya output. Nama tampilan alat.
response

object (Struct format)

Wajib. Hasil eksekusi alat dalam format objek JSON. Gunakan kunci "output" untuk menentukan respons alat dan kunci "error" untuk menentukan detail error (jika ada). Jika kunci "output" dan "error" tidak ditentukan, seluruh "respons" akan diperlakukan sebagai hasil eksekusi alat.
parentToolCallId

string

Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
agentName

string

Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Arsitek Kontrak". Kosong saat dikeluarkan oleh agen root.
Kolom union tool_identifier. ID alat yang dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari set alat. tool_identifier hanya ada berupa salah satu diantara berikut:
tool

string

Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Opsional. Alat toolset yang dieksekusi.

AgentTransfer

Representasi JSON 
{
  "targetAgent": string,
  "displayName": string
}
Kolom
targetAgent

string

Wajib. Agen yang menjadi tujuan pengalihan percakapan. Agen akan menangani percakapan mulai saat ini. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Hanya output. Nama tampilan agen.

Pagar pengaman

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "action": {
    object (TriggerAction)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field guardrail_type can be only one of the following:
  "contentFilter": {
    object (ContentFilter)
  },
  "llmPromptSecurity": {
    object (LlmPromptSecurity)
  },
  "llmPolicy": {
    object (LlmPolicy)
  },
  "modelSafety": {
    object (ModelSafety)
  },
  "codeCallback": {
    object (CodeCallback)
  }
  // End of list of possible types for union field guardrail_type.
}
Kolom
name

string

ID. ID unik pembatas. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
displayName

string

Wajib. Nama tampilan pembatas.
description

string

Opsional. Deskripsi pembatasan.
enabled

boolean

Opsional. Apakah pembatasan diaktifkan atau tidak.
action

object (TriggerAction)

Opsional. Tindakan yang harus dilakukan saat batasan pengaman dipicu.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat pembatasan 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: "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. Stempel waktu saat batas aman 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
Kolom union guardrail_type. Jenis pembatasan. guardrail_type hanya ada berupa salah satu diantara berikut:
contentFilter

object (ContentFilter)

Opsional. Pembatasan yang melarang penggunaan konten tertentu dalam percakapan.
llmPromptSecurity

object (LlmPromptSecurity)

Opsional. Pembatas yang memblokir percakapan jika perintah dianggap tidak aman berdasarkan klasifikasi LLM.
llmPolicy

object (LlmPolicy)

Opsional. Penjaga yang memblokir percakapan jika respons LLM dianggap melanggar kebijakan berdasarkan klasifikasi LLM.
modelSafety

object (ModelSafety)

Opsional. Membatasi percakapan jika respons LLM dianggap tidak aman berdasarkan setelan keamanan model.
codeCallback

object (CodeCallback)

Opsional. Pembatas yang berpotensi memblokir percakapan berdasarkan hasil eksekusi callback.

ContentFilter

Representasi JSON 
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean
}
Kolom
bannedContents[]

string

Opsional. Daftar frasa yang dilarang. Berlaku untuk input pengguna dan respons agen.
bannedContentsInUserInput[]

string

Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk input pengguna.
bannedContentsInAgentResponse[]

string

Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk respons agen.
matchType

enum (MatchType)

Wajib. Jenis pencocokan untuk filter konten.
disregardDiacritics

boolean

Opsional. Jika benar (true), diakritik diabaikan selama pencocokan.

LlmPromptSecurity

Representasi JSON 
{
  "failOpen": boolean,

  // Union field security_config can be only one of the following:
  "defaultSettings": {
    object (DefaultSecuritySettings)
  },
  "customPolicy": {
    object (LlmPolicy)
  }
  // End of list of possible types for union field security_config.
}
Kolom
failOpen

boolean

Opsional. Menentukan perilaku saat batasan pengaman mengalami error LLM. - Jika benar (true): batas aman dilewati. - Jika salah (default): pembatasan akan dipicu/diblokir.

Catatan: Jika kebijakan kustom diberikan, kolom ini akan diabaikan dan digantikan oleh konfigurasi 'fail_open' kebijakan.
Kolom union security_config. Menentukan mode konfigurasi keamanan. Pengguna harus memilih salah satu konfigurasi berikut. security_config hanya ada berupa salah satu diantara berikut:
defaultSettings

object (DefaultSecuritySettings)

Opsional. Menggunakan setelan keamanan default yang telah ditentukan sebelumnya oleh sistem. Untuk memilih mode ini, sertakan pesan 'default_settings' kosong dalam permintaan. Kolom 'default_prompt_template' di dalamnya akan diisi oleh server dalam respons.
customPolicy

object (LlmPolicy)

Opsional. Gunakan LlmPolicy yang ditentukan pengguna untuk mengonfigurasi pembatasan keamanan.

DefaultSecuritySettings

Representasi JSON 
{
  "defaultPromptTemplate": string
}
Kolom
defaultPromptTemplate

string

Hanya output. Template perintah default yang digunakan oleh sistem. Kolom ini digunakan untuk tujuan tampilan guna menunjukkan kepada pengguna perintah apa yang digunakan sistem secara default. Ini adalah OUTPUT_ONLY.

LlmPolicy

Representasi JSON 
{
  "maxConversationMessages": integer,
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "policyScope": enum (PolicyScope),
  "failOpen": boolean,
  "allowShortUtterance": boolean
}
Kolom
maxConversationMessages

integer

Opsional. Saat memeriksa kebijakan ini, pertimbangkan 'n' pesan terakhir dalam percakapan. Jika tidak ditetapkan, nilai default 10 akan digunakan.
modelSettings

object (ModelSettings)

Opsional. Setelan model.
prompt

string

Wajib. Perintah kebijakan.
policyScope

enum (PolicyScope)

Wajib. Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan. Jika disetel ke POLICY_SCOPE_UNSPECIFIED, kebijakan akan diterapkan ke input pengguna. Saat menerapkan kebijakan ke respons agen, latensi tambahan akan terjadi sebelum agen dapat merespons.
failOpen

boolean

Opsional. Jika terjadi error selama pemeriksaan kebijakan, buka dan jangan memicu pembatasan.
allowShortUtterance

boolean

Opsional. Secara default, pemeriksaan kebijakan LLM dilewati untuk ucapan singkat. Jika diaktifkan, setelan ini akan menerapkan pemeriksaan kebijakan ke semua ucapan, termasuk yang biasanya dilewati.

ModelSafety

Representasi JSON 
{
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ]
}
Kolom
safetySettings[]

object (SafetySetting)

Wajib. Daftar setelan keamanan.

SafetySetting

Representasi JSON 
{
  "category": enum (HarmCategory),
  "threshold": enum (HarmBlockThreshold)
}
Kolom
category

enum (HarmCategory)

Wajib. Kategori bahaya.
threshold

enum (HarmBlockThreshold)

Wajib. Ambang batas pemblokiran bahaya.

CodeCallback

Representasi JSON 
{
  "beforeAgentCallback": {
    object (Callback)
  },
  "afterAgentCallback": {
    object (Callback)
  },
  "beforeModelCallback": {
    object (Callback)
  },
  "afterModelCallback": {
    object (Callback)
  }
}
Kolom
beforeAgentCallback

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.
afterAgentCallback

object (Callback)

Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.
beforeModelCallback

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.
afterModelCallback

object (Callback)

Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.

TriggerAction

Representasi JSON 
{

  // Union field action can be only one of the following:
  "respondImmediately": {
    object (RespondImmediately)
  },
  "transferAgent": {
    object (TransferAgent)
  },
  "generativeAnswer": {
    object (GenerativeAnswer)
  }
  // End of list of possible types for union field action.
}
Kolom
Kolom union action. Tindakan yang harus dilakukan. action hanya ada berupa salah satu diantara berikut:
respondImmediately

object (RespondImmediately)

Opsional. Segera merespons dengan respons yang telah dikonfigurasi sebelumnya.
transferAgent

object (TransferAgent)

Opsional. Mentransfer percakapan ke agen lain.
generativeAnswer

object (GenerativeAnswer)

Opsional. Memberikan respons dengan jawaban generatif.

RespondImmediately

Representasi JSON 
{
  "responses": [
    {
      object (Response)
    }
  ]
}
Kolom
responses[]

object (Response)

Wajib. Template pesan yang dapat dipilih agen. Respons dipilih secara acak.

Respons

Representasi JSON 
{
  "text": string,
  "disabled": boolean
}
Kolom
text

string

Wajib. Teks yang akan digunakan agen untuk merespons.
disabled

boolean

Opsional. Apakah respons dinonaktifkan. Respons yang dinonaktifkan tidak digunakan oleh agen.

TransferAgent

Representasi JSON 
{
  "agent": string
}
Kolom
agent

string

Wajib. Nama agen yang akan menerima transfer percakapan. Agen harus berada di aplikasi yang sama dengan agen saat ini. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

Representasi JSON 
{
  "prompt": string
}
Kolom
prompt

string

Wajib. Perintah yang akan digunakan untuk jawaban generatif.

Toolset

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Kolom
name

string

ID. ID unik toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

Opsional. Nama tampilan toolset. Harus unik dalam aplikasi yang sama.
description

string

Opsional. Deskripsi toolset.
timeout

string (Duration format)

Opsional. Waktu tunggu untuk eksekusi toolset. Jika tidak ditetapkan, waktu tunggu default adalah 30 detik untuk toolset SYNCHRONOUS dan 60 detik untuk toolset ASYNCHRONOUS.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat toolset 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: "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. Stempel waktu saat toolset 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
executionType

enum (ExecutionType)

Opsional. Jenis eksekusi alat dalam toolset.
toolFakeConfig

object (ToolFakeConfig)

Opsional. Konfigurasi untuk perilaku alat dalam mode palsu.
Kolom union toolset_type. Jenis toolset. toolset_type hanya ada berupa salah satu diantara berikut:
mcpToolset

object (McpToolset)

Opsional. Toolset yang berisi daftar alat yang ditawarkan oleh server MCP.
openApiToolset

object (OpenApiToolset)

Opsional. Toolset yang berisi daftar alat yang ditentukan oleh skema OpenAPI.
connectorToolset

object (ConnectorToolset)

Opsional. Kumpulan alat yang membuat alat dari Koneksi Integration Connectors.

McpToolset

Representasi JSON 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Kolom
serverAddress

string

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. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
apiAuthentication

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan untuk mengakses alat dan 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.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
customHeaders

map (key: string, value: string)

Opsional. Header kustom yang akan dikirim dalam permintaan ke server MCP. Nilai harus dalam format $context.variables.<name_of_variable> dan dapat ditetapkan dalam variabel sesi. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection untuk mengetahui detail selengkapnya.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
toolOverrides[]

object (McpToolOverride)

Opsional. Penggantian untuk setiap alat dalam set alat ini. Hal ini memungkinkan penggantian detail tertentu seperti deskripsi, nama, atau menyematkan status alat sehingga tidak sepenuhnya dinamis.

CustomHeadersEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

McpToolOverride

Representasi JSON 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Kolom
tool

string

Wajib. Nama asli alat saat dikeluarkan oleh server MCP.
nameOverride

string

Opsional. Jika ada, alat ini menggunakan nama ini di Agen, bukan nama asli. Ini terutama digunakan sebagai alias jika server MCP menawarkan alat yang namanya kurang baik.
descriptionOverride

string

Opsional. Jika ada, alat ini akan menggunakan deskripsi ini, bukan deskripsi asli dari server.
snapshot

object (McpToolDefinition)

Hanya output. Jika ada, alat ini akan "Disematkan" dan menggunakan nilai snapshot sebagai penggantian jika server tidak tersedia untuk sementara atau jika tidak ada Penggantian.

McpToolDefinition

Representasi JSON 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Kolom
description

string

Hanya output. Deskripsi alat MCP. Nilai ini dapat diganti oleh description_override di McpToolOverride.
inputSchema

object (Schema)

Hanya output. Skema argumen input alat MCP.
outputSchema

object (Schema)

Hanya output. Skema argumen output alat MCP.

OpenApiToolset

Representasi JSON 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Kolom
openApiSchema

string

Wajib. Skema OpenAPI toolset.
apiAuthentication

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan oleh API.
tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan.
ignoreUnknownFields

boolean

Opsional. Jika benar, agen akan mengabaikan kolom yang tidak diketahui dalam respons API untuk semua operasi yang ditentukan dalam skema OpenAPI.
url

string

Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di toolset 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.

ConnectorToolset

Representasi JSON 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Kolom
connection

string

Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

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 Toolset akan gagal. Lihat: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connectorActions[]

object (Action)

Wajib. Daftar tindakan konektor/operasi entitas untuk membuat alat.

PrebuiltAmbientNoise

Suara bising di sekitar yang sudah dibuat.

Enum
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Tidak ditentukan.
RETAIL_STORE Derau sekitar toko retail.
CONVENTION_HALL Suara bising di sekitar ruang konvensi.
OUTDOOR Suara bising di sekitar jalan.

ErrorHandlingStrategy

Menentukan strategi untuk menangani error.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED Strategi penanganan error tidak ditentukan.
NONE Tidak ada penanganan khusus yang diaktifkan.
FALLBACK_RESPONSE Pesan pengganti akan ditampilkan kepada pengguna jika terjadi error sistem (misalnya, error LLM).
END_SESSION Sinyal EndSession akan dipancarkan jika terjadi error sistem (misalnya, error LLM).

ToolExecutionMode

Menentukan perilaku eksekusi alat jika ada beberapa alat yang dipilih oleh agen secara bersamaan.

Enum
TOOL_EXECUTION_MODE_UNSPECIFIED Mode eksekusi alat tidak ditentukan. Nilai defaultnya adalah PARALEL.
PARALLEL Jika ada beberapa alat yang dipilih, alat tersebut akan dieksekusi secara paralel, dengan ToolContext yang sama.
SEQUENTIAL Jika ada beberapa alat yang dipilih, alat tersebut akan dijalankan secara berurutan. Alat berikutnya hanya akan dieksekusi setelah alat sebelumnya selesai dan dapat melihat ToolContext yang diperbarui dari alat sebelumnya.

SemanticSimilarityChannel

Saluran kemiripan semantik yang akan digunakan.

Enum
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Metrik tidak ditentukan. Nilai defaultnya adalah TEXT.
TEXT Menggunakan kemiripan semantik teks.
AUDIO Gunakan kesamaan semantik audio.

ExtraToolCallBehavior

Menentukan perilaku saat panggilan alat tambahan ditemukan. Panggilan alat tambahan adalah panggilan alat yang ada dalam eksekusi, tetapi tidak cocok dengan panggilan alat apa pun dalam ekspektasi standar.

Enum
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Perilaku tidak ditentukan. Nilai defaultnya adalah GAGAL.
FAIL Gagal dalam evaluasi jika panggilan alat tambahan ditemukan.
ALLOW Izinkan panggilan alat tambahan.

HallucinationMetricBehavior

Perilaku metrik halusinasi. Terlepas dari perilaku tersebut, metrik akan selalu dihitung. Perbedaannya adalah bahwa jika dinonaktifkan, metrik tidak digunakan untuk menghitung skor evaluasi keseluruhan.

Enum
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Perilaku metrik halusinasi tidak ditentukan.
DISABLED Nonaktifkan metrik halusinasi.
ENABLED Aktifkan metrik halusinasi.

Jenis

Jenis data OpenAPI.

Enum
TYPE_UNSPECIFIED Jenis tidak ditentukan.
STRING Jenis string.
INTEGER Jenis bilangan bulat.
NUMBER Jenis angka.
BOOLEAN Jenis Boolean.
OBJECT Jenis objek.
ARRAY Jenis array.

NullValue

Mewakili JSON null.

NullValue adalah sentinel, menggunakan enum dengan hanya satu nilai untuk merepresentasikan nilai null untuk gabungan jenis Value.

Kolom berjenis NullValue dengan nilai selain 0 dianggap tidak valid. Sebagian besar serializer ProtoJSON akan memancarkan Value dengan null_value yang ditetapkan sebagai null JSON, terlepas dari nilai bilangan bulatnya, dan akan melakukan perjalanan pulang pergi ke nilai 0.

Enum
NULL_VALUE Nilai null.

Jenis

Jenis mesin. Lihat dokumentasi yang tersedia di https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType dan https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enum
TYPE_UNSPECIFIED Jenis mesin tidak ditentukan.
ENGINE_TYPE_CHAT Jenis mesin chat. Mesin SOLUTION_TYPE_CHAT untuk aplikasi. Semua penyimpanan data konektor yang ditambahkan ke aplikasi akan ditambahkan ke mesin ini.

ChannelType

Jenis profil channel.

Enum
UNKNOWN Jenis channel tidak diketahui.
WEB_UI Saluran UI Web.
API Saluran API.
TWILIO Saluran Twilio.
GOOGLE_TELEPHONY_PLATFORM Channel Google Telephony Platform.
CONTACT_CENTER_AS_A_SERVICE Saluran Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT Saluran Contact Center as a Service (CCaaS Chat).
FIVE9 Channel Five9.
CONTACT_CENTER_INTEGRATION Saluran integrasi pusat kontak pihak ketiga.
WHATSAPP Saluran WhatsApp.
INSTAGRAM Saluran Instagram.

Persona

Persona channel.

Enum
UNKNOWN Persona TIDAK DIKENAL.
CONCISE Agen menjaga agar respons tetap ringkas dan langsung ke intinya
CHATTY Agen memberikan konteks, penjelasan, dan detail tambahan

Modalitas

Modalitas widget web.

Enum
MODALITY_UNSPECIFIED Modalitas tidak diketahui.
CHAT_AND_VOICE Widget mendukung input chat dan suara.
VOICE_ONLY Widget hanya mendukung input suara.
CHAT_ONLY Widget hanya mendukung input chat.
CHAT_VOICE_AND_VIDEO Widget mendukung input chat, suara, dan video.

Tema

Tema widget web.

Enum
THEME_UNSPECIFIED Tema tidak diketahui.
LIGHT Tema terang.
DARK Tema gelap.

Arah

Arah transfer.

Enum
DIRECTION_UNSPECIFIED Arah tidak ditentukan.
PARENT_TO_CHILD Transfer dari agen induk ke agen turunan.
CHILD_TO_PARENT Transfer dari agen turunan ke agen induk.

RequestLocation

Lokasi kunci API dalam permintaan.

Enum
REQUEST_LOCATION_UNSPECIFIED Tidak ditentukan. Nilai ini tidak boleh digunakan.
HEADER Merepresentasikan kunci di header http.
QUERY_STRING Mewakili kunci dalam string kueri.

OauthGrantType

Jenis pemberian izin OAuth. Hanya pemberian kredensial klien yang didukung.

Enum
OAUTH_GRANT_TYPE_UNSPECIFIED Tidak ditentukan. Default-nya adalah CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Mewakili alur kredensial klien.

OperationType

Operasi yang akan dilakukan pada entity.

Enum
OPERATION_TYPE_UNSPECIFIED Jenis operasi tidak ditentukan. Tidak valid, pembuatan/pembaruan ConnectorTool akan gagal.
LIST Operasi daftar.
GET Mendapatkan operasi.
CREATE Buat operasi.
UPDATE Operasi update.
DELETE Hapus operasi.

DataStoreType

Jenis penyimpanan data.

Enum
DATA_STORE_TYPE_UNSPECIFIED Tidak ditentukan. Nilai ini menunjukkan bahwa jenis penyimpanan data tidak ditentukan, sehingga tidak akan digunakan selama penelusuran.
PUBLIC_WEB Penyimpanan data yang berisi konten web publik.
UNSTRUCTURED Penyimpanan data yang berisi data pribadi tidak terstruktur.
FAQ Penyimpanan data yang berisi data terstruktur yang digunakan sebagai FAQ.
CONNECTOR Penyimpanan data yang merupakan konektor ke layanan pihak pertama atau pihak ketiga.

DocumentProcessingMode

Mode pemrosesan dokumen penyimpanan data.

Enum
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Tidak ditentukan.
DOCUMENTS Dokumen diproses sebagai dokumen.
CHUNKS Dokumen dikonversi menjadi potongan.

AttributeType

Atribut(atau fungsi) yang akan diterapkan peringkat kustomnya.

Enum
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType tidak ditentukan.
NUMERICAL Nilai kolom numerik akan digunakan untuk memperbarui jumlah peningkat secara dinamis. Dalam hal ini, attribute_value (nilai x) titik kontrol akan menjadi nilai sebenarnya dari kolom numerik yang boost_amount-nya ditentukan.
FRESHNESS Untuk kasus penggunaan keaktualan, nilai atribut akan berupa durasi antara waktu saat ini dan tanggal di kolom datetime yang ditentukan. Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]]. Mis. 5D, 3DT12H30M, T24H.

InterpolationType

Jenis interpolasi yang akan diterapkan. Defaultnya adalah linear (Piecewise Linear).

Enum
INTERPOLATION_TYPE_UNSPECIFIED Jenis interpolasi tidak ditentukan. Dalam hal ini, nilai defaultnya adalah Linear.
LINEAR Interpolasi linear sepotong-sepotong akan diterapkan.

ModalityType

Jenis modalitas.

Enum
MODALITY_TYPE_UNSPECIFIED Jenis modalitas tidak ditentukan.
TEXT Modalitas teks.
AUDIO Modalitas audio.

FilterParameterBehavior

Perilaku parameter filter.

Enum
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Perilaku filter default. Sertakan parameter filter untuk penyimpanan data konektor. Untuk jenis datastore lainnya, parameter input filter dihilangkan.
ALWAYS_INCLUDE Selalu sertakan parameter filter untuk semua jenis penyimpanan data.
NEVER_INCLUDE Parameter filter tidak pernah disertakan dalam daftar parameter alat, terlepas dari jenis datastore.

Negara Bagian

Mewakili status ketersediaan dinamis alat.

Enum
STATE_UNSPECIFIED Status default.
ACTIVE Alat ini tersedia dan ditawarkan secara aktif oleh server.
INACTIVE Alat dikonfigurasi atau disematkan, tetapi saat ini tidak ditawarkan oleh server.
STALE Alat ada di server, tetapi tidak cocok dengan versi di server.

CorpusType

Jenis korpus RAG Vertex.

Enum
CORPUS_TYPE_UNSPECIFIED Jenis korpus tidak ditentukan.
USER_OWNED Korpus dibuat dan dimiliki oleh pengguna.
FULLY_MANAGED Korpus dibuat oleh agen.

WidgetType

Semua jenis widget yang tersedia. Nilai baru dapat ditambahkan ke enum ini pada masa mendatang.

Enum
WIDGET_TYPE_UNSPECIFIED Jenis widget tidak ditentukan.
CUSTOM Jenis widget kustom.
PRODUCT_DETAILS Widget detail produk.
QUICK_ACTIONS Widget tindakan cepat.
PRODUCT_COMPARISON Widget perbandingan produk.
ADVANCED_PRODUCT_DETAILS Widget detail produk lanjutan.
SHORT_FORM Widget bentuk pendek.
OVERALL_SATISFACTION Widget kepuasan secara keseluruhan.
ORDER_SUMMARY Widget ringkasan pesanan.
APPOINTMENT_DETAILS Widget detail janji temu.
APPOINTMENT_SCHEDULER Widget penjadwal janji temu.
CONTACT_FORM Widget formulir kontak.

Mode

Strategi yang digunakan untuk memetakan data dari alat sumber ke widget.

Enum
MODE_UNSPECIFIED Mode tidak ditentukan.
FIELD_MAPPING Gunakan peta field_mappings untuk transformasi data.
PYTHON_SCRIPT Gunakan python_script untuk transformasi data.

Jenis

Menentukan cara menghasilkan respons teks.

Enum
TYPE_UNSPECIFIED Jenis tidak ditentukan.
NONE LLM secara dinamis memutuskan apakah akan menghasilkan respons teks bersama widget berdasarkan konteks percakapan.
LLM_GENERATED LLM secara eksplisit diwajibkan untuk menghasilkan respons teks.
STATIC Respons teks statis yang telah ditentukan selalu digunakan.

ExecutionType

Jenis eksekusi alat atau set alat.

Enum
EXECUTION_TYPE_UNSPECIFIED Jenis eksekusi tidak ditentukan. Nilai defaultnya adalah SYNCHRONOUS jika tidak ditentukan.
SYNCHRONOUS Alat dijalankan secara sinkron. Sesi diblokir hingga alat kembali.
ASYNCHRONOUS Alat ini dieksekusi secara asinkron. Sesi akan berlanjut saat alat dijalankan.

MatchType

Jenis pencocokan untuk filter konten.

Enum
MATCH_TYPE_UNSPECIFIED Jenis pencocokan tidak ditentukan.
SIMPLE_STRING_MATCH Konten dicocokkan untuk substring karakter demi karakter.
WORD_BOUNDARY_STRING_MATCH Konten hanya cocok jika pola yang ditemukan dalam teks diapit oleh pembatas kata. Frasa yang dilarang juga dapat berisi pembatas kata.
REGEXP_MATCH Konten dicocokkan menggunakan sintaksis regular expression.

PolicyScope

Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan.

Enum
POLICY_SCOPE_UNSPECIFIED Cakupan kebijakan tidak ditentukan.
USER_QUERY Pemeriksaan kebijakan dipicu saat input pengguna.
AGENT_RESPONSE Pemeriksaan kebijakan dipicu pada respons agen. Menerapkan cakupan kebijakan ini akan menimbulkan latensi tambahan sebelum agen dapat merespons.
USER_QUERY_AND_AGENT_RESPONSE Pemeriksaan kebijakan dipicu pada input pengguna dan respons agen. Menerapkan cakupan kebijakan ini akan menimbulkan latensi tambahan sebelum agen dapat merespons.

HarmCategory

Kategori bahaya.

Enum
HARM_CATEGORY_UNSPECIFIED Kategori bahaya tidak ditentukan.
HARM_CATEGORY_HATE_SPEECH Kategori bahaya adalah ujaran kebencian.
HARM_CATEGORY_DANGEROUS_CONTENT Kategori bahayanya adalah konten berbahaya.
HARM_CATEGORY_HARASSMENT Kategori bahaya adalah pelecehan.
HARM_CATEGORY_SEXUALLY_EXPLICIT Kategori bahayanya adalah konten seksual vulgar.
HARM_CATEGORY_PROFANITY Kategori bahaya adalah kata-kata tidak sopan.
HARM_CATEGORY_TOXIC Kategori bahayanya adalah beracun.

HarmBlockThreshold

Tingkat nilai minimum berbasis probabilitas untuk pemblokiran.

Enum
HARM_BLOCK_THRESHOLD_UNSPECIFIED Batas blokir bahaya tidak ditentukan.
BLOCK_LOW_AND_ABOVE Blokir batas rendah dan lebih tinggi (yaitu, blokir lebih banyak).
BLOCK_MEDIUM_AND_ABOVE Blokir batas sedang dan lebih tinggi.
BLOCK_ONLY_HIGH Ambang batas Block only high (yaitu, blokir lebih sedikit).
BLOCK_NONE Tidak memblokir apa pun.
OFF Nonaktifkan filter keamanan.

Skema Output

Di Customer Engagement Suite (CES), versi aplikasi adalah snapshot aplikasi pada titik waktu tertentu. Objek ini tidak dapat diubah dan tidak dapat dimodifikasi setelah dibuat.

AppVersion

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "snapshot": {
    object (AppSnapshot)
  },
  "etag": string
}
Kolom
name

string

ID. ID unik versi aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
displayName

string

Opsional. Nama tampilan versi aplikasi.
description

string

Opsional. Deskripsi versi aplikasi.
creator

string

Hanya output. Email pengguna yang membuat versi aplikasi.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat versi aplikasi 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
snapshot

object (AppSnapshot)

Hanya output. Snapshot aplikasi saat versi dibuat.
etag

string

Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

Stempel waktu

Representasi JSON 
{
  "seconds": string,
  "nanos": integer
}
Kolom
seconds

string (int64 format)

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

integer

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 nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif.

AppSnapshot

Representasi JSON 
{
  "app": {
    object (App)
  },
  "agents": [
    {
      object (Agent)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "examples": [
    {
      object (Example)
    }
  ],
  "guardrails": [
    {
      object (Guardrail)
    }
  ],
  "toolsets": [
    {
      object (Toolset)
    }
  ]
}
Kolom
app

object (App)

Opsional. Setelan dasar untuk aplikasi.
agents[]

object (Agent)

Opsional. Daftar agen di aplikasi.
tools[]

object (Tool)

Opsional. Daftar alat di aplikasi.
examples[]

object (Example)

Opsional. Daftar contoh dalam aplikasi.
guardrails[]

object (Guardrail)

Opsional. Daftar pembatasan dalam aplikasi.
toolsets[]

object (Toolset)

Opsional. Daftar toolset di aplikasi.

Aplikasi

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
Kolom
name

string

ID. ID unik aplikasi. Format: projects/{project}/locations/{location}/apps/{app}
displayName

string

Wajib. Nama tampilan aplikasi.
description

string

Opsional. Deskripsi aplikasi yang dapat dibaca manusia.
pinned

boolean

Opsional. Apakah aplikasi disematkan dalam daftar aplikasi.
rootAgent

string

Opsional. Agen root adalah titik entri aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

Opsional. Setelan bahasa aplikasi.
timeZoneSettings

object (TimeZoneSettings)

Opsional. Setelan TimeZone aplikasi.
audioProcessingConfig

object (AudioProcessingConfig)

Opsional. Konfigurasi pemrosesan audio aplikasi.
loggingSettings

object (LoggingSettings)

Opsional. Setelan pencatatan log aplikasi.
errorHandlingSettings

object (ErrorHandlingSettings)

Opsional. Menangani error setelan aplikasi.
modelSettings

object (ModelSettings)

Opsional. Setelan model LLM default untuk aplikasi. Setiap resource (misalnya, agen, pembatas) dapat mengganti konfigurasi ini sesuai kebutuhan.
toolExecutionMode

enum (ToolExecutionMode)

Opsional. Mode eksekusi alat untuk aplikasi. Jika tidak diberikan, defaultnya adalah PARALLEL.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Opsional. Batas evaluasi untuk aplikasi.
variableDeclarations[]

object (VariableDeclaration)

Opsional. Deklarasi variabel.
predefinedVariableDeclarations[]

object (VariableDeclaration)

Hanya output. Deklarasi variabel yang telah ditentukan sebelumnya untuk aplikasi.
globalInstruction

string

Opsional. Petunjuk untuk semua agen di aplikasi. Anda dapat menggunakan petunjuk ini untuk menyiapkan identitas atau kepribadian yang stabil di semua agen.
guardrails[]

string

Opsional. Daftar pembatasan untuk aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

Opsional. Setelan penyimpanan data untuk aplikasi.
defaultChannelProfile

object (ChannelProfile)

Opsional. Profil saluran default yang digunakan oleh aplikasi.
metadata

map (key: string, value: string)

Opsional. Metadata tentang aplikasi. Kolom ini dapat digunakan untuk menyimpan informasi tambahan yang relevan dengan detail atau penggunaan yang dimaksudkan dari aplikasi.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat aplikasi 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: "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. Stempel waktu saat aplikasi 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
deploymentCount

integer

Hanya output. Jumlah deployment di aplikasi.
clientCertificateSettings

object (ClientCertificateSettings)

Opsional. Setelan sertifikat klien default untuk aplikasi.
vpcScSettings

object (VpcScSettings)

Opsional. Setelan VPC-SC untuk aplikasi.
locked

boolean

Opsional. Menunjukkan apakah aplikasi dikunci untuk perubahan. Jika aplikasi dikunci, modifikasi pada resource aplikasi akan ditolak.
validationErrors[]

string

Hanya output. Kesalahan konfigurasi atau peringatan di aplikasi.
dashboardSettings

object (DashboardSettings)

Opsional. Setelan dasbor khusus aplikasi untuk menautkan dan mengonfigurasi dasbor Contact Center Insights.

LanguageSettings

Representasi JSON 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
Kolom
defaultLanguageCode

string

Opsional. Kode bahasa default aplikasi.
supportedLanguageCodes[]

string

Opsional. Daftar kode bahasa yang didukung oleh aplikasi, selain default_language_code.
enableMultilingualSupport

boolean

Opsional. Mengaktifkan dukungan multibahasa. Jika benar (true), agen di aplikasi akan menggunakan petunjuk bawaan untuk meningkatkan penanganan input multibahasa.
fallbackAction
(deprecated)

string

Opsional. Tidak digunakan lagi: Fitur ini tidak lagi didukung. Gunakan enable_multilingual_support sebagai gantinya untuk meningkatkan penanganan input multibahasa. Tindakan yang harus dilakukan saat agen menerima input dalam bahasa yang tidak didukung.

Tindakan ini dapat berupa tindakan standar atau panggilan alat kustom. Nilai yang valid adalah: - Nama lengkap resource alat, yang memicu eksekusi alat tertentu. - Tindakan sistem yang telah ditentukan sebelumnya, seperti "eskalasikan" atau "keluar", yang memicu sinyal EndSession dengan metadata yang sesuai untuk mengakhiri percakapan.

TimeZoneSettings

Representasi JSON 
{
  "timeZone": string
}
Kolom
timeZone

string

Opsional. Zona waktu aplikasi dari database zona waktu, misalnya, America/Los_Angeles, Europe/Paris.

AudioProcessingConfig

Representasi JSON 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  }
}
Kolom
synthesizeSpeechConfigs

map (key: string, value: object (SynthesizeSpeechConfig))

Opsional. Konfigurasi cara respons agen harus disintesis, pemetaan dari kode bahasa ke SynthesizeSpeechConfig.

Jika konfigurasi untuk kode bahasa yang ditentukan tidak ditemukan, konfigurasi untuk kode bahasa root akan digunakan. Misalnya, jika peta berisi "en-us" dan "en", dan kode bahasa yang ditentukan adalah "en-gb", maka konfigurasi "en" akan digunakan.

Catatan: Kode bahasa tidak peka huruf besar/kecil.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
bargeInConfig

object (BargeInConfig)

Opsional. Mengonfigurasi perilaku agen untuk aktivitas interupsi pengguna.
inactivityTimeout

string (Duration format)

Opsional. Durasi tidak aktif pengguna (tidak ada ucapan atau interaksi) sebelum agen meminta pengguna untuk berinteraksi kembali. Jika tidak disetel, agen tidak akan meminta pengguna untuk berinteraksi kembali.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
ambientSoundConfig

object (AmbientSoundConfig)

Opsional. Konfigurasi untuk suara sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan.

SynthesizeSpeechConfigsEntry

Representasi JSON 
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
Kolom
key

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

Representasi JSON 
{
  "voice": string,
  "voiceSampleGcsUri": string,
  "speakingRate": number,
  "model": string,
  "instruction": string,
  "consentAudioGcsUri": string
}
Kolom
voice

string

Opsional. Nama suara. Jika tidak disetel, layanan akan memilih suara berdasarkan parameter lain seperti language_code.

Untuk mengetahui daftar suara yang tersedia, lihat Suara dan bahasa yang didukung dari Cloud Text-to-Speech.
voiceSampleGcsUri
(deprecated)

string

Opsional. Tidak digunakan lagi: Gunakan custom_voice_samples di AudioProcessingConfig sebagai gantinya.

Cloud Storage URI ke sampel audio untuk kloning suara. Contoh audio harus berupa file WAV 24 kHz satu saluran.

Catatan: Pastikan agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com memiliki izin storage.objects.get ke objek Cloud Storage.
speakingRate

number

Opsional. Kecepatan bicara dalam rentang [0,25, 2,0]. 1,0 adalah kecepatan native normal yang didukung oleh suara tertentu. 2,0 adalah dua kali lebih cepat, dan 0,5 adalah setengahnya. Nilai di luar rentang [0,25, 2,0] akan menampilkan error.
model

string

Opsional. Model yang digunakan untuk menyintesis audio. Nilai yang saat ini didukung: - "gemini-3.1-flash-tts-preview" Jika kosong, Chirp3-HD akan digunakan.
instruction

string

Opsional. Petunjuk yang digunakan untuk menyintesis ucapan saat menggunakan model generatif.
consentAudioGcsUri
(deprecated)

string

Opsional. Tidak digunakan lagi: Gunakan custom_voice_samples di AudioProcessingConfig sebagai gantinya.

Cloud Storage URI untuk audio izin bagi kloning suara.

BargeInConfig

Representasi JSON 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
Kolom
disableBargeIn
(deprecated)

boolean

Opsional. Tidak digunakan lagi: disable_barge_in tidak digunakan lagi dan digantikan dengan disable_barge_in_control di ChannelProfile.

Menonaktifkan interupsi pengguna saat agen sedang berbicara. Jika benar (true), input pengguna selama pemutaran respons agen akan diabaikan.
bargeInAwareness

boolean

Opsional. Jika diaktifkan, agen akan menyesuaikan respons berikutnya berdasarkan asumsi bahwa pengguna belum mendengar pesan agen sebelumnya secara keseluruhan. Hal ini tidak boleh digunakan dalam skenario saat respons agen ditampilkan secara visual.

Durasi

Representasi JSON 
{
  "seconds": string,
  "nanos": integer
}
Kolom
seconds

string (int64 format)

Detik yang ditandatangani dari rentang waktu. Harus dari -315.576.000.000 hingga +315.576.000.000 inklusif. Catatan: batas ini dihitung dari: 60 dtk/mnt * 60 mnt/j * 24 j/hr * 365,25 hr/thn * 10.000 thn
nanos

integer

Pecahan detik bertanda pada resolusi nanodetik rentang waktu. Durasi kurang dari satu detik ditampilkan dengan kolom seconds 0 dan kolom nanos positif atau negatif. Untuk durasi satu detik atau lebih, nilai non-nol untuk kolom nanos harus memiliki tanda yang sama dengan kolom seconds. Harus dari -999.999.999 hingga +999.999.999 inklusif.

AmbientSoundConfig

Representasi JSON 
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
Kolom
volumeGainDb

number

Opsional. Peningkatan volume (dalam dB) volume native normal yang didukung oleh suara bising di sekitar, dalam rentang [-96,0, 16,0]. Jika tidak disetel, atau disetel ke nilai 0,0 (dB), akan diputar pada amplitudo sinyal native normal. Nilai -6,0 (dB) akan diputar dengan sekitar setengah amplitudo sinyal native normal. Nilai +6,0 (dB) akan diputar dengan amplitudo sinyal native normal sekitar dua kali lipat. Sebaiknya jangan melebihi +10 (dB) karena biasanya tidak ada peningkatan efektif dalam kenyaringan untuk nilai yang lebih besar dari itu.
Kolom union source. Suara bising di sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan. source hanya ada berupa salah satu diantara berikut:
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

Opsional. Tidak digunakan lagi: prebuilt_ambient_noise tidak digunakan lagi dan digantikan dengan prebuilt_ambient_sound.
gcsUri

string

Opsional. Suara bising di sekitar sebagai file WAV 16 kHz satu saluran yang disimpan di Cloud Storage.

Catatan: Pastikan agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com memiliki izin storage.objects.get ke objek Cloud Storage.
prebuiltAmbientSound

string

Opsional. Nama suara sekitar bawaan. Nilai yang valid adalah: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

LoggingSettings

Representasi JSON 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "unredactedAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "unredactedBigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
Kolom
redactionConfig

object (RedactionConfig)

Opsional. Konfigurasi cara data sensitif harus disamarkan.
audioRecordingConfig

object (AudioRecordingConfig)

Opsional. Konfigurasi cara interaksi audio harus direkam. Audio dapat disamarkan sesuai konfigurasi di RedactionConfig.
unredactedAudioRecordingConfig

object (AudioRecordingConfig)

Opsional. Mengonfigurasi rekaman tambahan audio yang tidak disamarkan. Salinan ini dapat digunakan untuk mempertahankan salinan audio mentah saat penyensoran audio adalah enabled, biasanya untuk tujuan audit atau pemantauan.
bigqueryExportSettings

object (BigQueryExportSettings)

Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan tunduk pada penyamaran seperti yang dikonfigurasi di RedactionConfig.
unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan yang tidak disamarkan akan diekspor ke tabel BigQuery jika diaktifkan.
cloudLoggingSettings

object (CloudLoggingSettings)

Opsional. Setelan untuk menjelaskan perilaku Cloud Logging untuk aplikasi.
conversationLoggingSettings

object (ConversationLoggingSettings)

Opsional. Setelan untuk menjelaskan perilaku logging percakapan untuk aplikasi.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

Opsional. Konfigurasi cara interaksi audio harus direkam untuk evaluasi. Secara default, perekaman audio tidak diaktifkan untuk sesi evaluasi.
metricAnalysisSettings

object (MetricAnalysisSettings)

Opsional. Setelan untuk menjelaskan perilaku pengumpulan data percakapan untuk pipeline analisis LLM untuk aplikasi.

RedactionConfig

Representasi JSON 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
Kolom
enableRedaction

boolean

Opsional. Jika benar (true), penyamaran akan diterapkan dalam berbagai skenario logging, termasuk histori percakapan, Cloud Logging, dan rekaman audio.
inspectTemplate

string

Opsional. Nama template inspeksi DLP untuk mengonfigurasi deteksi jenis data sensitif.

Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentifyTemplate

string

Opsional. Nama template de-identifikasi DLP untuk memberikan petunjuk tentang cara melakukan de-identifikasi konten.

Format: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

Representasi JSON 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
Kolom
gcsBucket

string

Opsional. Bucket Cloud Storage untuk menyimpan rekaman audio sesi. URI harus diawali dengan "gs://".

Pilih lokasi bucket yang memenuhi persyaratan residensi data Anda.

Catatan: Jika bucket Cloud Storage berada di project yang berbeda dari aplikasi, Anda harus memberikan izin storage.objects.create ke agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcsPathPrefix

string

Opsional. Awalan jalur Cloud Storage untuk rekaman audio.

Awalan ini dapat menyertakan placeholder berikut, yang akan diganti secara dinamis pada waktu penayangan: - $project: project ID - $location: lokasi aplikasi - $app: ID aplikasi - $date: tanggal sesi dalam format YYYY-MM-DD - $session: ID sesi

Jika awalan jalur tidak ditentukan, awalan default $project/$location/$app/$date/$session/ akan digunakan.

BigQueryExportSettings

Representasi JSON 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
Kolom
enabled

boolean

Opsional. Menunjukkan apakah BigQuery Export diaktifkan.
project

string

Opsional. Project ID set data BigQuery yang akan diekspor datanya.

Catatan: Jika set data BigQuery berada di project yang berbeda dengan aplikasi, Anda harus memberikan peran roles/bigquery.admin kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset

string

Opsional. ID set data BigQuery untuk mengekspor data.

CloudLoggingSettings

Representasi JSON 
{
  "enableCloudLogging": boolean
}
Kolom
enableCloudLogging

boolean

Opsional. Apakah akan mengaktifkan Cloud Logging untuk sesi.

ConversationLoggingSettings

Representasi JSON 
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
Kolom
disableConversationLogging

boolean

Opsional. Apakah akan menonaktifkan logging percakapan untuk sesi.
retentionWindow

string (Duration format)

Opsional. Mengontrol periode retensi untuk percakapan. Jika tidak disetel, percakapan akan dipertahankan selama 365 hari.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

MetricAnalysisSettings

Representasi JSON 
{
  "llmMetricsOptedOut": boolean
}
Kolom
llmMetricsOptedOut

boolean

Opsional. Apakah akan mengumpulkan data percakapan untuk metrik analisis LLM. Jika benar (true), data percakapan tidak akan dikumpulkan untuk metrik analisis llm; jika tidak, data percakapan akan dikumpulkan.

ErrorHandlingSettings

Representasi JSON 
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
Kolom
errorHandlingStrategy

enum (ErrorHandlingStrategy)

Opsional. Strategi yang akan digunakan untuk penanganan error.
fallbackResponseConfig

object (FallbackResponseConfig)

Opsional. Konfigurasi untuk menangani respons penggantian.
endSessionConfig

object (EndSessionConfig)

Opsional. Konfigurasi untuk mengakhiri sesi jika terjadi error sistem (misalnya, error LLM).

FallbackResponseConfig

Representasi JSON 
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
Kolom
customFallbackMessages

map (key: string, value: string)

Opsional. Pesan penggantian jika terjadi error sistem (misalnya, error LLM), dipetakan berdasarkan kode bahasa yang didukung.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxFallbackAttempts

integer

Opsional. Jumlah maksimum upaya penggantian yang harus dilakukan sebelum agen memancarkan Sinyal EndSession.

CustomFallbackMessagesEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

EndSessionConfig

Representasi JSON 
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
Kolom

Kolom union _escalate_session.

_escalate_session hanya dapat berupa salah satu dari hal berikut:
escalateSession

boolean

Opsional. Apakah akan meningkatkan sesi di EndSession. Jika sesi dilanjutkan, metadata in EndSession akan berisi session_escalated = true. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent untuk mengetahui detailnya.

ModelSettings

Representasi JSON 
{
  "model": string,

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
Kolom
model

string

Opsional. Model LLM yang harus digunakan agen. Jika tidak disetel, agen akan mewarisi model dari agen induknya.

Kolom union _temperature.

_temperature hanya dapat berupa salah satu dari hal berikut:
temperature

number

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. Temperatur yang lebih tinggi menghasilkan respons yang lebih kreatif.

EvaluationMetricsThresholds

Representasi JSON 
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
Kolom
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

Opsional. Nilai minimum metrik evaluasi emas.
hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

Opsional. Tidak digunakan lagi: Gunakan golden_hallucination_metric_behavior sebagai gantinya. Perilaku metrik halusinasi saat ini digunakan untuk evaluasi utama.
goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opsional. Perilaku metrik halusinasi untuk evaluasi golden dataset.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opsional. Perilaku metrik halusinasi untuk evaluasi skenario.

GoldenEvaluationMetricsThresholds

Representasi JSON 
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
Kolom
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

Opsional. Nilai minimum metrik tingkat belokan.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Opsional. Nilai minimum metrik tingkat ekspektasi.
toolMatchingSettings

object (ToolMatchingSettings)

Opsional. Setelan pencocokan alat. Panggilan alat tambahan adalah panggilan alat yang ada dalam eksekusi, tetapi tidak cocok dengan panggilan alat apa pun dalam ekspektasi standar.

TurnLevelMetricsThresholds

Representasi JSON 
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
Kolom
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

Opsional. Saluran kemiripan semantik yang akan digunakan untuk evaluasi.

Kolom union _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold hanya dapat berupa salah satu dari hal berikut:
semanticSimilaritySuccessThreshold

integer

Opsional. Ambang batas keberhasilan untuk kemiripan semantik. Harus berupa bilangan bulat antara 0 dan 4. Defaultnya adalah >= 3.

Kolom union _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold hanya dapat berupa salah satu dari hal berikut:
overallToolInvocationCorrectnessThreshold

number

Opsional. Ambang batas keberhasilan untuk kebenaran pemanggilan alat secara keseluruhan. Harus berupa float antara 0 dan 1. Defaultnya adalah 1.0.

ExpectationLevelMetricsThresholds

Representasi JSON 
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
Kolom

Kolom union _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold hanya dapat berupa salah satu dari hal berikut:
toolInvocationParameterCorrectnessThreshold

number

Opsional. Ambang batas keberhasilan untuk kebenaran parameter pemanggilan alat individual. Harus berupa float antara 0 dan 1. Defaultnya adalah 1.0.

ToolMatchingSettings

Representasi JSON 
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
Kolom
extraToolCallBehavior

enum (ExtraToolCallBehavior)

Opsional. Perilaku untuk panggilan alat tambahan. Nilai defaultnya adalah GAGAL.

VariableDeclaration

Representasi JSON 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
Kolom
name

string

Wajib. Nama variabel. Nama harus diawali dengan huruf atau garis bawah dan hanya berisi huruf, angka, atau garis bawah.
description

string

Wajib. Deskripsi variabel.
schema

object (Schema)

Wajib. Skema variabel.

Skema

Representasi JSON 
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
Kolom
type

enum (Type)

Wajib. Jenis data.
properties

map (key: string, value: object (Schema))

Opsional. Properti Type.OBJECT.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
required[]

string

Opsional. Properti wajib Type.OBJECT.
description

string

Opsional. Deskripsi data.
items

object (Schema)

Opsional. Skema elemen Type.ARRAY.
nullable

boolean

Opsional. Menunjukkan apakah nilai boleh berupa null.
uniqueItems

boolean

Opsional. Menunjukkan bahwa item dalam array harus unik. Hanya berlaku untuk TYPE.ARRAY.
prefixItems[]

object (Schema)

Opsional. Skema elemen awal Type.ARRAY.
additionalProperties

object (Schema)

Opsional. Dapat berupa boolean atau objek, mengontrol keberadaan properti tambahan.
anyOf[]

object (Schema)

Opsional. Nilai harus divalidasi terhadap salah satu (satu atau beberapa) subskema dalam daftar.
enum[]

string

Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. Kita dapat menentukan arah sebagai : {type:STRING, format:enum, enum:["TIMUR", NORTH", "SELATAN", "BARAT"]} 2. Kita dapat menentukan nomor apartemen sebagai : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default

value (Value format)

Opsional. Nilai default data.
ref

string

Opsional. Memungkinkan referensi tidak langsung antar-node skema. Nilai harus berupa referensi yang valid ke turunan defs akar.

Misalnya, skema berikut menentukan referensi ke node skema bernama "Pet":

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

Nilai properti "pet" adalah referensi ke node skema bernama "Pet". Lihat detailnya di https://json-schema.org/understanding-json-schema/structuring.
defs

map (key: string, value: object (Schema))

Opsional. Peta definisi untuk digunakan oleh ref. Hanya diizinkan di root skema.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
title

string

Opsional. Judul skema.
minItems

string (int64 format)

Opsional. Jumlah minimum elemen untuk Type.ARRAY.
maxItems

string (int64 format)

Opsional. Jumlah maksimum elemen untuk Type.ARRAY.

Kolom union _minimum.

_minimum hanya dapat berupa salah satu dari hal berikut:
minimum

number

Opsional. Nilai minimum untuk Type.INTEGER dan Type.NUMBER.

Kolom union _maximum.

_maximum hanya dapat berupa salah satu dari hal berikut:
maximum

number

Opsional. Nilai maksimum untuk Type.INTEGER dan Type.NUMBER.

PropertiesEntry

Representasi JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Kolom
key

string
value

object (Schema)

Nilai

Representasi JSON 
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
Kolom
Kolom union kind. Jenis nilai. kind hanya ada berupa salah satu diantara berikut:
nullValue

null

Mewakili JSON null.
numberValue

number

Mewakili angka JSON. Tidak boleh NaN, Infinity, atau -Infinity, karena tidak didukung dalam JSON. Hal ini juga tidak dapat merepresentasikan nilai Int64 besar, karena format JSON umumnya tidak mendukungnya dalam jenis angka.
stringValue

string

Mewakili string JSON.
boolValue

boolean

Mewakili boolean JSON (literal true atau false dalam JSON).
structValue

object (Struct format)

Mewakili objek JSON.
listValue

array (ListValue format)

Mewakili array JSON.

Struct

Representasi JSON 
{
  "fields": {
    string: value,
    ...
  }
}
Kolom
fields

map (key: string, value: value (Value format))

Peta tidak berurutan dari nilai yang diketik secara dinamis.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

FieldsEntry

Representasi JSON 
{
  "key": string,
  "value": value
}
Kolom
key

string
value

value (Value format)

ListValue

Representasi JSON 
{
  "values": [
    value
  ]
}
Kolom
values[]

value (Value format)

Kolom berulang dari nilai yang diketik secara dinamis.

DefsEntry

Representasi JSON 
{
  "key": string,
  "value": {
    object (Schema)
  }
}
Kolom
key

string
value

object (Schema)

DataStoreSettings

Representasi JSON 
{
  "engines": [
    {
      object (Engine)
    }
  ]
}
Kolom
engines[]

object (Engine)

Hanya output. Mesin untuk aplikasi.

Mesin

Representasi JSON 
{
  "name": string,
  "type": enum (Type)
}
Kolom
name

string

Hanya output. Nama resource mesin. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (Type)

Hanya output. Jenis mesin.

ChannelProfile

Representasi JSON 
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
Kolom
profileId

string

Opsional. ID unik profil channel.
channelType

enum (ChannelType)

Opsional. Jenis profil channel.
personaProperty

object (PersonaProperty)

Opsional. Properti persona profil channel.
webWidgetConfig

object (WebWidgetConfig)

Opsional. Konfigurasi untuk widget web.
whatsappConfig

object (WhatsAppConfig)

Opsional. Konfigurasi khusus untuk deployment WhatsApp.
instagramConfig

object (InstagramConfig)

Opsional. Konfigurasi khusus untuk deployment Instagram.

Kolom union _disable_dtmf.

_disable_dtmf hanya dapat berupa salah satu dari hal berikut:
disableDtmf

boolean

Opsional. Apakah akan menonaktifkan DTMF (dual-tone multi-frequency).

Kolom union _disable_barge_in_control.

_disable_barge_in_control hanya dapat berupa salah satu dari hal berikut:
disableBargeInControl

boolean

Opsional. Apakah akan menonaktifkan kontrol penyela pengguna dalam percakapan. - true: Interupsi pengguna dinonaktifkan saat agen berbicara. - false: Agen mempertahankan kontrol otomatis atas kapan pengguna dapat melakukan interupsi.

Kolom union _noise_suppression_level.

_noise_suppression_level hanya dapat berupa salah satu dari hal berikut:
noiseSuppressionLevel

string

Opsional. Tingkat peredam bising profil saluran. Nilai yang tersedia adalah "low", "moderate", "high", "very_high".

PersonaProperty

Representasi JSON 
{
  "persona": enum (Persona)
}
Kolom
persona

enum (Persona)

Opsional. Persona channel.

WebWidgetConfig

Representasi JSON 
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
Kolom
modality

enum (Modality)

Opsional. Modalitas widget web.
theme

enum (Theme)

Opsional. Tema widget web.
webWidgetTitle

string

Opsional. Judul widget web.
securitySettings

object (SecuritySettings)

Opsional. Setelan keamanan widget web.

SecuritySettings

Representasi JSON 
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
Kolom
enablePublicAccess

boolean

Opsional. Menunjukkan apakah akses publik ke widget web diaktifkan. Jika true, widget web akan dapat diakses secara publik. Jika false, widget web harus diintegrasikan dengan sistem autentikasi dan otorisasi Anda sendiri untuk menampilkan kredensial yang valid untuk mengakses agen CES.
enableOriginCheck

boolean

Opsional. Menunjukkan apakah pemeriksaan origin untuk widget web diaktifkan. Jika true, widget web akan memeriksa asal situs yang memuat widget web dan hanya mengizinkannya dimuat di asal yang sama atau salah satu asal yang diizinkan.
allowedOrigins[]

string

Opsional. Origin yang diizinkan untuk menghosting widget web. Asal ditentukan oleh RFC 6454. Jika kosong, semua origin diizinkan. Maksimum 100 origin yang diizinkan. Contoh: "https://example.com"
enableRecaptcha

boolean

Opsional. Menunjukkan apakah verifikasi reCAPTCHA untuk widget web diaktifkan.

WhatsAppConfig

Representasi JSON 
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Kolom
wabaId

string

Wajib. ID Akun WhatsApp Business.
phoneNumberId

string

Wajib. ID nomor telepon Meta.
phoneNumber

string

Opsional. Nomor telepon dalam format E.164.
displayName

string

Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnailUrl

string

Hanya output. URL thumbnail profil bisnis Meta yang diambil.
description

string

Hanya output. Deskripsi halaman atau profil bisnis Meta.

InstagramConfig

Representasi JSON 
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
Kolom
instagramAccountId

string

Wajib. ID Akun Instagram.
displayName

string

Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnailUrl

string

Hanya output. URL thumbnail profil bisnis Meta yang diambil.
description

string

Hanya output. Deskripsi halaman atau profil bisnis Meta.

MetadataEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

ClientCertificateSettings

Representasi JSON 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
Kolom
tlsCertificate

string

Wajib. Sertifikat TLS yang dienkode dalam format PEM. String ini harus menyertakan baris header awal dan footer akhir.
privateKey

string

Wajib. Nama resource versi rahasia SecretManager yang menyimpan kunci pribadi yang dienkode dalam format PEM. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

Opsional. Nama resource versi rahasia SecretManager yang menyimpan frasa sandi untuk mendekripsi kunci pribadi. Harus dibiarkan tidak disetel jika kunci pribadi tidak dienkripsi. Format: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

Representasi JSON 
{
  "allowedOrigins": [
    string
  ]
}
Kolom
allowedOrigins[]

string

Opsional. Asal HTTP(s) yang diizinkan yang dapat dipanggil langsung oleh alat OpenAPI di Aplikasi saat Kontrol Layanan VPC diaktifkan. String ini harus sama persis dengan asal, termasuk port jika ditentukan. Misalnya, "https://example.com" atau "https://example.com:443". Daftar ini belum berlaku untuk alat Python yang dapat melakukan panggilan HTTP langsung.

DashboardSettings

Representasi JSON 
{
  "defaultDashboard": string
}
Kolom
defaultDashboard

string

Opsional. Nama resource dasbor Contact Center Insights default yang terkait dengan aplikasi. Dasbor ini adalah dasbor yang akan ditampilkan saat pengguna membuka tampilan Pemantauan untuk aplikasi.

Format: projects/{project}/locations/{location}/dashboards/{dashboard}

Agen

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],
  "validationErrors": [
    string
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  }
  // End of list of possible types for union field agent_type.
}
Kolom
name

string

ID. ID unik agen. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Wajib. Nama tampilan agen.
description

string

Opsional. Deskripsi agen yang dapat dibaca manusia.
modelSettings

object (ModelSettings)

Opsional. Konfigurasi untuk model LLM.
instruction

string

Opsional. Petunjuk untuk model LLM guna memandu perilaku agen.
tools[]

string

Opsional. Daftar alat yang tersedia untuk agen. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
childAgents[]

string

Opsional. Daftar agen turunan di struktur agen. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
beforeAgentCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
afterAgentCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
beforeModelCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
afterModelCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
beforeToolCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
afterToolCallbacks[]

object (Callback)

Opsional. Callback yang akan dieksekusi setelah alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang disediakan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat agen 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: "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. Stempel waktu saat agen 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
guardrails[]

string

Opsional. Daftar batasan untuk agen. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
toolsets[]

object (AgentToolset)

Opsional. Daftar toolset untuk agen.
generatedSummary

string

Hanya output. Jika agen dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan.
transferRules[]

object (TransferRule)

Opsional. Aturan transfer agen. Jika ada beberapa aturan yang cocok, aturan pertama dalam daftar akan digunakan.
validationErrors[]

string

Hanya output. Kesalahan konfigurasi atau error di agen yang dapat memengaruhi kualitas agen.
Kolom union agent_type. Jenis agen. agent_type hanya ada berupa salah satu diantara berikut:
llmAgent

object (LlmAgent)

Opsional. Jenis agen default.
remoteDialogflowAgent

object (RemoteDialogflowAgent)

Opsional. Agen Dialogflow jarak jauh yang akan digunakan untuk eksekusi agen. Jika kolom ini disetel, semua properti tingkat agen lainnya akan diabaikan.

Catatan: Jika agen Dialogflow berada dalam project yang berbeda dengan aplikasi, Anda harus memberikan roles/dialogflow.client ke agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

RemoteDialogflowAgent

Representasi JSON 
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean,
  "languageCodeVariable": string
}
Kolom
agent

string

Wajib. Nama resource agen Dialogflow. Format: projects/{project}/locations/{location}/agents/{agent}
flowId

string

Opsional. ID alur untuk alur di agen Dialogflow.
environmentId

string

Opsional. ID lingkungan agen Dialogflow yang akan digunakan untuk eksekusi agen. Jika tidak ditentukan, lingkungan draf akan digunakan.
inputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama variabel aplikasi ke nama parameter sesi Dialogflow yang akan dikirim ke agen Dialogflow sebagai input.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
outputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama parameter sesi Dialogflow ke nama variabel aplikasi yang akan dikirim kembali ke agen CES setelah eksekusi agen Dialogflow berakhir.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
respectResponseInterruptionSettings

boolean

Opsional. Menunjukkan apakah akan mematuhi setelan gangguan tingkat pesan yang dikonfigurasi di agen Dialogflow.

  • Jika salah (false): semua pesan respons dari agen Dialogflow mengikuti setelan interupsi tingkat aplikasi.
  • Jika benar (true): hanya pesan respons dengan allow_playback_interruption yang disetel ke benar (true) yang dapat disela, semua pesan lainnya mengikuti setelan penyelaan tingkat aplikasi.
languageCodeVariable

string

Opsional. Nama variabel yang berisi kode bahasa yang akan digunakan untuk sesi Dialogflow. Jika tidak ditentukan, kode bahasa default agen Dialogflow akan digunakan.

InputVariableMappingEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

OutputVariableMappingEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

Callback

Representasi JSON 
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
Kolom
description

string

Opsional. Deskripsi callback yang dapat dibaca manusia.
disabled

boolean

Opsional. Apakah callback dinonaktifkan. Panggilan balik yang dinonaktifkan akan diabaikan oleh agen.
proactiveExecutionEnabled

boolean

Opsional. Jika diaktifkan, callback juga akan dieksekusi pada output model perantara. Setelan ini hanya memengaruhi callback setelah model. AKTIFKAN DENGAN HATI-HATI. Biasanya, callback setelah model hanya perlu dieksekusi setelah menerima semua respons model. Mengaktifkan eksekusi proaktif dapat berimplikasi negatif pada biaya dan latensi eksekusi, dan hanya boleh diaktifkan dalam situasi yang jarang terjadi.
Kolom union callback. Callback yang akan dieksekusi. callback hanya ada berupa salah satu diantara berikut:
pythonCode

string

Wajib. Kode python yang akan dieksekusi untuk callback.

AgentToolset

Representasi JSON 
{
  "toolset": string,
  "toolIds": [
    string
  ]
}
Kolom
toolset

string

Wajib. Nama resource toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolIds[]

string

Opsional. ID alat untuk memfilter toolset.

TransferRule

Representasi JSON 
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
Kolom
childAgent

string

Wajib. Nama resource agen turunan tempat aturan diterapkan. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction

enum (Direction)

Wajib. Arah transfer.
Kolom union rule_type. Jenis aturan. rule_type hanya ada berupa salah satu diantara berikut:
deterministicTransfer

object (DeterministicTransfer)

Opsional. Aturan yang langsung ditransfer ke agen target saat kondisi terpenuhi.
disablePlannerTransfer

object (DisablePlannerTransfer)

Opsional. Aturan yang mencegah perencana mentransfer ke agen target.

DeterministicTransfer

Representasi JSON 
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
Kolom
Kolom union condition_type. Kondisi yang akan dievaluasi. condition_type hanya ada berupa salah satu diantara berikut:
expressionCondition

object (ExpressionCondition)

Opsional. Aturan yang mengevaluasi kondisi status sesi. Jika kondisi bernilai benar, transfer akan terjadi.
pythonCodeCondition

object (PythonCodeCondition)

Opsional. Aturan yang menggunakan blok kode Python untuk mengevaluasi kondisi. Jika kondisi bernilai benar, transfer akan terjadi.

ExpressionCondition

Representasi JSON 
{
  "expression": string
}
Kolom
expression

string

Wajib. Representasi string dari kondisi cloud.api.Expression.

PythonCodeCondition

Representasi JSON 
{
  "pythonCode": string
}
Kolom
pythonCode

string

Wajib. Kode python yang akan dieksekusi.

DisablePlannerTransfer

Representasi JSON 
{
  "expressionCondition": {
    object (ExpressionCondition)
  }
}
Kolom
expressionCondition

object (ExpressionCondition)

Wajib. Jika kondisi bernilai benar, perencana tidak akan diizinkan untuk mentransfer ke agen target.

Alat

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
Kolom
name

string

ID. Nama resource alat. Format:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool} untuk alat mandiri.
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} untuk alat yang diambil dari toolset.

Alat ini bersifat dinamis dan hanya menghasilkan output; alat ini tidak dapat dirujuk secara langsung jika alat diperlukan.
displayName

string

Hanya output. Nama tampilan alat, yang berasal dari jenis alat. Misalnya, nama tampilan [ClientFunction][Tool.ClientFunction] berasal dari properti name-nya.
executionType

enum (ExecutionType)

Opsional. Jenis eksekusi alat.
timeout

string (Duration format)

Opsional. Waktu tunggu untuk eksekusi alat. Jika tidak ditetapkan, waktu tunggu default adalah 30 detik untuk alat SYNCHRONOUS dan 60 detik untuk alat ASYNCHRONOUS.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
createTime

string (Timestamp format)

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: "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. 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
generatedSummary

string

Hanya output. Jika alat dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan.
toolFakeConfig

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

object (ClientFunction)

Opsional. Fungsi klien.
openApiTool

object (OpenApiTool)

Opsional. Alat API terbuka.
googleSearchTool

object (GoogleSearchTool)

Opsional. Alat penelusuran google.
connectorTool

object (ConnectorTool)

Opsional. Alat Integration Connector.
dataStoreTool

object (DataStoreTool)

Opsional. Alat penyimpanan data.
pythonFunction

object (PythonFunction)

Opsional. Alat fungsi python.
mcpTool

object (McpTool)

Opsional. Alat MCP. Alat MCP tidak dapat dibuat atau diperbarui secara langsung dan dikelola oleh toolset MCP.
fileSearchTool

object (FileSearchTool)

Opsional. Alat penelusuran file.
systemTool

object (SystemTool)

Opsional. Alat sistem.
agentTool

object (AgentTool)

Opsional. Alat agen.
widgetTool

object (WidgetTool)

Opsional. Alat widget.
remoteAgentTool

object (RemoteAgentTool)

Opsional. Alat agen jarak jauh.

ClientFunction

Representasi JSON 
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
Kolom
name

string

Wajib. Nama fungsi.
description

string

Opsional. Deskripsi fungsi.
parameters

object (Schema)

Opsional. Skema parameter fungsi.
response

object (Schema)

Opsional. Skema respons fungsi.

OpenApiTool

Representasi JSON 
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Kolom
openApiSchema

string

Wajib. Skema OpenAPI dalam format JSON atau YAML.
name

string

Opsional. Nama alat. Jika tidak diberikan, nama alat akan diambil dari skema OpenAPI, dari operation.operationId.
description

string

Opsional. Deskripsi alat. Jika tidak diberikan, deskripsi alat akan diambil dari skema OpenAPI, dari operation.description atau operation.summary.
apiAuthentication

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan oleh API.
tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang akan dipercayai klien.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan.
ignoreUnknownFields

boolean

Opsional. Jika benar (true), agen akan mengabaikan kolom yang tidak diketahui dalam respons API.
url

string

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 auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
Kolom
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut:
apiKeyConfig

object (ApiKeyConfig)

Opsional. Konfigurasi untuk autentikasi kunci API.
oauthConfig

object (OAuthConfig)

Opsional. Konfigurasi untuk OAuth.
serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

Opsional. Konfigurasi untuk autentikasi token ID yang dibuat dari agen layanan CES.
serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

Opsional. Konfigurasi untuk autentikasi akun layanan.
bearerTokenConfig

object (BearerTokenConfig)

Opsional. Konfigurasi untuk autentikasi token pembawa.

ApiKeyConfig

Representasi JSON 
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
Kolom
keyName

string

Wajib. Nama parameter atau nama header kunci API. Misalnya, Jika permintaan API adalah "https://example.com/act?X-Api-Key=", "X-Api-Key" akan menjadi nama parameter.
apiKeySecretVersion

string

Wajib. Nama resource versi secret SecretManager yang menyimpan kunci API. Format: projects/{project}/secrets/{secret}/versions/{version}

Catatan: Anda harus memberikan peran roles/secretmanager.secretAccessor kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
requestLocation

enum (RequestLocation)

Wajib. Lokasi kunci dalam permintaan.

OAuthConfig

Representasi JSON 
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
Kolom
oauthGrantType

enum (OauthGrantType)

Wajib. Jenis pemberian izin OAuth.
clientId

string

Wajib. ID klien dari penyedia OAuth.
clientSecretVersion

string

Wajib. Nama resource versi secret SecretManager yang menyimpan rahasia klien. Format: projects/{project}/secrets/{secret}/versions/{version}

Catatan: Anda harus memberikan peran roles/secretmanager.secretAccessor kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
tokenEndpoint

string

Wajib. Endpoint token di penyedia OAuth untuk ditukar dengan token akses.
scopes[]

string

Opsional. Cakupan OAuth yang akan diberikan.

ServiceAccountAuthConfig

Representasi JSON 
{
  "serviceAccount": string,
  "scopes": [
    string
  ]
}
Kolom
serviceAccount

string

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 Authorization permintaan.

Akun layanan harus memiliki peran roles/iam.serviceAccountTokenCreator yang diberikan kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]

string

Opsional. Cakupan OAuth yang akan diberikan. Jika tidak ditentukan, cakupan default https://www.googleapis.com/auth/cloud-platform akan digunakan.

BearerTokenConfig

Representasi JSON 
{
  "token": string
}
Kolom
token

string

Wajib. Token pemilik. Harus dalam format $context.variables.<name_of_variable>.

TlsConfig

Representasi JSON 
{
  "caCerts": [
    {
      object (CaCert)
    }
  ]
}
Kolom
caCerts[]

object (CaCert)

Wajib. Menentukan daftar sertifikat CA kustom yang diizinkan untuk verifikasi HTTPS.

CaCert

Representasi JSON 
{
  "displayName": string,
  "cert": string
}
Kolom
displayName

string

Wajib. Nama sertifikat CA kustom yang diizinkan. Ini dapat digunakan untuk membedakan sertifikat CA kustom.
cert

string (bytes format)

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

string

Wajib. Nama layanan Service Directory. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Lokasi direktori layanan harus sama dengan lokasi aplikasi.

GoogleSearchTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (PromptConfig)
  }
}
Kolom
name

string

Wajib. Nama alat.
description

string

Opsional. Deskripsi tujuan alat.
contextUrls[]

string

Opsional. Konten akan diambil langsung dari URL ini untuk konteks dan perujukan. Contoh: "https://example.com/path.html". Maksimum 20 URL yang diizinkan.
preferredDomains[]

string

Opsional. Menentukan domain untuk membatasi hasil penelusuran. Contoh: "example.com", "another.site". Maksimum 20 domain dapat ditentukan.
excludeDomains[]

string

Opsional. Daftar domain yang akan dikecualikan dari hasil penelusuran. Contoh: "example.com". Maksimum 2.000 domain dapat dikecualikan.
promptConfig

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

string

Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan chat. Jika tidak disetel, perintah default akan digunakan.
voicePrompt

string

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 (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
Kolom
connection

string

Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: projects/{project}/locations/{location}/connections/{connection}
action

object (Action)

Wajib. Tindakan yang akan digunakan alat.
authConfig

object (EndUserAuthConfig)

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

string

Opsional. Nama alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini.
description

string

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 action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
Kolom
inputFields[]

string

Opsional. Kolom entitas yang akan digunakan sebagai input untuk operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entitas akan digunakan.
outputFields[]

string

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

string

ID tindakan Koneksi yang akan digunakan alat.
entityOperation

object (EntityOperation)

Konfigurasi operasi entitas yang akan digunakan alat.

EntityOperation

Representasi JSON 
{
  "entityId": string,
  "operation": enum (OperationType)
}
Kolom
entityId

string

Wajib. ID entitas.
operation

enum (OperationType)

Wajib. Operasi yang akan dilakukan pada entity.

EndUserAuthConfig

Representasi JSON 
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
Kolom
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut:
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

Autentikasi Kode Otorisasi Oauth 2.0.
oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

Autentikasi Pemberian Otorisasi OAuth 2.0 Profil JWT.

Oauth2AuthCodeConfig

Representasi JSON 
{
  "oauthToken": string
}
Kolom
oauthToken

string

Wajib. Nama parameter token OAuth yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Representasi JSON 
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
Kolom
issuer

string

Wajib. Nama parameter penerbit yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.
subject

string

Wajib. Nama parameter subjek yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.
clientKey

string

Wajib. Nama parameter klien yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.

DataStoreTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
Kolom
name

string

Wajib. Nama alat penyimpanan data.
description

string

Opsional. Deskripsi alat.
boostSpecs[]

object (BoostSpecs)

Opsional. Spesifikasi penguatan untuk menguatkan dokumen tertentu.
modalityConfigs[]

object (ModalityConfig)

Opsional. Konfigurasi modalitas untuk penyimpanan data.
filterParameterBehavior

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

object (DataStoreSource)

Opsional. Menelusuri dalam satu DataStore tertentu.
engineSource

object (EngineSource)

Opsional. Menelusuri dalam Mesin (berpotensi di beberapa DataStore).

DataStoreSource

Representasi JSON 
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
Kolom
filter

string

Opsional. Spesifikasi filter untuk DataStore. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
dataStore

object (DataStore)

Opsional. Penyimpanan data.

DataStore

Representasi JSON 
{
  "name": string,
  "type": enum (DataStoreType),
  "documentProcessingMode": enum (DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (ConnectorConfig)
  }
}
Kolom
name

string

Wajib. Nama lengkap resource DataStore. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type

enum (DataStoreType)

Hanya output. Jenis penyimpanan data. Kolom ini bersifat hanya baca dan diisi oleh server.
documentProcessingMode

enum (DocumentProcessingMode)

Hanya output. Mode pemrosesan dokumen untuk koneksi penyimpanan data. Hanya ditetapkan untuk penyimpanan data PUBLIC_WEB dan UNSTRUCTURED.
displayName

string

Hanya output. Nama tampilan penyimpanan data.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
connectorConfig

object (ConnectorConfig)

Hanya output. Konfigurasi konektor untuk koneksi penyimpanan data.

ConnectorConfig

Representasi JSON 
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
Kolom
collection

string

Nama resource koleksi tempat penyimpanan data berada.
collectionDisplayName

string

Nama tampilan koleksi tempat penyimpanan data berada.
dataSource

string

Nama sumber data. Contoh: salesforce, jira, confluence, bigquery.

EngineSource

Representasi JSON 
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreSource)
    }
  ],
  "filter": string
}
Kolom
engine

string

Wajib. Nama lengkap resource Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
dataStoreSources[]

object (DataStoreSource)

Opsional. Digunakan untuk menargetkan DataStore tertentu dalam Engine. Jika kosong, penelusuran berlaku untuk semua DataStore yang terkait dengan Engine.
filter

string

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 (BoostSpec)
    }
  ]
}
Kolom
dataStores[]

string

Wajib. Penyimpanan Data tempat konfigurasi peningkatan diterapkan. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]

object (BoostSpec)

Wajib. Daftar spesifikasi peningkat.

BoostSpec

Representasi JSON 
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
Kolom
conditionBoostSpecs[]

object (ConditionBoostSpec)

Wajib. Daftar spesifikasi peningkat.

ConditionBoostSpec

Representasi JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
Kolom
condition

string

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

number

Opsional. Kekuatan pendorong, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Nilai defaultnya adalah 0.0.

Menyetel ke 1.0 akan memberikan promosi besar pada saran. Namun, hasil teratas tidak selalu merupakan saran yang dipromosikan.

Menetapkan 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

object (BoostControlSpec)

Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan.

BoostControlSpec

Representasi JSON 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Kolom
fieldName

string

Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
attributeType

enum (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, prosesnya sederhana, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
controlPoints[]

object (ControlPoint)

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

string

Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]].
boostAmount

number

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 (ModalityType),
  "rewriterConfig": {
    object (RewriterConfig)
  },
  "summarizationConfig": {
    object (SummarizationConfig)
  },
  "groundingConfig": {
    object (GroundingConfig)
  },
  "snippetsConfig": {
    object (SnippetsConfig)
  }
}
Kolom
modalityType

enum (ModalityType)

Wajib. Jenis modalitas.
rewriterConfig

object (RewriterConfig)

Opsional. Konfigurasi penulis ulang.
summarizationConfig

object (SummarizationConfig)

Opsional. Konfigurasi ringkasan.
groundingConfig

object (GroundingConfig)

Opsional. Konfigurasi perujukan.
snippetsConfig

object (SnippetsConfig)

Opsional. Konfigurasi cuplikan.

RewriterConfig

Representasi JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Kolom
modelSettings

object (ModelSettings)

Wajib. Konfigurasi untuk model LLM.
prompt

string

Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan.
disabled

boolean

Opsional. Apakah penulis ulang dinonaktifkan.

SummarizationConfig

Representasi JSON 
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
Kolom
modelSettings

object (ModelSettings)

Opsional. Konfigurasi untuk model LLM.
prompt

string

Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan.
disabled

boolean

Opsional. Apakah ringkasan dinonaktifkan.

GroundingConfig

Representasi JSON 
{
  "groundingLevel": number,
  "disabled": boolean
}
Kolom
groundingLevel

number

Opsional. Ambang batas 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

boolean

Opsional. Apakah perujukan dinonaktifkan.

SnippetsConfig

Representasi JSON 
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
Kolom
enableSnippets

boolean

Opsional. Apakah cuplikan diaktifkan atau tidak.
maxSnippets

integer

Opsional. Jumlah cuplikan yang akan ditampilkan per kueri. Jika tidak disetel, secara default akan menampilkan semua cuplikan dari layanan.

PythonFunction

Representasi JSON 
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
Kolom
name

string

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

string

Opsional. Kode Python yang akan dieksekusi untuk alat.
description

string

Hanya output. Deskripsi fungsi Python, di-parsing dari docstring kode python.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Service Directory untuk alat.

McpTool

Representasi JSON 
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (State)
}
Kolom
name

string

Wajib. Nama alat MCP.
nameOverride

string

Opsional. Penggantian nama alat MCP. Bagian ini diisi jika nama diganti oleh penggantian Toolset.
description

string

Opsional. Deskripsi alat MCP.
inputSchema

object (Schema)

Opsional. Skema argumen input alat MCP.
outputSchema

object (Schema)

Opsional. Skema argumen output alat MCP.
serverAddress

string

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. Hal ini sama dengan server_address di McpToolset. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
apiAuthentication

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

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
customHeaders

map (key: string, value: string)

Opsional. Header kustom yang akan dikirim dalam permintaan ke server MCP. Nilai harus dalam format $context.variables.<name_of_variable> dan dapat ditetapkan dalam variabel sesi. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection untuk mengetahui detail selengkapnya.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Hanya output. Status ketersediaan dinamis alat di server eksternal.

CustomHeadersEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

FileSearchTool

Representasi JSON 
{
  "corpusType": enum (CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
Kolom
corpusType

enum (CorpusType)

Opsional. Jenis korpus. Default-nya adalah FULLY_MANAGED.
name

string

Wajib. Nama alat.
description

string

Opsional. Deskripsi alat.
fileCorpus

string

Opsional. Korpus tempat file disimpan. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

SystemTool

Representasi JSON 
{
  "name": string,
  "description": string
}
Kolom
name

string

Wajib. Nama alat sistem.
description

string

Hanya output. Deskripsi alat sistem.

AgentTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "agent": string
}
Kolom
name

string

Wajib. Nama alat agen.
description

string

Opsional. Deskripsi tujuan alat.
agent

string

Opsional. Nama resource agen yang menjadi titik entri alat. Format: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
Kolom
name

string

Wajib. Nama tampilan alat widget.
description

string

Opsional. Deskripsi alat widget.
widgetType

enum (WidgetType)

Opsional. Jenis alat widget. Jika tidak ditentukan, jenis defaultnya adalah CUSTOMIZED.
uiConfig

object (Struct format)

Opsional. Konfigurasi untuk merender widget.
dataMapping

object (DataMapping)

Opsional. Pemetaan yang menentukan cara data dari alat sumber dipetakan ke parameter input widget.
textResponseConfig

object (TextResponseConfig)

Opsional. Konfigurasi untuk respons teks yang selalu disertakan.
Kolom union input. Input alat widget. input hanya ada berupa salah satu diantara berikut:
parameters

object (Schema)

Opsional. Parameter input alat widget.

DataMapping

Representasi JSON 
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (Mode),
  "pythonScript": string
}
Kolom
sourceToolName

string

Opsional. Nama resource alat yang menyediakan data untuk widget (misalnya, alat penelusuran atau fungsi kustom). Format: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
fieldMappings

map (key: string, value: string)

Opsional. Peta kolom parameter input widget ke kolom output yang sesuai dari alat sumber.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
pythonFunction

object (PythonFunction)

Opsional. Konfigurasi untuk fungsi Python yang digunakan untuk mengubah output alat sumber ke dalam format input widget.
mode

enum (Mode)

Opsional. Mode pemetaan data.
pythonScript
(deprecated)

string

Tidak digunakan lagi: Gunakan python_function sebagai gantinya.

FieldMappingsEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

TextResponseConfig

Representasi JSON 
{
  "type": enum (Type),
  "staticText": string,
  "textResponseInstruction": string
}
Kolom
type

enum (Type)

Opsional. Strategi untuk memberikan respons teks.
staticText

string

Opsional. Respons teks statis yang akan ditampilkan saat jenisnya adalah STATIC.
textResponseInstruction

string

Opsional. Petunjuk untuk LLM tentang cara menghasilkan respons teks. Digunakan sebagai deskripsi untuk parameter respons teks jika jenisnya adalah LLM_GENERATED.

RemoteAgentTool

Representasi JSON 
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  }
}
Kolom
name

string

Wajib. Nama alat.
description

string

Wajib. Deskripsi alat.
agentCard

object (AgentCard)

Wajib. Kartu agen dari agen jarak jauh yang dipanggil oleh alat ini.
apiAuthentication

object (ApiAuthentication)

Opsional. Konfigurasi autentikasi untuk memanggil agen jarak jauh.

AgentCard

Representasi JSON 
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
Kolom
name

string

Wajib. Nama agen yang dapat dibaca manusia.
description

string

Wajib. Deskripsi domain tindakan/ruang solusi agen.
supportedInterfaces[]

object (AgentInterface)

Wajib. Daftar antarmuka yang didukung dan diurutkan. Entri pertama lebih disukai.
version

string

Wajib. Versi agen.
skills[]

object (AgentSkill)

Wajib. Keahlian mewakili unit kemampuan yang dapat dilakukan agen. Hal ini mungkin agak abstrak, tetapi mewakili serangkaian tindakan yang lebih terfokus yang kemungkinan besar akan berhasil dilakukan agen.

AgentInterface

Representasi JSON 
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
Kolom
url

string

Wajib. URL tempat antarmuka ini tersedia. Harus berupa URL HTTPS absolut yang valid dalam produksi. Contoh: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocolBinding

string

Wajib. Binding protokol yang didukung di URL ini. Ini adalah string formulir terbuka, yang dapat dengan mudah diperluas untuk binding protokol lainnya. Plugin inti yang didukung secara resmi adalah JSONRPC, GRPC, dan HTTP+JSON.
tenant

string

ID tenant yang akan digunakan dalam permintaan saat memanggil agen.
protocolVersion

string

Wajib. Versi A2A protocol yang diekspos oleh antarmuka ini. Gunakan versi minor terbaru yang didukung per versi utama. Contoh: "0.3", "1.0"

AgentSkill

Representasi JSON 
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
Kolom
id

string

Wajib. ID unik untuk kemampuan agen.
name

string

Wajib. Nama keahlian yang dapat dibaca manusia.
description

string

Wajib. Deskripsi mendetail tentang skill.
tags[]

string

Wajib. Sekumpulan kata kunci yang menjelaskan kemampuan skill.
examples[]

string

Contoh perintah atau skenario yang dapat ditangani oleh kemampuan ini.
inputModes[]

string

Kumpulan jenis media input yang didukung untuk skill ini, yang menggantikan default agen.
outputModes[]

string

Kumpulan jenis media output yang didukung untuk skill ini, yang menggantikan default agen.

ToolFakeConfig

Representasi JSON 
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
Kolom
enableFakeMode

boolean

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

object (CodeBlock)

Opsional. Blok kode yang akan dieksekusi, bukan panggilan alat yang sebenarnya.

CodeBlock

Representasi JSON 
{
  "pythonCode": string
}
Kolom
pythonCode

string

Wajib. Kode Python yang akan dipanggil dalam mode tiruan 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 sebenarnya akan dipanggil.

Contoh

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
Kolom
name

string

ID. ID unik contoh. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
displayName

string

Wajib. Nama tampilan contoh.
description

string

Opsional. Deskripsi contoh yang dapat dibaca manusia.
entryAgent

string

Opsional. Agen yang awalnya menangani percakapan. Jika tidak ditentukan, contoh ini merepresentasikan percakapan yang ditangani oleh agen root. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

object (Message)

Opsional. Kumpulan pesan yang membentuk percakapan.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat contoh 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: "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. Stempel waktu saat contoh 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
invalid

boolean

Hanya output. Contoh dapat menjadi tidak valid jika resource yang dirujuk dihapus. Contoh yang tidak valid tidak akan digunakan sebagai contoh few-shot.
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

Pesan

Representasi JSON 
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
Kolom
role

string

Opsional. Peran dalam percakapan, misalnya, pengguna, agen.
chunks[]

object (Chunk)

Opsional. Konten pesan sebagai serangkaian bagian.
eventTime

string (Timestamp format)

Opsional. Stempel waktu saat pesan dikirim atau diterima. Tidak boleh digunakan jika pesan adalah bagian dari example.

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

Chunk

Representasi JSON 
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
Kolom
Kolom union data. Data potongan. data hanya ada berupa salah satu diantara berikut:
text

string

Opsional. Data teks.
transcript

string

Opsional. Transkrip yang terkait dengan audio.
blob

object (Blob)

Opsional. Data blob.
payload

object (Struct format)

Opsional. Data payload kustom.
image

object (Image)

Opsional. Data gambar.
toolCall

object (ToolCall)

Opsional. Permintaan eksekusi alat.
toolResponse

object (ToolResponse)

Opsional. Respons eksekusi alat.
agentTransfer

object (AgentTransfer)

Opsional. Peristiwa transfer agen.
updatedVariables

object (Struct format)

Struct merepresentasikan variabel yang diperbarui dalam percakapan, yang dikelompokkan berdasarkan nama variabel.
defaultVariables

object (Struct format)

Struct merepresentasikan variabel default di awal percakapan, yang dikelompokkan berdasarkan nama variabel.

Blob

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

string

Wajib. Jenis MIME standar IANA dari data sumber.
data

string (bytes format)

Wajib. Byte mentah blob.

String berenkode base64.

Gambar

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

string

Wajib. Jenis MIME standar IANA dari data sumber. Jenis gambar yang didukung meliputi: * image/png * image/jpeg * image/webp
data

string (bytes format)

Wajib. Byte mentah gambar.

String berenkode base64.

ToolCall

Representasi JSON 
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Kolom
id

string

Opsional. ID unik panggilan alat. Jika diisi, klien harus menampilkan hasil eksekusi dengan ID yang cocok di ToolResponse.
displayName

string

Hanya output. Nama tampilan alat.
args

object (Struct format)

Opsional. Parameter dan nilai input untuk alat dalam format objek JSON.
parentToolCallId

string

Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
agentName

string

Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Arsitek Kontrak". Kosong saat dikeluarkan oleh agen root.
Kolom union tool_identifier. ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari set alat. tool_identifier hanya ada berupa salah satu diantara berikut:
tool

string

Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Opsional. Alat toolset yang akan dieksekusi.

ToolsetTool

Representasi JSON 
{
  "toolset": string,
  "toolId": string
}
Kolom
toolset

string

Wajib. Nama resource Toolset dari mana alat ini berasal. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
toolId

string

Opsional. ID alat untuk memfilter alat yang akan diambil skemanya.

ToolResponse

Representasi JSON 
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
Kolom
id

string

Opsional. ID yang cocok dari tool call yang menjadi tujuan respons.
displayName

string

Hanya output. Nama tampilan alat.
response

object (Struct format)

Wajib. Hasil eksekusi alat dalam format objek JSON. Gunakan kunci "output" untuk menentukan respons alat dan kunci "error" untuk menentukan detail error (jika ada). Jika kunci "output" dan "error" tidak ditentukan, seluruh "respons" akan diperlakukan sebagai hasil eksekusi alat.
parentToolCallId

string

Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
agentName

string

Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Arsitek Kontrak". Kosong saat dikeluarkan oleh agen root.
Kolom union tool_identifier. ID alat yang dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari set alat. tool_identifier hanya ada berupa salah satu diantara berikut:
tool

string

Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Opsional. Alat toolset yang dieksekusi.

AgentTransfer

Representasi JSON 
{
  "targetAgent": string,
  "displayName": string
}
Kolom
targetAgent

string

Wajib. Agen yang menjadi tujuan pengalihan percakapan. Agen akan menangani percakapan mulai saat ini. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
displayName

string

Hanya output. Nama tampilan agen.

Pagar pengaman

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "action": {
    object (TriggerAction)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field guardrail_type can be only one of the following:
  "contentFilter": {
    object (ContentFilter)
  },
  "llmPromptSecurity": {
    object (LlmPromptSecurity)
  },
  "llmPolicy": {
    object (LlmPolicy)
  },
  "modelSafety": {
    object (ModelSafety)
  },
  "codeCallback": {
    object (CodeCallback)
  }
  // End of list of possible types for union field guardrail_type.
}
Kolom
name

string

ID. ID unik pembatas. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
displayName

string

Wajib. Nama tampilan pembatas.
description

string

Opsional. Deskripsi pembatasan.
enabled

boolean

Opsional. Apakah pembatasan diaktifkan atau tidak.
action

object (TriggerAction)

Opsional. Tindakan yang harus dilakukan saat batasan pengaman dipicu.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat pembatasan 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: "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. Stempel waktu saat batas aman 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
Kolom union guardrail_type. Jenis pembatasan. guardrail_type hanya ada berupa salah satu diantara berikut:
contentFilter

object (ContentFilter)

Opsional. Pembatasan yang melarang penggunaan konten tertentu dalam percakapan.
llmPromptSecurity

object (LlmPromptSecurity)

Opsional. Pembatas yang memblokir percakapan jika perintah dianggap tidak aman berdasarkan klasifikasi LLM.
llmPolicy

object (LlmPolicy)

Opsional. Penjaga yang memblokir percakapan jika respons LLM dianggap melanggar kebijakan berdasarkan klasifikasi LLM.
modelSafety

object (ModelSafety)

Opsional. Membatasi percakapan jika respons LLM dianggap tidak aman berdasarkan setelan keamanan model.
codeCallback

object (CodeCallback)

Opsional. Pembatas yang berpotensi memblokir percakapan berdasarkan hasil eksekusi callback.

ContentFilter

Representasi JSON 
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean
}
Kolom
bannedContents[]

string

Opsional. Daftar frasa yang dilarang. Berlaku untuk input pengguna dan respons agen.
bannedContentsInUserInput[]

string

Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk input pengguna.
bannedContentsInAgentResponse[]

string

Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk respons agen.
matchType

enum (MatchType)

Wajib. Jenis pencocokan untuk filter konten.
disregardDiacritics

boolean

Opsional. Jika benar (true), diakritik diabaikan selama pencocokan.

LlmPromptSecurity

Representasi JSON 
{
  "failOpen": boolean,

  // Union field security_config can be only one of the following:
  "defaultSettings": {
    object (DefaultSecuritySettings)
  },
  "customPolicy": {
    object (LlmPolicy)
  }
  // End of list of possible types for union field security_config.
}
Kolom
failOpen

boolean

Opsional. Menentukan perilaku saat batasan pengaman mengalami error LLM. - Jika benar (true): batas aman dilewati. - Jika salah (default): pembatasan akan dipicu/diblokir.

Catatan: Jika kebijakan kustom diberikan, kolom ini akan diabaikan dan digantikan oleh konfigurasi 'fail_open' kebijakan.
Kolom union security_config. Menentukan mode konfigurasi keamanan. Pengguna harus memilih salah satu konfigurasi berikut. security_config hanya ada berupa salah satu diantara berikut:
defaultSettings

object (DefaultSecuritySettings)

Opsional. Menggunakan setelan keamanan default yang telah ditentukan sebelumnya oleh sistem. Untuk memilih mode ini, sertakan pesan 'default_settings' kosong dalam permintaan. Kolom 'default_prompt_template' di dalamnya akan diisi oleh server dalam respons.
customPolicy

object (LlmPolicy)

Opsional. Gunakan LlmPolicy yang ditentukan pengguna untuk mengonfigurasi pembatasan keamanan.

DefaultSecuritySettings

Representasi JSON 
{
  "defaultPromptTemplate": string
}
Kolom
defaultPromptTemplate

string

Hanya output. Template perintah default yang digunakan oleh sistem. Kolom ini digunakan untuk tujuan tampilan guna menunjukkan kepada pengguna perintah apa yang digunakan sistem secara default. Ini adalah OUTPUT_ONLY.

LlmPolicy

Representasi JSON 
{
  "maxConversationMessages": integer,
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "policyScope": enum (PolicyScope),
  "failOpen": boolean,
  "allowShortUtterance": boolean
}
Kolom
maxConversationMessages

integer

Opsional. Saat memeriksa kebijakan ini, pertimbangkan 'n' pesan terakhir dalam percakapan. Jika tidak ditetapkan, nilai default 10 akan digunakan.
modelSettings

object (ModelSettings)

Opsional. Setelan model.
prompt

string

Wajib. Perintah kebijakan.
policyScope

enum (PolicyScope)

Wajib. Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan. Jika disetel ke POLICY_SCOPE_UNSPECIFIED, kebijakan akan diterapkan ke input pengguna. Saat menerapkan kebijakan ke respons agen, latensi tambahan akan terjadi sebelum agen dapat merespons.
failOpen

boolean

Opsional. Jika terjadi error selama pemeriksaan kebijakan, buka dan jangan memicu pembatasan.
allowShortUtterance

boolean

Opsional. Secara default, pemeriksaan kebijakan LLM dilewati untuk ucapan singkat. Jika diaktifkan, setelan ini akan menerapkan pemeriksaan kebijakan ke semua ucapan, termasuk yang biasanya dilewati.

ModelSafety

Representasi JSON 
{
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ]
}
Kolom
safetySettings[]

object (SafetySetting)

Wajib. Daftar setelan keamanan.

SafetySetting

Representasi JSON 
{
  "category": enum (HarmCategory),
  "threshold": enum (HarmBlockThreshold)
}
Kolom
category

enum (HarmCategory)

Wajib. Kategori bahaya.
threshold

enum (HarmBlockThreshold)

Wajib. Ambang batas pemblokiran bahaya.

CodeCallback

Representasi JSON 
{
  "beforeAgentCallback": {
    object (Callback)
  },
  "afterAgentCallback": {
    object (Callback)
  },
  "beforeModelCallback": {
    object (Callback)
  },
  "afterModelCallback": {
    object (Callback)
  }
}
Kolom
beforeAgentCallback

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.
afterAgentCallback

object (Callback)

Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.
beforeModelCallback

object (Callback)

Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.
afterModelCallback

object (Callback)

Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut.

TriggerAction

Representasi JSON 
{

  // Union field action can be only one of the following:
  "respondImmediately": {
    object (RespondImmediately)
  },
  "transferAgent": {
    object (TransferAgent)
  },
  "generativeAnswer": {
    object (GenerativeAnswer)
  }
  // End of list of possible types for union field action.
}
Kolom
Kolom union action. Tindakan yang harus dilakukan. action hanya ada berupa salah satu diantara berikut:
respondImmediately

object (RespondImmediately)

Opsional. Segera merespons dengan respons yang telah dikonfigurasi sebelumnya.
transferAgent

object (TransferAgent)

Opsional. Mentransfer percakapan ke agen lain.
generativeAnswer

object (GenerativeAnswer)

Opsional. Memberikan respons dengan jawaban generatif.

RespondImmediately

Representasi JSON 
{
  "responses": [
    {
      object (Response)
    }
  ]
}
Kolom
responses[]

object (Response)

Wajib. Template pesan yang dapat dipilih agen. Respons dipilih secara acak.

Respons

Representasi JSON 
{
  "text": string,
  "disabled": boolean
}
Kolom
text

string

Wajib. Teks yang akan digunakan agen untuk merespons.
disabled

boolean

Opsional. Apakah respons dinonaktifkan. Respons yang dinonaktifkan tidak digunakan oleh agen.

TransferAgent

Representasi JSON 
{
  "agent": string
}
Kolom
agent

string

Wajib. Nama agen yang akan menerima transfer percakapan. Agen harus berada di aplikasi yang sama dengan agen saat ini. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

Representasi JSON 
{
  "prompt": string
}
Kolom
prompt

string

Wajib. Perintah yang akan digunakan untuk jawaban generatif.

Toolset

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
Kolom
name

string

ID. ID unik toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

Opsional. Nama tampilan toolset. Harus unik dalam aplikasi yang sama.
description

string

Opsional. Deskripsi toolset.
timeout

string (Duration format)

Opsional. Waktu tunggu untuk eksekusi toolset. Jika tidak ditetapkan, waktu tunggu default adalah 30 detik untuk toolset SYNCHRONOUS dan 60 detik untuk toolset ASYNCHRONOUS.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat toolset 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: "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. Stempel waktu saat toolset 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
executionType

enum (ExecutionType)

Opsional. Jenis eksekusi alat dalam toolset.
toolFakeConfig

object (ToolFakeConfig)

Opsional. Konfigurasi untuk perilaku alat dalam mode palsu.
Kolom union toolset_type. Jenis toolset. toolset_type hanya ada berupa salah satu diantara berikut:
mcpToolset

object (McpToolset)

Opsional. Toolset yang berisi daftar alat yang ditawarkan oleh server MCP.
openApiToolset

object (OpenApiToolset)

Opsional. Toolset yang berisi daftar alat yang ditentukan oleh skema OpenAPI.
connectorToolset

object (ConnectorToolset)

Opsional. Kumpulan alat yang membuat alat dari Koneksi Integration Connectors.

McpToolset

Representasi JSON 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Kolom
serverAddress

string

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. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
apiAuthentication

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan untuk mengakses alat dan 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.
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
customHeaders

map (key: string, value: string)

Opsional. Header kustom yang akan dikirim dalam permintaan ke server MCP. Nilai harus dalam format $context.variables.<name_of_variable> dan dapat ditetapkan dalam variabel sesi. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection untuk mengetahui detail selengkapnya.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
toolOverrides[]

object (McpToolOverride)

Opsional. Penggantian untuk setiap alat dalam set alat ini. Hal ini memungkinkan penggantian detail tertentu seperti deskripsi, nama, atau menyematkan status alat sehingga tidak sepenuhnya dinamis.

CustomHeadersEntry

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string
value

string

McpToolOverride

Representasi JSON 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Kolom
tool

string

Wajib. Nama asli alat saat dikeluarkan oleh server MCP.
nameOverride

string

Opsional. Jika ada, alat ini menggunakan nama ini di Agen, bukan nama asli. Ini terutama digunakan sebagai alias jika server MCP menawarkan alat yang namanya kurang baik.
descriptionOverride

string

Opsional. Jika ada, alat ini akan menggunakan deskripsi ini, bukan deskripsi asli dari server.
snapshot

object (McpToolDefinition)

Hanya output. Jika ada, alat ini akan "Disematkan" dan menggunakan nilai snapshot sebagai penggantian jika server tidak tersedia untuk sementara atau jika tidak ada Penggantian.

McpToolDefinition

Representasi JSON 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Kolom
description

string

Hanya output. Deskripsi alat MCP. Nilai ini dapat diganti oleh description_override di McpToolOverride.
inputSchema

object (Schema)

Hanya output. Skema argumen input alat MCP.
outputSchema

object (Schema)

Hanya output. Skema argumen output alat MCP.

OpenApiToolset

Representasi JSON 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Kolom
openApiSchema

string

Wajib. Skema OpenAPI toolset.
apiAuthentication

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan oleh API.
tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom
serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan.
ignoreUnknownFields

boolean

Opsional. Jika benar, agen akan mengabaikan kolom yang tidak diketahui dalam respons API untuk semua operasi yang ditentukan dalam skema OpenAPI.
url

string

Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di toolset 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.

ConnectorToolset

Representasi JSON 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Kolom
connection

string

Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

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 Toolset akan gagal. Lihat: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connectorActions[]

object (Action)

Wajib. Daftar tindakan konektor/operasi entitas untuk membuat alat.

PrebuiltAmbientNoise

Suara bising di sekitar yang sudah dibuat.

Enum
PREBUILT_AMBIENT_NOISE_UNSPECIFIED Tidak ditentukan.
RETAIL_STORE Derau sekitar toko retail.
CONVENTION_HALL Suara bising di sekitar ruang konvensi.
OUTDOOR Suara bising di sekitar jalan.

ErrorHandlingStrategy

Menentukan strategi untuk menangani error.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED Strategi penanganan error tidak ditentukan.
NONE Tidak ada penanganan khusus yang diaktifkan.
FALLBACK_RESPONSE Pesan pengganti akan ditampilkan kepada pengguna jika terjadi error sistem (misalnya, error LLM).
END_SESSION Sinyal EndSession akan dipancarkan jika terjadi error sistem (misalnya, error LLM).

ToolExecutionMode

Menentukan perilaku eksekusi alat jika ada beberapa alat yang dipilih oleh agen secara bersamaan.

Enum
TOOL_EXECUTION_MODE_UNSPECIFIED Mode eksekusi alat tidak ditentukan. Nilai defaultnya adalah PARALEL.
PARALLEL Jika ada beberapa alat yang dipilih, alat tersebut akan dieksekusi secara paralel, dengan ToolContext yang sama.
SEQUENTIAL Jika ada beberapa alat yang dipilih, alat tersebut akan dijalankan secara berurutan. Alat berikutnya hanya akan dieksekusi setelah alat sebelumnya selesai dan dapat melihat ToolContext yang diperbarui dari alat sebelumnya.

SemanticSimilarityChannel

Saluran kemiripan semantik yang akan digunakan.

Enum
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED Metrik tidak ditentukan. Nilai defaultnya adalah TEXT.
TEXT Menggunakan kemiripan semantik teks.
AUDIO Gunakan kesamaan semantik audio.

ExtraToolCallBehavior

Menentukan perilaku saat panggilan alat tambahan ditemukan. Panggilan alat tambahan adalah panggilan alat yang ada dalam eksekusi, tetapi tidak cocok dengan panggilan alat apa pun dalam ekspektasi standar.

Enum
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED Perilaku tidak ditentukan. Nilai defaultnya adalah GAGAL.
FAIL Gagal dalam evaluasi jika panggilan alat tambahan ditemukan.
ALLOW Izinkan panggilan alat tambahan.

HallucinationMetricBehavior

Perilaku metrik halusinasi. Terlepas dari perilaku tersebut, metrik akan selalu dihitung. Perbedaannya adalah bahwa jika dinonaktifkan, metrik tidak digunakan untuk menghitung skor evaluasi keseluruhan.

Enum
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Perilaku metrik halusinasi tidak ditentukan.
DISABLED Nonaktifkan metrik halusinasi.
ENABLED Aktifkan metrik halusinasi.

Jenis

Jenis data OpenAPI.

Enum
TYPE_UNSPECIFIED Jenis tidak ditentukan.
STRING Jenis string.
INTEGER Jenis bilangan bulat.
NUMBER Jenis angka.
BOOLEAN Jenis Boolean.
OBJECT Jenis objek.
ARRAY Jenis array.

NullValue

Mewakili JSON null.

NullValue adalah sentinel, menggunakan enum dengan hanya satu nilai untuk merepresentasikan nilai null untuk gabungan jenis Value.

Kolom berjenis NullValue dengan nilai selain 0 dianggap tidak valid. Sebagian besar serializer ProtoJSON akan memancarkan Value dengan null_value yang ditetapkan sebagai null JSON, terlepas dari nilai bilangan bulatnya, dan akan melakukan perjalanan pulang pergi ke nilai 0.

Enum
NULL_VALUE Nilai null.

Jenis

Jenis mesin. Lihat dokumentasi yang tersedia di https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType dan https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enum
TYPE_UNSPECIFIED Jenis mesin tidak ditentukan.
ENGINE_TYPE_CHAT Jenis mesin chat. Mesin SOLUTION_TYPE_CHAT untuk aplikasi. Semua penyimpanan data konektor yang ditambahkan ke aplikasi akan ditambahkan ke mesin ini.

ChannelType

Jenis profil channel.

Enum
UNKNOWN Jenis channel tidak diketahui.
WEB_UI Saluran UI Web.
API Saluran API.
TWILIO Saluran Twilio.
GOOGLE_TELEPHONY_PLATFORM Channel Google Telephony Platform.
CONTACT_CENTER_AS_A_SERVICE Saluran Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT Saluran Contact Center as a Service (CCaaS Chat).
FIVE9 Channel Five9.
CONTACT_CENTER_INTEGRATION Saluran integrasi pusat kontak pihak ketiga.
WHATSAPP Saluran WhatsApp.
INSTAGRAM Saluran Instagram.

Persona

Persona channel.

Enum
UNKNOWN Persona TIDAK DIKENAL.
CONCISE Agen menjaga agar respons tetap ringkas dan langsung ke intinya
CHATTY Agen memberikan konteks, penjelasan, dan detail tambahan

Modalitas

Modalitas widget web.

Enum
MODALITY_UNSPECIFIED Modalitas tidak diketahui.
CHAT_AND_VOICE Widget mendukung input chat dan suara.
VOICE_ONLY Widget hanya mendukung input suara.
CHAT_ONLY Widget hanya mendukung input chat.
CHAT_VOICE_AND_VIDEO Widget mendukung input chat, suara, dan video.

Tema

Tema widget web.

Enum
THEME_UNSPECIFIED Tema tidak diketahui.
LIGHT Tema terang.
DARK Tema gelap.

Arah

Arah transfer.

Enum
DIRECTION_UNSPECIFIED Arah tidak ditentukan.
PARENT_TO_CHILD Transfer dari agen induk ke agen turunan.
CHILD_TO_PARENT Transfer dari agen turunan ke agen induk.

RequestLocation

Lokasi kunci API dalam permintaan.

Enum
REQUEST_LOCATION_UNSPECIFIED Tidak ditentukan. Nilai ini tidak boleh digunakan.
HEADER Merepresentasikan kunci di header http.
QUERY_STRING Mewakili kunci dalam string kueri.

OauthGrantType

Jenis pemberian izin OAuth. Hanya pemberian kredensial klien yang didukung.

Enum
OAUTH_GRANT_TYPE_UNSPECIFIED Tidak ditentukan. Default-nya adalah CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL Mewakili alur kredensial klien.

OperationType

Operasi yang akan dilakukan pada entity.

Enum
OPERATION_TYPE_UNSPECIFIED Jenis operasi tidak ditentukan. Tidak valid, pembuatan/pembaruan ConnectorTool akan gagal.
LIST Operasi daftar.
GET Mendapatkan operasi.
CREATE Buat operasi.
UPDATE Operasi update.
DELETE Hapus operasi.

DataStoreType

Jenis penyimpanan data.

Enum
DATA_STORE_TYPE_UNSPECIFIED Tidak ditentukan. Nilai ini menunjukkan bahwa jenis penyimpanan data tidak ditentukan, sehingga tidak akan digunakan selama penelusuran.
PUBLIC_WEB Penyimpanan data yang berisi konten web publik.
UNSTRUCTURED Penyimpanan data yang berisi data pribadi tidak terstruktur.
FAQ Penyimpanan data yang berisi data terstruktur yang digunakan sebagai FAQ.
CONNECTOR Penyimpanan data yang merupakan konektor ke layanan pihak pertama atau pihak ketiga.

DocumentProcessingMode

Mode pemrosesan dokumen penyimpanan data.

Enum
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Tidak ditentukan.
DOCUMENTS Dokumen diproses sebagai dokumen.
CHUNKS Dokumen dikonversi menjadi potongan.

AttributeType

Atribut(atau fungsi) yang akan diterapkan peringkat kustomnya.

Enum
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType tidak ditentukan.
NUMERICAL Nilai kolom numerik akan digunakan untuk memperbarui jumlah peningkat secara dinamis. Dalam hal ini, attribute_value (nilai x) titik kontrol akan menjadi nilai sebenarnya dari kolom numerik yang boost_amount-nya ditentukan.
FRESHNESS Untuk kasus penggunaan keaktualan, nilai atribut akan berupa durasi antara waktu saat ini dan tanggal di kolom datetime yang ditentukan. Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]]. Mis. 5D, 3DT12H30M, T24H.

InterpolationType

Jenis interpolasi yang akan diterapkan. Defaultnya adalah linear (Piecewise Linear).

Enum
INTERPOLATION_TYPE_UNSPECIFIED Jenis interpolasi tidak ditentukan. Dalam hal ini, nilai defaultnya adalah Linear.
LINEAR Interpolasi linear sepotong-sepotong akan diterapkan.

ModalityType

Jenis modalitas.

Enum
MODALITY_TYPE_UNSPECIFIED Jenis modalitas tidak ditentukan.
TEXT Modalitas teks.
AUDIO Modalitas audio.

FilterParameterBehavior

Perilaku parameter filter.

Enum
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED Perilaku filter default. Sertakan parameter filter untuk penyimpanan data konektor. Untuk jenis datastore lainnya, parameter input filter dihilangkan.
ALWAYS_INCLUDE Selalu sertakan parameter filter untuk semua jenis penyimpanan data.
NEVER_INCLUDE Parameter filter tidak pernah disertakan dalam daftar parameter alat, terlepas dari jenis datastore.

Negara Bagian

Mewakili status ketersediaan dinamis alat.

Enum
STATE_UNSPECIFIED Status default.
ACTIVE Alat ini tersedia dan ditawarkan secara aktif oleh server.
INACTIVE Alat dikonfigurasi atau disematkan, tetapi saat ini tidak ditawarkan oleh server.
STALE Alat ada di server, tetapi tidak cocok dengan versi di server.

CorpusType

Jenis korpus RAG Vertex.

Enum
CORPUS_TYPE_UNSPECIFIED Jenis korpus tidak ditentukan.
USER_OWNED Korpus dibuat dan dimiliki oleh pengguna.
FULLY_MANAGED Korpus dibuat oleh agen.

WidgetType

Semua jenis widget yang tersedia. Nilai baru dapat ditambahkan ke enum ini pada masa mendatang.

Enum
WIDGET_TYPE_UNSPECIFIED Jenis widget tidak ditentukan.
CUSTOM Jenis widget kustom.
PRODUCT_DETAILS Widget detail produk.
QUICK_ACTIONS Widget tindakan cepat.
PRODUCT_COMPARISON Widget perbandingan produk.
ADVANCED_PRODUCT_DETAILS Widget detail produk lanjutan.
SHORT_FORM Widget bentuk pendek.
OVERALL_SATISFACTION Widget kepuasan secara keseluruhan.
ORDER_SUMMARY Widget ringkasan pesanan.
APPOINTMENT_DETAILS Widget detail janji temu.
APPOINTMENT_SCHEDULER Widget penjadwal janji temu.
CONTACT_FORM Widget formulir kontak.

Mode

Strategi yang digunakan untuk memetakan data dari alat sumber ke widget.

Enum
MODE_UNSPECIFIED Mode tidak ditentukan.
FIELD_MAPPING Gunakan peta field_mappings untuk transformasi data.
PYTHON_SCRIPT Gunakan python_script untuk transformasi data.

Jenis

Menentukan cara menghasilkan respons teks.

Enum
TYPE_UNSPECIFIED Jenis tidak ditentukan.
NONE LLM secara dinamis memutuskan apakah akan menghasilkan respons teks bersama widget berdasarkan konteks percakapan.
LLM_GENERATED LLM secara eksplisit diwajibkan untuk menghasilkan respons teks.
STATIC Respons teks statis yang telah ditentukan selalu digunakan.

ExecutionType

Jenis eksekusi alat atau set alat.

Enum
EXECUTION_TYPE_UNSPECIFIED Jenis eksekusi tidak ditentukan. Nilai defaultnya adalah SYNCHRONOUS jika tidak ditentukan.
SYNCHRONOUS Alat dijalankan secara sinkron. Sesi diblokir hingga alat kembali.
ASYNCHRONOUS Alat ini dieksekusi secara asinkron. Sesi akan berlanjut saat alat dijalankan.

MatchType

Jenis pencocokan untuk filter konten.

Enum
MATCH_TYPE_UNSPECIFIED Jenis pencocokan tidak ditentukan.
SIMPLE_STRING_MATCH Konten dicocokkan untuk substring karakter demi karakter.
WORD_BOUNDARY_STRING_MATCH Konten hanya cocok jika pola yang ditemukan dalam teks diapit oleh pembatas kata. Frasa yang dilarang juga dapat berisi pembatas kata.
REGEXP_MATCH Konten dicocokkan menggunakan sintaksis regular expression.

PolicyScope

Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan.

Enum
POLICY_SCOPE_UNSPECIFIED Cakupan kebijakan tidak ditentukan.
USER_QUERY Pemeriksaan kebijakan dipicu saat input pengguna.
AGENT_RESPONSE Pemeriksaan kebijakan dipicu pada respons agen. Menerapkan cakupan kebijakan ini akan menimbulkan latensi tambahan sebelum agen dapat merespons.
USER_QUERY_AND_AGENT_RESPONSE Pemeriksaan kebijakan dipicu pada input pengguna dan respons agen. Menerapkan cakupan kebijakan ini akan menimbulkan latensi tambahan sebelum agen dapat merespons.

HarmCategory

Kategori bahaya.

Enum
HARM_CATEGORY_UNSPECIFIED Kategori bahaya tidak ditentukan.
HARM_CATEGORY_HATE_SPEECH Kategori bahaya adalah ujaran kebencian.
HARM_CATEGORY_DANGEROUS_CONTENT Kategori bahayanya adalah konten berbahaya.
HARM_CATEGORY_HARASSMENT Kategori bahaya adalah pelecehan.
HARM_CATEGORY_SEXUALLY_EXPLICIT Kategori bahayanya adalah konten seksual vulgar.
HARM_CATEGORY_PROFANITY Kategori bahaya adalah kata-kata tidak sopan.
HARM_CATEGORY_TOXIC Kategori bahayanya adalah beracun.

HarmBlockThreshold

Tingkat nilai minimum berbasis probabilitas untuk pemblokiran.

Enum
HARM_BLOCK_THRESHOLD_UNSPECIFIED Batas blokir bahaya tidak ditentukan.
BLOCK_LOW_AND_ABOVE Blokir batas rendah dan lebih tinggi (yaitu, blokir lebih banyak).
BLOCK_MEDIUM_AND_ABOVE Blokir batas sedang dan lebih tinggi.
BLOCK_ONLY_HIGH Ambang batas Block only high (yaitu, blokir lebih sedikit).
BLOCK_NONE Tidak memblokir apa pun.
OFF Nonaktifkan filter keamanan.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk ini dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim ke pengguna.

Selain string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar (true), alat dapat melakukan tindakan merusak. Jika salah (false), alat hanya dapat melakukan tindakan tambahan. Default: true.
  • idempotentHint: Jika benar (true), memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'dunia terbuka' entitas eksternal. Jika salah (false), alat hanya dapat berinteraksi dengan entitas internal. Misalnya, alat penelusuran web akan menjadi open world, sedangkan alat memori tidak akan menjadi open world.

Petunjuk Destruktif: ✅ | Petunjuk Idempoten: ❌ | Petunjuk Hanya Baca: ❌ | Petunjuk Dunia Terbuka: ❌