Alat: get_app_version
Mendapatkan detail versi aplikasi yang ditentukan.
Contoh berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP get_app_version.
| Permintaan Curl |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_app_version", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Skema Input
Pesan permintaan untuk AgentService.GetAppVersion.
GetAppVersionRequest
| Representasi JSON |
|---|
{ "name": string } |
| Kolom | |
|---|---|
name |
Wajib. Nama resource versi aplikasi yang akan diambil. |
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 ( |
| Kolom | |
|---|---|
name |
ID. ID unik versi aplikasi. Format: |
displayName |
Opsional. Nama tampilan versi aplikasi. |
description |
Opsional. Deskripsi versi aplikasi. |
creator |
Hanya output. Email pengguna yang membuat versi aplikasi. |
createTime |
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: |
snapshot |
Hanya output. Snapshot aplikasi saat versi dibuat. |
etag |
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 |
Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z). |
nanos |
Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif. |
AppSnapshot
| Representasi JSON |
|---|
{ "app": { object ( |
| Kolom | |
|---|---|
app |
Opsional. Setelan dasar untuk aplikasi. |
agents[] |
Opsional. Daftar agen di aplikasi. |
tools[] |
Opsional. Daftar alat di aplikasi. |
examples[] |
Opsional. Daftar contoh dalam aplikasi. |
guardrails[] |
Opsional. Daftar pembatasan dalam aplikasi. |
toolsets[] |
Opsional. Daftar toolset di aplikasi. |
Aplikasi
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| Kolom | |
|---|---|
name |
ID. ID unik aplikasi. Format: |
displayName |
Wajib. Nama tampilan aplikasi. |
description |
Opsional. Deskripsi aplikasi yang dapat dibaca manusia. |
pinned |
Opsional. Apakah aplikasi disematkan dalam daftar aplikasi. |
rootAgent |
Opsional. Agen root adalah titik entri aplikasi. Format: |
languageSettings |
Opsional. Setelan bahasa aplikasi. |
timeZoneSettings |
Opsional. Setelan TimeZone aplikasi. |
audioProcessingConfig |
Opsional. Konfigurasi pemrosesan audio aplikasi. |
loggingSettings |
Opsional. Setelan pencatatan log aplikasi. |
errorHandlingSettings |
Opsional. Menangani error setelan aplikasi. |
modelSettings |
Opsional. Setelan model LLM default untuk aplikasi. Setiap resource (misalnya, agen, pembatas) dapat mengganti konfigurasi ini sesuai kebutuhan. |
toolExecutionMode |
Opsional. Mode eksekusi alat untuk aplikasi. Jika tidak diberikan, defaultnya adalah PARALLEL. |
evaluationMetricsThresholds |
Opsional. Batas evaluasi untuk aplikasi. |
variableDeclarations[] |
Opsional. Deklarasi variabel. |
predefinedVariableDeclarations[] |
Hanya output. Deklarasi variabel standar untuk aplikasi. |
globalInstruction |
Opsional. Petunjuk untuk semua agen di aplikasi. Anda dapat menggunakan petunjuk ini untuk menyiapkan identitas atau kepribadian yang stabil di semua agen. |
guardrails[] |
Opsional. Daftar pembatasan untuk aplikasi. Format: |
dataStoreSettings |
Opsional. Setelan penyimpanan data untuk aplikasi. |
defaultChannelProfile |
Opsional. Profil saluran default yang digunakan oleh aplikasi. |
metadata |
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 |
createTime |
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: |
updateTime |
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: |
etag |
Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak. |
deploymentCount |
Hanya output. Jumlah deployment di aplikasi. |
clientCertificateSettings |
Opsional. Setelan sertifikat klien default untuk aplikasi. |
locked |
Opsional. Menunjukkan apakah aplikasi dikunci untuk perubahan. Jika aplikasi dikunci, modifikasi pada resource aplikasi akan ditolak. |
LanguageSettings
| Representasi JSON |
|---|
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string } |
| Kolom | |
|---|---|
defaultLanguageCode |
Opsional. Kode bahasa default aplikasi. |
supportedLanguageCodes[] |
Opsional. Daftar kode bahasa yang didukung oleh aplikasi, selain |
enableMultilingualSupport |
Opsional. Mengaktifkan dukungan multibahasa. Jika benar (true), agen di aplikasi akan menggunakan petunjuk bawaan untuk meningkatkan penanganan input multibahasa. |
fallbackAction |
Opsional. 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 resource lengkap alat, yang memicu eksekusi alat tertentu. - Tindakan sistem yang telah ditentukan sebelumnya, seperti "eskalasikan" atau "keluar", yang memicu sinyal |
TimeZoneSettings
| Representasi JSON |
|---|
{ "timeZone": string } |
| Kolom | |
|---|---|
timeZone |
Opsional. Zona waktu aplikasi dari database zona waktu, misalnya, America/Los_Angeles, Europe/Paris. |
AudioProcessingConfig
| Representasi JSON |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| Kolom | |
|---|---|
synthesizeSpeechConfigs |
Opsional. Konfigurasi cara respons agen harus disintesis, pemetaan dari kode bahasa ke 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 |
bargeInConfig |
Opsional. Mengonfigurasi perilaku agen untuk aktivitas interupsi pengguna. |
inactivityTimeout |
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 ' |
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 ( |
| Kolom | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| Representasi JSON |
|---|
{ "voice": string, "speakingRate": number } |
| Kolom | |
|---|---|
voice |
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. |
speakingRate |
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 setengah kali lebih cepat. Nilai di luar rentang [0,25, 2,0] akan menampilkan error. |
BargeInConfig
| Representasi JSON |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| Kolom | |
|---|---|
disableBargeIn |
Opsional. Menonaktifkan interupsi pengguna saat agen sedang berbicara. Jika benar (true), input pengguna selama pemutaran respons agen akan diabaikan. Tidak digunakan lagi: |
bargeInAwareness |
Opsional. Jika diaktifkan, agen akan menyesuaikan respons berikutnya berdasarkan asumsi bahwa pengguna belum mendengar pesan agen sebelumnya secara keseluruhan. Tindakan ini tidak boleh digunakan dalam skenario saat respons agen ditampilkan secara visual. |
Durasi
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
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 |
Pecahan detik bertanda pada resolusi nanodetik rentang waktu. Durasi kurang dari satu detik ditampilkan dengan kolom |
AmbientSoundConfig
| Representasi JSON |
|---|
{ "volumeGainDb": number, // Union field |
| Kolom | |
|---|---|
volumeGainDb |
Opsional. Peningkatan volume (dalam dB) volume native normal yang didukung oleh derau 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 keefektifan volume untuk nilai yang lebih besar dari itu. |
Kolom union source. Suara sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan. source hanya ada berupa salah satu diantara berikut: |
|
prebuiltAmbientNoise |
Opsional. Tidak digunakan lagi: |
gcsUri |
Opsional. Derau sekitar sebagai file WAV 16 kHz satu saluran yang disimpan di Cloud Storage. Catatan: Pastikan agen layanan CES |
prebuiltAmbientSound |
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 ( |
| Kolom | |
|---|---|
redactionConfig |
Opsional. Konfigurasi cara data sensitif harus disamarkan. |
audioRecordingConfig |
Opsional. Konfigurasi cara interaksi audio harus direkam. |
bigqueryExportSettings |
Opsional. Setelan untuk menjelaskan perilaku ekspor BigQuery untuk aplikasi. Data percakapan akan diekspor ke tabel BigQuery jika diaktifkan. |
cloudLoggingSettings |
Opsional. Setelan untuk menjelaskan perilaku Cloud Logging untuk aplikasi. |
conversationLoggingSettings |
Opsional. Setelan untuk menjelaskan perilaku logging percakapan untuk aplikasi. |
evaluationAudioRecordingConfig |
Opsional. Konfigurasi cara interaksi audio harus direkam untuk evaluasi. Secara default, perekaman audio tidak diaktifkan untuk sesi evaluasi. |
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 |
Opsional. Jika benar (true), penyamaran akan diterapkan dalam berbagai skenario logging, termasuk histori percakapan, Cloud Logging, dan rekaman audio. |
inspectTemplate |
Opsional. Nama template pemeriksaan DLP untuk mengonfigurasi deteksi jenis data sensitif. Format: |
deidentifyTemplate |
Opsional. Nama template de-identifikasi DLP untuk memberikan petunjuk tentang cara melakukan de-identifikasi konten. Format: |
AudioRecordingConfig
| Representasi JSON |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| Kolom | |
|---|---|
gcsBucket |
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 |
gcsPathPrefix |
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 |
BigQueryExportSettings
| Representasi JSON |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| Kolom | |
|---|---|
enabled |
Opsional. Menunjukkan apakah ekspor BigQuery diaktifkan. |
project |
Opsional. ID project set data BigQuery yang akan diekspor datanya. Catatan: Jika set data BigQuery berada di project yang berbeda dengan aplikasi, Anda harus memberikan peran |
dataset |
Opsional. Set data BigQuery tempat data akan diekspor. |
CloudLoggingSettings
| Representasi JSON |
|---|
{ "enableCloudLogging": boolean } |
| Kolom | |
|---|---|
enableCloudLogging |
Opsional. Apakah akan mengaktifkan Cloud Logging untuk sesi. |
ConversationLoggingSettings
| Representasi JSON |
|---|
{ "disableConversationLogging": boolean } |
| Kolom | |
|---|---|
disableConversationLogging |
Opsional. Apakah akan menonaktifkan logging percakapan untuk sesi. |
MetricAnalysisSettings
| Representasi JSON |
|---|
{ "llmMetricsOptedOut": boolean } |
| Kolom | |
|---|---|
llmMetricsOptedOut |
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 ( |
| Kolom | |
|---|---|
errorHandlingStrategy |
Opsional. Strategi yang akan digunakan untuk penanganan error. |
ModelSettings
| Representasi JSON |
|---|
{ "model": string, // Union field |
| Kolom | |
|---|---|
model |
Opsional. Model LLM yang harus digunakan agen. Jika tidak disetel, agen akan mewarisi model dari agen induknya. |
Kolom union
|
|
temperature |
Opsional. Jika disetel, suhu ini akan digunakan untuk model LLM. Temperatur mengontrol keacakan respons model. Temperatur yang lebih rendah menghasilkan respons yang lebih dapat diprediksi. Suhu yang lebih tinggi menghasilkan respons yang lebih kreatif. |
EvaluationMetricsThresholds
| Representasi JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| Kolom | |
|---|---|
goldenEvaluationMetricsThresholds |
Opsional. Nilai minimum metrik evaluasi emas. |
hallucinationMetricBehavior |
Opsional. Tidak digunakan lagi: Gunakan |
goldenHallucinationMetricBehavior |
Opsional. Perilaku metrik halusinasi untuk evaluasi tepercaya. |
scenarioHallucinationMetricBehavior |
Opsional. Perilaku metrik halusinasi untuk evaluasi skenario. |
GoldenEvaluationMetricsThresholds
| Representasi JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| Kolom | |
|---|---|
turnLevelMetricsThresholds |
Opsional. Nilai minimum metrik tingkat perputaran. |
expectationLevelMetricsThresholds |
Opsional. Nilai minimum metrik tingkat ekspektasi. |
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 ( |
| Kolom | |
|---|---|
semanticSimilarityChannel |
Opsional. Saluran kemiripan semantik yang akan digunakan untuk evaluasi. |
Kolom union
|
|
semanticSimilaritySuccessThreshold |
Opsional. Ambang batas keberhasilan untuk kemiripan semantik. Harus berupa bilangan bulat antara 0 dan 4. Defaultnya adalah >= 3. |
Kolom union
|
|
overallToolInvocationCorrectnessThreshold |
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 |
| Kolom | |
|---|---|
Kolom union
|
|
toolInvocationParameterCorrectnessThreshold |
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 ( |
| Kolom | |
|---|---|
extraToolCallBehavior |
Opsional. Perilaku untuk panggilan alat tambahan. Nilai defaultnya adalah GAGAL. |
VariableDeclaration
| Representasi JSON |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama variabel. Nama harus diawali dengan huruf atau garis bawah dan hanya berisi huruf, angka, atau garis bawah. |
description |
Wajib. Deskripsi variabel. |
schema |
Wajib. Skema variabel. |
Skema
| Representasi JSON |
|---|
{ "type": enum ( |
| Kolom | |
|---|---|
type |
Wajib. Jenis data. |
properties |
Opsional. Properti Type.OBJECT. Objek yang berisi daftar pasangan |
required[] |
Opsional. Properti wajib Type.OBJECT. |
description |
Opsional. Deskripsi data. |
items |
Opsional. Skema elemen Type.ARRAY. |
nullable |
Opsional. Menunjukkan apakah nilai boleh berupa null. |
uniqueItems |
Opsional. Menunjukkan bahwa item dalam array harus unik. Hanya berlaku untuk TYPE.ARRAY. |
prefixItems[] |
Opsional. Skema elemen awal Type.ARRAY. |
additionalProperties |
Opsional. Dapat berupa boolean atau objek, mengontrol keberadaan properti tambahan. |
anyOf[] |
Opsional. Nilai harus divalidasi terhadap salah satu (satu atau beberapa) subskema dalam daftar. |
enum[] |
Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. Kita dapat menentukan arah sebagai : {type:STRING, format:enum, enum:["TIMUR", "UTARA", "SELATAN", "BARAT"]} 2. Kita dapat menentukan nomor apartemen sebagai : {type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
Opsional. Nilai default data. |
ref |
Opsional. Memungkinkan referensi tidak langsung antar-node skema. Nilai harus berupa referensi yang valid ke turunan Misalnya, skema berikut menentukan referensi ke node skema bernama "Pet": Nilai properti "pet" adalah referensi ke node skema bernama "Pet". Lihat detailnya di https://json-schema.org/understanding-json-schema/structuring. |
defs |
Opsional. Peta definisi untuk digunakan oleh Objek yang berisi daftar pasangan |
title |
Opsional. Judul skema. |
minItems |
Opsional. Jumlah minimum elemen untuk Type.ARRAY. |
maxItems |
Opsional. Jumlah maksimum elemen untuk Type.ARRAY. |
Kolom union
|
|
minimum |
Opsional. Nilai minimum untuk Type.INTEGER dan Type.NUMBER. |
Kolom union
|
|
maximum |
Opsional. Nilai maksimum untuk Type.INTEGER dan Type.NUMBER. |
PropertiesEntry
| Representasi JSON |
|---|
{
"key": string,
"value": {
object ( |
| Kolom | |
|---|---|
key |
|
value |
|
Nilai
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union kind. Jenis nilai. kind hanya ada berupa salah satu diantara berikut: |
|
nullValue |
Mewakili nilai null. |
numberValue |
Mewakili nilai ganda. |
stringValue |
Mewakili nilai string. |
boolValue |
Mewakili nilai boolean. |
structValue |
Mewakili nilai terstruktur. |
listValue |
Merepresentasikan |
Struct
| Representasi JSON |
|---|
{ "fields": { string: value, ... } } |
| Kolom | |
|---|---|
fields |
Peta tidak berurutan dari nilai yang diketik secara dinamis. Objek yang berisi daftar pasangan |
FieldsEntry
| Representasi JSON |
|---|
{ "key": string, "value": value } |
| Kolom | |
|---|---|
key |
|
value |
|
ListValue
| Representasi JSON |
|---|
{ "values": [ value ] } |
| Kolom | |
|---|---|
values[] |
Kolom berulang dari nilai yang diketik secara dinamis. |
DefsEntry
| Representasi JSON |
|---|
{
"key": string,
"value": {
object ( |
| Kolom | |
|---|---|
key |
|
value |
|
DataStoreSettings
| Representasi JSON |
|---|
{
"engines": [
{
object ( |
| Kolom | |
|---|---|
engines[] |
Hanya output. Mesin untuk aplikasi. |
Mesin
| Representasi JSON |
|---|
{
"name": string,
"type": enum ( |
| Kolom | |
|---|---|
name |
Hanya output. Nama resource mesin. Format: |
type |
Hanya output. Jenis mesin. |
ChannelProfile
| Representasi JSON |
|---|
{ "profileId": string, "channelType": enum ( |
| Kolom | |
|---|---|
profileId |
Opsional. ID unik profil channel. |
channelType |
Opsional. Jenis profil channel. |
personaProperty |
Opsional. Properti persona profil channel. |
disableDtmf |
Opsional. Apakah akan menonaktifkan DTMF (nada ganda multi-frekuensi). |
disableBargeInControl |
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 menginterupsi. |
webWidgetConfig |
Opsional. Konfigurasi untuk widget web. |
noiseSuppressionLevel |
Opsional. Tingkat peredam bising profil channel. Nilai yang tersedia adalah "low", "moderate", "high", "very_high". |
PersonaProperty
| Representasi JSON |
|---|
{
"persona": enum ( |
| Kolom | |
|---|---|
persona |
Opsional. Persona channel. |
WebWidgetConfig
| Representasi JSON |
|---|
{ "modality": enum ( |
| Kolom | |
|---|---|
modality |
Opsional. Modalitas widget web. |
theme |
Opsional. Tema widget web. |
webWidgetTitle |
Opsional. Judul widget web. |
securitySettings |
Opsional. Setelan keamanan widget web. |
SecuritySettings
| Representasi JSON |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| Kolom | |
|---|---|
enablePublicAccess |
Opsional. Menunjukkan apakah akses publik ke widget web diaktifkan. Jika |
enableOriginCheck |
Opsional. Menunjukkan apakah pemeriksaan asal untuk widget web diaktifkan. Jika |
allowedOrigins[] |
Opsional. Asal 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 |
Opsional. Menunjukkan apakah verifikasi reCAPTCHA untuk widget web diaktifkan. |
MetadataEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
ClientCertificateSettings
| Representasi JSON |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| Kolom | |
|---|---|
tlsCertificate |
Wajib. Sertifikat TLS yang dienkode dalam format PEM. String ini harus menyertakan baris header awal dan footer akhir. |
privateKey |
Wajib. Nama resource versi rahasia SecretManager yang menyimpan kunci pribadi yang dienkode dalam format PEM. Format: |
passphrase |
Opsional. Nama resource versi rahasia SecretManager yang menyimpan frasa sandi untuk mendekripsi kunci pribadi. Harus dibiarkan tidak disetel jika kunci pribadi tidak dienkripsi. Format: |
Agen
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "description": string, "modelSettings": { object ( |
| Kolom | |
|---|---|
name |
ID. ID unik agen. Format: |
displayName |
Wajib. Nama tampilan agen. |
description |
Opsional. Deskripsi agen yang dapat dibaca manusia. |
modelSettings |
Opsional. Konfigurasi untuk model LLM. |
instruction |
Opsional. Petunjuk untuk model LLM guna memandu perilaku agen. |
tools[] |
Opsional. Daftar alat yang tersedia untuk agen. Format: |
childAgents[] |
Opsional. Daftar agen turunan di pohon agen. Format: |
beforeAgentCallbacks[] |
Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Callback yang diberikan dieksekusi secara berurutan dalam urutan yang sama persis dengan urutan yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati. |
afterAgentCallbacks[] |
Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Callback yang diberikan dieksekusi secara berurutan dalam urutan yang sama persis dengan urutan yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati. |
beforeModelCallbacks[] |
Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan yang sama persis dengan urutan yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati. |
afterModelCallbacks[] |
Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan yang sama persis dengan urutan yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati. |
beforeToolCallbacks[] |
Opsional. Callback yang akan dieksekusi sebelum alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan yang sama persis dengan urutan yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati. |
afterToolCallbacks[] |
Opsional. Callback yang akan dieksekusi setelah alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan yang sama persis dengan urutan yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati. |
createTime |
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: |
updateTime |
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: |
guardrails[] |
Opsional. Daftar batasan untuk agen. Format: |
etag |
ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak. |
toolsets[] |
Opsional. Daftar set alat untuk agen. |
generatedSummary |
Hanya output. Jika agen dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan. |
transferRules[] |
Opsional. Aturan transfer agen. Jika ada beberapa aturan yang cocok, aturan pertama dalam daftar akan digunakan. |
Kolom union agent_type. Jenis agen. agent_type hanya ada berupa salah satu diantara berikut: |
|
llmAgent |
Opsional. Jenis agen default. |
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 dari aplikasi, Anda harus memberikan |
RemoteDialogflowAgent
| Representasi JSON |
|---|
{ "agent": string, "flowId": string, "environmentId": string, "inputVariableMapping": { string: string, ... }, "outputVariableMapping": { string: string, ... }, "respectResponseInterruptionSettings": boolean } |
| Kolom | |
|---|---|
agent |
Wajib. Nama resource agen Dialogflow. Format: |
flowId |
Opsional. ID alur untuk alur di agen Dialogflow. |
environmentId |
Opsional. ID lingkungan agen Dialogflow yang akan digunakan untuk eksekusi agen. Jika tidak ditentukan, lingkungan draf akan digunakan. |
inputVariableMapping |
Opsional. Pemetaan nama variabel aplikasi ke nama parameter sesi Dialogflow yang akan dikirim ke agen Dialogflow sebagai input. Objek yang berisi daftar pasangan |
outputVariableMapping |
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 |
respectResponseInterruptionSettings |
Opsional. Menunjukkan apakah akan mematuhi setelan gangguan tingkat pesan yang dikonfigurasi di agen Dialogflow.
|
InputVariableMappingEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
OutputVariableMappingEntry
| Representasi JSON |
|---|
{ "key": string, "value": string } |
| Kolom | |
|---|---|
key |
|
value |
|
Callback
| Representasi JSON |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| Kolom | |
|---|---|
description |
Opsional. Deskripsi callback yang dapat dibaca manusia. |
disabled |
Opsional. Apakah callback dinonaktifkan. Panggilan balik yang dinonaktifkan akan diabaikan oleh agen. |
proactiveExecutionEnabled |
Opsional. Jika diaktifkan, callback juga akan dieksekusi pada output model perantara. Setelan ini hanya memengaruhi callback setelah model. AKTIFKAN DENGAN HATI-HATI. Biasanya, after_model_callback 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 |
Wajib. Kode python yang akan dieksekusi untuk callback. |
AgentToolset
| Representasi JSON |
|---|
{ "toolset": string, "toolIds": [ string ] } |
| Kolom | |
|---|---|
toolset |
Wajib. Nama resource toolset. Format: |
toolIds[] |
Opsional. ID alat untuk memfilter toolset. |
TransferRule
| Representasi JSON |
|---|
{ "childAgent": string, "direction": enum ( |
| Kolom | |
|---|---|
childAgent |
Wajib. Nama resource agen turunan tempat aturan diterapkan. Format: |
direction |
Wajib. Arah transfer. |
Kolom union rule_type. Jenis aturan. rule_type hanya ada berupa salah satu diantara berikut: |
|
deterministicTransfer |
Opsional. Aturan yang langsung ditransfer ke agen target saat kondisi terpenuhi. |
disablePlannerTransfer |
Opsional. Aturan yang mencegah perencana mentransfer ke agen target. |
DeterministicTransfer
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union condition_type. Kondisi yang akan dievaluasi. condition_type hanya ada berupa salah satu diantara berikut: |
|
expressionCondition |
Opsional. Aturan yang mengevaluasi kondisi status sesi. Jika kondisi bernilai benar, transfer akan terjadi. |
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 |
Wajib. Representasi string dari kondisi cloud.api.Expression. |
PythonCodeCondition
| Representasi JSON |
|---|
{ "pythonCode": string } |
| Kolom | |
|---|---|
pythonCode |
Wajib. Kode python yang akan dieksekusi. |
DisablePlannerTransfer
| Representasi JSON |
|---|
{
"expressionCondition": {
object ( |
| Kolom | |
|---|---|
expressionCondition |
Wajib. Jika kondisi bernilai benar, perencana tidak akan diizinkan untuk mentransfer ke agen target. |
Alat
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "executionType": enum ( |
| Kolom | |
|---|---|
name |
ID. ID unik alat. Format: -
|
displayName |
Hanya output. Nama tampilan alat, yang berasal dari jenis alat. Misalnya, nama tampilan [ClientFunction][Tool.ClientFunction] berasal dari properti |
executionType |
Opsional. Jenis eksekusi alat. |
createTime |
Hanya output. Stempel waktu saat alat dibuat. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
updateTime |
Hanya output. Stempel waktu saat alat terakhir diperbarui. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
etag |
ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak. |
generatedSummary |
Hanya output. Jika alat dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan tersebut. |
toolFakeConfig |
Opsional. Konfigurasi untuk perilaku alat dalam mode palsu. |
Kolom union tool_type. Jenis alat. tool_type hanya ada berupa salah satu diantara berikut: |
|
clientFunction |
Opsional. Fungsi klien. |
openApiTool |
Opsional. Alat API terbuka. |
googleSearchTool |
Opsional. Alat penelusuran google. |
connectorTool |
Opsional. Alat Integration Connector. |
dataStoreTool |
Opsional. Alat penyimpanan data. |
pythonFunction |
Opsional. Alat fungsi python. |
mcpTool |
Opsional. Alat MCP. Alat MCP tidak dapat dibuat atau diperbarui secara langsung dan dikelola oleh toolset MCP. |
fileSearchTool |
Opsional. Alat penelusuran file. |
systemTool |
Opsional. Alat sistem. |
widgetTool |
Opsional. Alat widget. |
ClientFunction
| Representasi JSON |
|---|
{ "name": string, "description": string, "parameters": { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama fungsi. |
description |
Opsional. Deskripsi fungsi. |
parameters |
Opsional. Skema parameter fungsi. |
response |
Opsional. Skema respons fungsi. |
OpenApiTool
| Representasi JSON |
|---|
{ "openApiSchema": string, "name": string, "description": string, "apiAuthentication": { object ( |
| Kolom | |
|---|---|
openApiSchema |
Wajib. Skema OpenAPI dalam format JSON atau YAML. |
name |
Opsional. Nama alat. Jika tidak diberikan, nama alat akan diambil dari skema OpenAPI, dari |
description |
Opsional. Deskripsi alat. Jika tidak diberikan, deskripsi alat akan berasal dari skema OpenAPI, dari |
apiAuthentication |
Opsional. Informasi autentikasi yang diperlukan oleh API. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang akan dipercayai klien. |
serviceDirectoryConfig |
Opsional. Konfigurasi Direktori Layanan. |
ignoreUnknownFields |
Opsional. Jika benar, agen akan mengabaikan kolom yang tidak diketahui dalam respons API. |
url |
Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di alat dalam dependensi lingkungan selama proses ekspor jika skema berisi URL server. Selama proses impor, jika URL ini ada dalam dependensi lingkungan dan skema memiliki placeholder $env_var, URL ini akan menggantikan placeholder dalam skema. |
ApiAuthentication
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut: |
|
apiKeyConfig |
Opsional. Konfigurasi untuk autentikasi kunci API. |
oauthConfig |
Opsional. Konfigurasi untuk OAuth. |
serviceAgentIdTokenAuthConfig |
Opsional. Konfigurasi untuk autentikasi token ID yang dibuat dari agen layanan CES. |
serviceAccountAuthConfig |
Opsional. Konfigurasi untuk autentikasi akun layanan. |
bearerTokenConfig |
Opsional. Konfigurasi untuk autentikasi token bearer. |
ApiKeyConfig
| Representasi JSON |
|---|
{
"keyName": string,
"apiKeySecretVersion": string,
"requestLocation": enum ( |
| Kolom | |
|---|---|
keyName |
Wajib. Nama parameter atau nama header kunci API. Misalnya, Jika permintaan API adalah "https://example.com/act?X-Api-Key= |
apiKeySecretVersion |
Wajib. Nama resource versi secret SecretManager yang menyimpan kunci API. Format: Catatan: Anda harus memberikan peran |
requestLocation |
Wajib. Lokasi kunci dalam permintaan. |
OAuthConfig
| Representasi JSON |
|---|
{
"oauthGrantType": enum ( |
| Kolom | |
|---|---|
oauthGrantType |
Wajib. Jenis pemberian OAuth. |
clientId |
Wajib. Client ID dari penyedia OAuth. |
clientSecretVersion |
Wajib. Nama resource versi secret SecretManager yang menyimpan rahasia klien. Format: Catatan: Anda harus memberikan peran |
tokenEndpoint |
Wajib. Endpoint token di penyedia OAuth untuk ditukar dengan token akses. |
scopes[] |
Opsional. Cakupan OAuth yang akan diberikan. |
ServiceAccountAuthConfig
| Representasi JSON |
|---|
{ "serviceAccount": string, "scopes": [ string ] } |
| Kolom | |
|---|---|
serviceAccount |
Wajib. Alamat email akun layanan yang digunakan untuk autentikasi. CES menggunakan akun layanan ini untuk menukar token akses dan token akses tersebut kemudian dikirim di header Akun layanan harus memiliki peran |
scopes[] |
Opsional. Cakupan OAuth yang akan diberikan. Jika tidak ditentukan, cakupan default |
BearerTokenConfig
| Representasi JSON |
|---|
{ "token": string } |
| Kolom | |
|---|---|
token |
Wajib. Token pemilik. Harus dalam format |
TlsConfig
| Representasi JSON |
|---|
{
"caCerts": [
{
object ( |
| Kolom | |
|---|---|
caCerts[] |
Wajib. Menentukan daftar sertifikat CA kustom yang diizinkan untuk verifikasi HTTPS. |
CaCert
| Representasi JSON |
|---|
{ "displayName": string, "cert": string } |
| Kolom | |
|---|---|
displayName |
Wajib. Nama sertifikat CA kustom yang diizinkan. Ini dapat digunakan untuk membedakan sertifikat CA kustom. |
cert |
Wajib. Sertifikat CA kustom yang diizinkan (dalam format DER) untuk verifikasi HTTPS. Tindakan ini akan menggantikan trust store SSL default. Jika kosong atau tidak ditentukan, CES akan menggunakan penyimpanan tepercaya default Google untuk memverifikasi sertifikat. Catatan: Pastikan sertifikat server HTTPS ditandatangani dengan "subject alt name". Misalnya, sertifikat dapat ditandatangani sendiri menggunakan perintah berikut, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") String berenkode base64. |
ServiceDirectoryConfig
| Representasi JSON |
|---|
{ "service": string } |
| Kolom | |
|---|---|
service |
Wajib. Nama layanan Service Directory. Format: |
GoogleSearchTool
| Representasi JSON |
|---|
{
"name": string,
"description": string,
"contextUrls": [
string
],
"preferredDomains": [
string
],
"excludeDomains": [
string
],
"promptConfig": {
object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat. |
description |
Opsional. Deskripsi tujuan alat. |
contextUrls[] |
Opsional. Konten akan diambil langsung dari URL ini untuk konteks dan perujukan. Contoh: "https://example.com/path.html". Maksimum 20 URL yang diizinkan. |
preferredDomains[] |
Opsional. Menentukan domain untuk membatasi hasil penelusuran. Contoh: "example.com", "another.site". Maksimum 20 domain dapat ditentukan. |
excludeDomains[] |
Opsional. Daftar domain yang akan dikecualikan dari hasil penelusuran. Contoh: "example.com". Maksimum 2.000 domain dapat dikecualikan. |
promptConfig |
Opsional. Petunjuk perintah yang diteruskan ke perencana tentang cara hasil penelusuran harus diproses untuk teks dan suara. |
PromptConfig
| Representasi JSON |
|---|
{ "textPrompt": string, "voicePrompt": string } |
| Kolom | |
|---|---|
textPrompt |
Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan chat. Jika tidak disetel, perintah default akan digunakan. |
voicePrompt |
Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan suara. Jika tidak disetel, perintah default akan digunakan. |
ConnectorTool
| Representasi JSON |
|---|
{ "connection": string, "action": { object ( |
| Kolom | |
|---|---|
connection |
Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: |
action |
Wajib. Tindakan yang akan digunakan alat. |
authConfig |
Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan ConnectorTool akan gagal. Lihat https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override untuk mengetahui detailnya. |
name |
Opsional. Nama alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak. |
description |
Opsional. Deskripsi alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak. |
Tindakan
| Representasi JSON |
|---|
{ "inputFields": [ string ], "outputFields": [ string ], // Union field |
| Kolom | |
|---|---|
inputFields[] |
Opsional. Kolom entitas yang akan digunakan sebagai input untuk operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entitas akan digunakan. |
outputFields[] |
Opsional. Kolom entitas yang akan ditampilkan dari operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entity akan ditampilkan. |
Kolom union action_spec. Spesifikasi untuk tindakan yang akan dikonfigurasi agar dapat digunakan oleh alat. action_spec hanya ada berupa salah satu diantara berikut: |
|
connectionActionId |
ID tindakan Koneksi yang akan digunakan alat. |
entityOperation |
Konfigurasi operasi entitas yang akan digunakan alat. |
EntityOperation
| Representasi JSON |
|---|
{
"entityId": string,
"operation": enum ( |
| Kolom | |
|---|---|
entityId |
Wajib. ID entitas. |
operation |
Wajib. Operasi yang akan dilakukan pada entity. |
EndUserAuthConfig
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut: |
|
oauth2AuthCodeConfig |
Autentikasi Kode Otorisasi Oauth 2.0. |
oauth2JwtBearerConfig |
Autentikasi pemberian otorisasi OAuth 2.0 Profil JWT. |
Oauth2AuthCodeConfig
| Representasi JSON |
|---|
{ "oauthToken": string } |
| Kolom | |
|---|---|
oauthToken |
Wajib. Nama parameter token OAuth yang akan diteruskan. Harus dalam format |
Oauth2JwtBearerConfig
| Representasi JSON |
|---|
{ "issuer": string, "subject": string, "clientKey": string } |
| Kolom | |
|---|---|
issuer |
Wajib. Nama parameter penerbit yang akan diteruskan. Harus dalam format |
subject |
Wajib. Nama parameter subjek yang akan diteruskan. Harus dalam format |
clientKey |
Wajib. Nama parameter klien yang akan diteruskan. Harus dalam format |
DataStoreTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "boostSpecs": [ { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat penyimpanan data. |
description |
Opsional. Deskripsi alat. |
boostSpecs[] |
Opsional. Spesifikasi penguatan untuk menguatkan dokumen tertentu. |
modalityConfigs[] |
Opsional. Konfigurasi modalitas untuk penyimpanan data. |
filterParameterBehavior |
Opsional. Perilaku parameter filter. |
Kolom union search_source. Menentukan sumber penelusuran, baik DataStore tunggal maupun Mesin Telusur. search_source hanya ada berupa salah satu diantara berikut: |
|
dataStoreSource |
Opsional. Menelusuri dalam satu DataStore tertentu. |
engineSource |
Opsional. Menelusuri dalam Engine (berpotensi di beberapa DataStore). |
DataStoreSource
| Representasi JSON |
|---|
{
"filter": string,
"dataStore": {
object ( |
| Kolom | |
|---|---|
filter |
Opsional. Spesifikasi filter untuk DataStore. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
dataStore |
Opsional. Penyimpanan data. |
DataStore
| Representasi JSON |
|---|
{ "name": string, "type": enum ( |
| Kolom | |
|---|---|
name |
Wajib. Nama lengkap resource DataStore. Format: |
type |
Hanya output. Jenis penyimpanan data. Kolom ini bersifat hanya baca dan diisi oleh server. |
documentProcessingMode |
Hanya output. Mode pemrosesan dokumen untuk koneksi penyimpanan data. Hanya ditetapkan untuk penyimpanan data PUBLIC_WEB dan UNSTRUCTURED. |
displayName |
Hanya output. Nama tampilan penyimpanan data. |
createTime |
Hanya output. Stempel waktu saat penyimpanan data dibuat. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
connectorConfig |
Hanya output. Konfigurasi konektor untuk koneksi penyimpanan data. |
ConnectorConfig
| Representasi JSON |
|---|
{ "collection": string, "collectionDisplayName": string, "dataSource": string } |
| Kolom | |
|---|---|
collection |
Nama resource koleksi tempat penyimpanan data berada. |
collectionDisplayName |
Nama tampilan koleksi tempat penyimpanan data berada. |
dataSource |
Nama sumber data. Contoh: |
EngineSource
| Representasi JSON |
|---|
{
"engine": string,
"dataStoreSources": [
{
object ( |
| Kolom | |
|---|---|
engine |
Wajib. Nama lengkap resource Engine. Format: |
dataStoreSources[] |
Opsional. Digunakan untuk menargetkan DataStore tertentu dalam Engine. Jika kosong, penelusuran berlaku untuk semua DataStore yang terkait dengan Engine. |
filter |
Opsional. Filter yang diterapkan pada penelusuran di seluruh Mesin Telusur. Tidak relevan dan tidak digunakan jika 'data_store_sources' diberikan. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
BoostSpecs
| Representasi JSON |
|---|
{
"dataStores": [
string
],
"spec": [
{
object ( |
| Kolom | |
|---|---|
dataStores[] |
Wajib. Penyimpanan Data tempat konfigurasi peningkatan diterapkan. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
spec[] |
Wajib. Daftar spesifikasi peningkat. |
BoostSpec
| Representasi JSON |
|---|
{
"conditionBoostSpecs": [
{
object ( |
| Kolom | |
|---|---|
conditionBoostSpecs[] |
Wajib. Daftar spesifikasi peningkat. |
ConditionBoostSpec
| Representasi JSON |
|---|
{
"condition": string,
"boost": number,
"boostControlSpec": {
object ( |
| Kolom | |
|---|---|
condition |
Wajib. Ekspresi yang menentukan kondisi peninggian. Sintaksisnya sama dengan sintaksis ekspresi filter. Saat ini, satu-satunya kondisi yang didukung adalah daftar kode bahasa BCP-47. Contoh: Untuk meningkatkan saran dalam bahasa Inggris atau Prancis: (lang_code: ANY("en", "fr")) |
boost |
Opsional. Kekuatan peningkat, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan peringkat. Nilai defaultnya adalah 0.0. Menetapkan ke 1.0 akan memberikan promosi besar pada saran. Namun, hasil teratas tidak selalu merupakan saran yang dipromosikan. Menyetel ke -1,0 akan menurunkan saran secara signifikan. Namun, saran lain yang relevan mungkin masih ditampilkan. Menyetel ke 0,0 berarti tidak ada peningkatan yang diterapkan. Kondisi peningkatan diabaikan. |
boostControlSpec |
Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan. |
BoostControlSpec
| Representasi JSON |
|---|
{ "fieldName": string, "attributeType": enum ( |
| Kolom | |
|---|---|
fieldName |
Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat. |
attributeType |
Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Untuk nilai numerik, caranya cukup mudah, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value). |
interpolationType |
Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah. |
controlPoints[] |
Opsional. Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolation_type di atas) melewati titik kontrol yang tercantum di sini. |
ControlPoint
| Representasi JSON |
|---|
{ "attributeValue": string, "boostAmount": number } |
| Kolom | |
|---|---|
attributeValue |
Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD |
boostAmount |
Opsional. Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attribute_value dievaluasi ke nilai yang ditentukan di atas. |
ModalityConfig
| Representasi JSON |
|---|
{ "modalityType": enum ( |
| Kolom | |
|---|---|
modalityType |
Wajib. Jenis modalitas. |
rewriterConfig |
Opsional. Konfigurasi penulis ulang. |
summarizationConfig |
Opsional. Konfigurasi ringkasan. |
groundingConfig |
Opsional. Konfigurasi perujukan. |
RewriterConfig
| Representasi JSON |
|---|
{
"modelSettings": {
object ( |
| Kolom | |
|---|---|
modelSettings |
Wajib. Konfigurasi untuk model LLM. |
prompt |
Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan. |
disabled |
Opsional. Apakah penulis ulang dinonaktifkan. |
SummarizationConfig
| Representasi JSON |
|---|
{
"modelSettings": {
object ( |
| Kolom | |
|---|---|
modelSettings |
Opsional. Konfigurasi untuk model LLM. |
prompt |
Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan. |
disabled |
Opsional. Apakah ringkasan dinonaktifkan. |
GroundingConfig
| Representasi JSON |
|---|
{ "groundingLevel": number, "disabled": boolean } |
| Kolom | |
|---|---|
groundingLevel |
Opsional. Nilai minimum perujukan jawaban berdasarkan sumber yang diambil. Nilai memiliki rentang yang dapat dikonfigurasi [1, 5]. Tingkat ini digunakan untuk menentukan batas keterujukan jawaban, yang berarti bahwa semua respons dengan skor keterujukan di bawah batas akan kembali menampilkan hanya cuplikan yang relevan. Misalnya, tingkat 3 berarti skor perujukan harus 3 atau lebih tinggi agar respons ditampilkan. |
disabled |
Opsional. Apakah perujukan dinonaktifkan. |
PythonFunction
| Representasi JSON |
|---|
{ "name": string, "pythonCode": string, "description": string } |
| Kolom | |
|---|---|
name |
Opsional. Nama fungsi Python yang akan dijalankan. Harus cocok dengan nama fungsi Python yang ditentukan dalam kode python. Peka huruf besar/kecil. Jika nama tidak diberikan, fungsi pertama yang ditentukan dalam kode python akan digunakan. |
pythonCode |
Opsional. Kode Python yang akan dieksekusi untuk alat. |
description |
Hanya output. Deskripsi fungsi Python, di-parsing dari docstring kode python. |
McpTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "inputSchema": { object ( |
| Kolom | |
|---|---|
name |
Wajib. Nama alat MCP. |
description |
Opsional. Deskripsi alat MCP. |
inputSchema |
Opsional. Skema argumen input alat MCP. |
outputSchema |
Opsional. Skema argumen output alat MCP. |
serverAddress |
Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transport HTTP yang dapat di-streaming yang didukung. Ini sama dengan server_address di McpToolset. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya. |
apiAuthentication |
Opsional. Informasi autentikasi yang diperlukan untuk menjalankan alat terhadap server MCP. Untuk autentikasi token pembawa, token hanya berlaku untuk eksekusi alat, bukan untuk alat listingan. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien. |
serviceDirectoryConfig |
Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter. |
FileSearchTool
| Representasi JSON |
|---|
{
"corpusType": enum ( |
| Kolom | |
|---|---|
corpusType |
Opsional. Jenis korpus. Default-nya adalah FULLY_MANAGED. |
name |
Wajib. Nama alat. |
description |
Opsional. Deskripsi alat. |
fileCorpus |
Opsional. Korpus tempat file disimpan. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
SystemTool
| Representasi JSON |
|---|
{ "name": string, "description": string } |
| Kolom | |
|---|---|
name |
Wajib. Nama alat sistem. |
description |
Hanya output. Deskripsi alat sistem. |
WidgetTool
| Representasi JSON |
|---|
{ "name": string, "description": string, "widgetType": enum ( |
| Kolom | |
|---|---|
name |
Wajib. Nama tampilan alat widget. |
description |
Opsional. Deskripsi alat widget. |
widgetType |
Opsional. Jenis alat widget. Jika tidak ditentukan, jenis defaultnya adalah CUSTOMIZED. |
Kolom union input. Input alat widget. input hanya ada berupa salah satu diantara berikut: |
|
parameters |
Opsional. Parameter input alat widget. |
ToolFakeConfig
| Representasi JSON |
|---|
{ "enableFakeMode": boolean, // Union field |
| Kolom | |
|---|---|
enableFakeMode |
Opsional. Apakah alat menggunakan mode palsu. |
Kolom union tool_response. Respons bersifat statis atau disediakan oleh fungsi python. tool_response hanya ada berupa salah satu diantara berikut: |
|
codeBlock |
Opsional. Blok kode yang akan dieksekusi, bukan panggilan alat yang sebenarnya. |
CodeBlock
| Representasi JSON |
|---|
{ "pythonCode": string } |
| Kolom | |
|---|---|
pythonCode |
Wajib. Kode Python yang akan dipanggil dalam mode palsu alat. Tanda tangan fungsi Python yang diharapkan - Untuk menangkap semua panggilan alat: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Untuk menangkap panggilan alat tertentu: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Jika fungsi menampilkan None, alat yang sebenarnya akan dipanggil. |
Contoh
| Representasi JSON |
|---|
{
"name": string,
"displayName": string,
"description": string,
"entryAgent": string,
"messages": [
{
object ( |
| Kolom | |
|---|---|
name |
ID. ID unik contoh. Format: |
displayName |
Wajib. Nama tampilan contoh. |
description |
Opsional. Deskripsi contoh yang dapat dibaca manusia. |
entryAgent |
Opsional. Agen yang awalnya menangani percakapan. Jika tidak ditentukan, contoh ini mewakili percakapan yang ditangani oleh agen root. Format: |
messages[] |
Opsional. Kumpulan pesan yang membentuk percakapan. |
createTime |
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: |
updateTime |
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: |
invalid |
Hanya output. Contoh dapat menjadi tidak valid jika resource yang dirujuk dihapus. Contoh yang tidak valid tidak akan digunakan sebagai contoh sedikit tembakan. |
etag |
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 ( |
| Kolom | |
|---|---|
role |
Opsional. Peran dalam percakapan, misalnya, pengguna, agen. |
chunks[] |
Opsional. Konten pesan sebagai serangkaian bagian. |
eventTime |
Opsional. Stempel waktu saat pesan dikirim atau diterima. Tidak boleh digunakan jika pesan adalah bagian dari Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
Chunk
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union data. Data chunk. data hanya ada berupa salah satu diantara berikut: |
|
text |
Opsional. Data teks. |
transcript |
Opsional. Transkrip yang terkait dengan audio. |
blob |
Opsional. Data blob. |
payload |
Opsional. Data payload kustom. |
image |
Opsional. Data gambar. |
toolCall |
Opsional. Permintaan eksekusi alat. |
toolResponse |
Opsional. Respons eksekusi alat. |
agentTransfer |
Opsional. Acara transfer agen. |
updatedVariables |
Struct merepresentasikan variabel yang diperbarui dalam percakapan, yang dikelompokkan berdasarkan nama variabel. |
defaultVariables |
Struct merepresentasikan variabel default di awal percakapan, yang dikelompokkan berdasarkan nama variabel. |
Blob
| Representasi JSON |
|---|
{ "mimeType": string, "data": string } |
| Kolom | |
|---|---|
mimeType |
Wajib. Jenis MIME standar IANA dari data sumber. |
data |
Wajib. Byte mentah blob. String berenkode base64. |
Gambar
| Representasi JSON |
|---|
{ "mimeType": string, "data": string } |
| Kolom | |
|---|---|
mimeType |
Wajib. Jenis MIME standar IANA dari data sumber. Jenis gambar yang didukung meliputi: * image/png * image/jpeg * image/webp |
data |
Wajib. Byte mentah gambar. String berenkode base64. |
ToolCall
| Representasi JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, // Union field |
| Kolom | |
|---|---|
id |
Opsional. ID unik panggilan alat. Jika diisi, klien harus menampilkan hasil eksekusi dengan ID yang cocok di |
displayName |
Hanya output. Nama tampilan alat. |
args |
Opsional. Parameter dan nilai input untuk alat dalam format objek JSON. |
Kolom union tool_identifier. ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. tool_identifier hanya ada berupa salah satu diantara berikut: |
|
tool |
Opsional. Nama alat yang akan dieksekusi. Format: |
toolsetTool |
Opsional. Alat toolset yang akan dieksekusi. |
ToolsetTool
| Representasi JSON |
|---|
{ "toolset": string, "toolId": string } |
| Kolom | |
|---|---|
toolset |
Wajib. Nama resource Toolset dari mana alat ini berasal. Format: |
toolId |
Opsional. ID alat untuk memfilter alat guna mengambil skemanya. |
ToolResponse
| Representasi JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, // Union field |
| Kolom | |
|---|---|
id |
Opsional. ID yang cocok dengan |
displayName |
Hanya output. Nama tampilan alat. |
response |
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. |
Kolom union tool_identifier. ID alat yang dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. tool_identifier hanya ada berupa salah satu diantara berikut: |
|
tool |
Opsional. Nama alat yang akan dieksekusi. Format: |
toolsetTool |
Opsional. Alat toolset yang dieksekusi. |
AgentTransfer
| Representasi JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| Kolom | |
|---|---|
targetAgent |
Wajib. Agen yang akan menerima pengalihan percakapan. Agen akan menangani percakapan mulai dari saat ini. Format: |
displayName |
Hanya output. Nama tampilan agen. |
Pagar pembatas
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object ( |
| Kolom | |
|---|---|
name |
ID. ID unik pembatas. Format: |
displayName |
Wajib. Nama tampilan pembatas. |
description |
Opsional. Deskripsi pembatasan. |
enabled |
Opsional. Apakah pembatasan diaktifkan atau tidak. |
action |
Opsional. Tindakan yang harus dilakukan saat pembatas dipicu. |
createTime |
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: |
updateTime |
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: |
etag |
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 pembatas. guardrail_type hanya ada berupa salah satu diantara berikut: |
|
contentFilter |
Opsional. Pembatasan yang melarang penggunaan konten tertentu dalam percakapan. |
llmPromptSecurity |
Opsional. Pembatas yang memblokir percakapan jika perintah dianggap tidak aman berdasarkan klasifikasi LLM. |
llmPolicy |
Opsional. Pembatas yang memblokir percakapan jika respons LLM dianggap melanggar kebijakan berdasarkan klasifikasi LLM. |
modelSafety |
Opsional. Membatasi percakapan jika respons LLM dianggap tidak aman berdasarkan setelan keamanan model. |
codeCallback |
Opsional. Pembatas yang berpotensi memblokir percakapan berdasarkan hasil eksekusi callback. |
ContentFilter
| Representasi JSON |
|---|
{
"bannedContents": [
string
],
"bannedContentsInUserInput": [
string
],
"bannedContentsInAgentResponse": [
string
],
"matchType": enum ( |
| Kolom | |
|---|---|
bannedContents[] |
Opsional. Daftar frasa yang dilarang. Berlaku untuk input pengguna dan respons agen. |
bannedContentsInUserInput[] |
Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk input pengguna. |
bannedContentsInAgentResponse[] |
Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk respons agen. |
matchType |
Wajib. Jenis pencocokan untuk filter konten. |
disregardDiacritics |
Opsional. Jika benar (true), diakritik diabaikan selama pencocokan. |
LlmPromptSecurity
| Representasi JSON |
|---|
{ "failOpen": boolean, // Union field |
| Kolom | |
|---|---|
failOpen |
Opsional. Menentukan perilaku saat pembatasan menemukan 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 |
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 |
Opsional. Gunakan LlmPolicy yang ditentukan pengguna untuk mengonfigurasi pembatasan keamanan. |
DefaultSecuritySettings
| Representasi JSON |
|---|
{ "defaultPromptTemplate": string } |
| Kolom | |
|---|---|
defaultPromptTemplate |
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 ( |
| Kolom | |
|---|---|
maxConversationMessages |
Opsional. Saat memeriksa kebijakan ini, pertimbangkan 'n' pesan terakhir dalam percakapan. Jika tidak ditetapkan, nilai default 10 akan digunakan. |
modelSettings |
Opsional. Setelan model. |
prompt |
Wajib. Perintah kebijakan. |
policyScope |
Wajib. Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan. Jika disetel ke |
failOpen |
Opsional. Jika terjadi error selama pemeriksaan kebijakan, buka dan jangan memicu pembatasan. |
allowShortUtterance |
Opsional. Secara default, pemeriksaan kebijakan LLM dilewati untuk ucapan singkat. Mengaktifkan setelan ini akan menerapkan pemeriksaan kebijakan ke semua ucapan, termasuk yang biasanya akan dilewati. |
ModelSafety
| Representasi JSON |
|---|
{
"safetySettings": [
{
object ( |
| Kolom | |
|---|---|
safetySettings[] |
Wajib. Daftar setelan keamanan. |
SafetySetting
| Representasi JSON |
|---|
{ "category": enum ( |
| Kolom | |
|---|---|
category |
Wajib. Kategori bahaya. |
threshold |
Wajib. Ambang batas pemblokiran bahaya. |
CodeCallback
| Representasi JSON |
|---|
{ "beforeAgentCallback": { object ( |
| Kolom | |
|---|---|
beforeAgentCallback |
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 |
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 |
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 |
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 |
| Kolom | |
|---|---|
Kolom union action. Tindakan yang harus dilakukan. action hanya ada berupa salah satu diantara berikut: |
|
respondImmediately |
Opsional. Segera merespons dengan respons yang telah dikonfigurasi sebelumnya. |
transferAgent |
Opsional. Mentransfer percakapan ke agen lain. |
generativeAnswer |
Opsional. Memberikan respons dengan jawaban generatif. |
RespondImmediately
| Representasi JSON |
|---|
{
"responses": [
{
object ( |
| Kolom | |
|---|---|
responses[] |
Wajib. Template pesan yang dapat dipilih agen. Respons dipilih secara acak. |
Respons
| Representasi JSON |
|---|
{ "text": string, "disabled": boolean } |
| Kolom | |
|---|---|
text |
Wajib. Teks yang akan digunakan agen untuk merespons. |
disabled |
Opsional. Apakah respons dinonaktifkan. Respons yang dinonaktifkan tidak digunakan oleh agen. |
TransferAgent
| Representasi JSON |
|---|
{ "agent": string } |
| Kolom | |
|---|---|
agent |
Wajib. Nama agen yang akan menerima transfer percakapan. Agen harus berada di aplikasi yang sama dengan agen saat ini. Format: |
GenerativeAnswer
| Representasi JSON |
|---|
{ "prompt": string } |
| Kolom | |
|---|---|
prompt |
Wajib. Perintah yang akan digunakan untuk jawaban generatif. |
Toolset
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "description": string, "createTime": string, "updateTime": string, "etag": string, "executionType": enum ( |
| Kolom | |
|---|---|
name |
ID. ID unik toolset. Format: |
displayName |
Opsional. Nama tampilan toolset. Harus unik dalam aplikasi yang sama. |
description |
Opsional. Deskripsi toolset. |
createTime |
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: |
updateTime |
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: |
etag |
ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak. |
executionType |
Opsional. Jenis eksekusi alat dalam toolset. |
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 |
Opsional. Toolset yang berisi daftar alat yang ditawarkan oleh server MCP. |
openApiToolset |
Opsional. Kumpulan alat yang berisi daftar alat yang ditentukan oleh skema OpenAPI. |
connectorToolset |
Opsional. Kumpulan alat yang membuat alat dari Koneksi Integration Connectors. |
McpToolset
| Representasi JSON |
|---|
{ "serverAddress": string, "apiAuthentication": { object ( |
| Kolom | |
|---|---|
serverAddress |
Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transport HTTP yang dapat di-streaming yang didukung. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya. |
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 |
Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien. |
OpenApiToolset
| Representasi JSON |
|---|
{ "openApiSchema": string, "apiAuthentication": { object ( |
| Kolom | |
|---|---|
openApiSchema |
Wajib. Skema OpenAPI toolset. |
apiAuthentication |
Opsional. Informasi autentikasi yang diperlukan oleh API. |
tlsConfig |
Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom |
serviceDirectoryConfig |
Opsional. Konfigurasi Direktori Layanan. |
ignoreUnknownFields |
Opsional. Jika benar (true), agen akan mengabaikan kolom yang tidak diketahui dalam respons API untuk semua operasi yang ditentukan dalam skema OpenAPI. |
url |
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 ( |
| Kolom | |
|---|---|
connection |
Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: |
authConfig |
Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan Toolset akan gagal. Lihat: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connectorActions[] |
Wajib. Daftar tindakan konektor/operasi entitas untuk membuat alat. |
Anotasi Alat
Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ✅ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌