MCP Tools Reference: ces.googleapis.com

Alat: get_app_version

Mendapatkan detail versi aplikasi yang ditentukan.

Contoh kode berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP get_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": "get_app_version",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Skema Input

Pesan permintaan untuk AgentService.GetAppVersion.

GetAppVersionRequest

Representasi JSON
{
  "name": string
}
Kolom
name

string

Wajib. Nama resource versi aplikasi yang akan diambil.

Skema Output

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

AppVersion

Representasi JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "updateTime": 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".

updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat versi 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".

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, update 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 nano 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 guardrail di 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 di 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. Setelan penanganan error aplikasi.

modelSettings

object (ModelSettings)

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

toolExecutionMode

enum (ToolExecutionMode)

Opsional. Mode eksekusi alat untuk aplikasi. Jika tidak diberikan, akan ditetapkan secara default ke PARALLEL.

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

Opsional. Batas evaluasi untuk aplikasi.

variableDeclarations[]

object (VariableDeclaration)

Opsional. Deklarasi variabel.

predefinedVariableDeclarations[]

object (VariableDeclaration)

Hanya output. Deklarasi variabel yang telah ditetapkan 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 guardrail 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 aplikasi atau penggunaan yang dimaksudkan.

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

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, update 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, perubahan 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 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 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 resource lengkap alat, yang memicu eksekusi alat tertentu. - Tindakan sistem yang telah ditetapkan, seperti "eskalasi" atau "keluar", yang memicu sinyal EndSession dengan metadata yang sesuai untuk menghentikan 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)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
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", 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 penyelaan pengguna.

inactivityTimeout

string (Duration format)

Opsional. Durasi ketidakaktifan 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, 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.

customVoiceSamples[]

object (CustomVoiceSample)

Opsional. Mengonfigurasi sampel suara kustom untuk kloning suara.

SynthesizeSpeechConfigsEntry

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

string

value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

Opsional. Nama suara. Jika tidak ditetapkan, 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

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.

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 berbicara. Jika 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 lengkap. 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 bertanda 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/jam * 24 jam/hari * 365,25 hari/tahun * 10.000 tahun

nanos

integer

Pecahan detik bertanda tangan pada resolusi nanodetik dari rentang waktu. Durasi kurang dari satu detik direpresentasikan dengan kolom seconds 0 dan kolom nanos positif atau negatif. Untuk durasi satu detik atau lebih, nilai bukan 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. Penguatan volume (dalam dB) dari 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), audio akan diputar pada amplitudo sinyal native normal. Nilai -6,0 (dB) akan diputar pada sekitar setengah amplitudo dari amplitudo sinyal native normal. Nilai +6,0 (dB) akan diputar pada amplitudo sekitar dua kali amplitudo sinyal native normal. Sebaiknya jangan melebihi +10 (dB) karena biasanya tidak ada peningkatan kenyaringan yang efektif 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 mono-channel 16 kHz 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"

CustomVoiceSample

Representasi JSON
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
Kolom
name

string

Opsional. Nama yang ditentukan pengguna untuk sampel suara kustom.

voiceSampleGcsUri

string

Opsional. Cloud Storage URI ke sampel audio untuk kloning suara. Sampel audio harus berupa file WAV mono-channel 24 kHz.

consentAudioGcsUri

string

Opsional. Audio izin untuk kloning suara.

voiceInstruction

string

Opsional. Petunjuk bahasa alami untuk gaya, nada, kecepatan, atau pengucapan suara.

previewAudioContent

string (bytes format)

Hanya output. Audio pratinjau yang disintesis untuk suara kustom, diformat sebagai WAV kanonis (LINEAR16, 24 kHz, 16-bit, mono).

String berenkode base64.

previewText

string

Opsional. Teks untuk menyintesis audio pratinjau untuk suara kustom.

warnings[]

object (Warning)

Hanya output. Pesan peringatan yang muncul selama pemrosesan klon suara (misalnya, level audio rendah).

voiceInstructionMode

enum (VoiceInstructionMode)

Opsional. Mode petunjuk untuk sampel suara. Jika tidak ditentukan, defaultnya adalah NO_INSTRUCTION.

Peringatan

Representasi JSON
{
  "message": string,
  "type": enum (WarningType)
}
Kolom
message

string

Hanya output. Deskripsi peringatan yang dapat dibaca manusia.

type

enum (WarningType)

Hanya output. Jenis peringatan.

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)
  },
  "requiredRecordingConsent": boolean
}
Kolom
redactionConfig

object (RedactionConfig)

Opsional. Konfigurasi untuk cara menyamarkan data sensitif.

audioRecordingConfig

object (AudioRecordingConfig)

Opsional. Konfigurasi untuk cara perekaman interaksi audio. Audio dapat diredaksi seperti yang dikonfigurasi di RedactionConfig.

unredactedAudioRecordingConfig

object (AudioRecordingConfig)

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

bigqueryExportSettings

object (BigQueryExportSettings)

Opsional. Mengonfigurasi perilaku BigQuery Export untuk aplikasi. Data percakapan dapat diredaksi seperti yang dikonfigurasi di RedactionConfig.

unredactedBigqueryExportSettings

object (BigQueryExportSettings)

Opsional. Mengonfigurasi perilaku BigQuery Export untuk aplikasi. Data percakapan yang tidak diredaksi akan diekspor ke Tabel BigQuery jika diaktifkan.

cloudLoggingSettings

object (CloudLoggingSettings)

Opsional. Setelan untuk mendeskripsikan perilaku Cloud Logging untuk aplikasi.

conversationLoggingSettings

object (ConversationLoggingSettings)

Opsional. Setelan untuk mendeskripsikan 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 mendeskripsikan perilaku pengumpulan data percakapan untuk pipeline analisis LLM untuk aplikasi.

requiredRecordingConsent

boolean

Opsional. Apakah aplikasi harus menyatakan apa yang mungkin direkam sebelum ada yang disimpan.

Jika benar (true), sesi akan dimulai dengan perekaman nonaktif dan tetap nonaktif hingga klien mengirimkan SessionInput.recording_control, yang kemudian akan memutuskan setiap giliran mulai saat itu. Hal ini mencakup rekaman audio serta histori percakapan, ekspor BigQuery, dan Cloud Logging.

Jika false, yang merupakan setelan default, setelan di atas akan memutuskan sendiri dan klien tidak perlu mengirim apa pun.

RedactionConfig

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

boolean

Opsional. Jika true, penyuntingan akan diterapkan dalam berbagai skenario logging, termasuk histori percakapan, Cloud Logging, dan rekaman audio.

inspectTemplate

string

Opsional. Nama template pemeriksaan 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 dengan aplikasi, Anda harus memberikan izin storage.objects.create kepada 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 tempat data akan diekspor.

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 data untuk percakapan. Jika tidak ditetapkan, percakapan akan dipertahankan selama 365 hari.

Durasi dalam detik dengan maksimal sembilan digit pecahan, 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, 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), yang 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 akan dilakukan sebelum agen memunculkan 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 mengeskalasi sesi di EndSession. Jika sesi dieskalasi, 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,
  "thinkingLevel": enum (ThinkingLevel),

  // 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 ditetapkan, agen akan mewarisi model dari agen induknya.

thinkingLevel

enum (ThinkingLevel)

Opsional. Tingkat penalaran model.

Kolom union _temperature.

_temperature hanya dapat berupa salah satu dari hal berikut:

temperature

number

Opsional. Jika ditetapkan, suhu ini akan digunakan untuk model LLM. Suhu mengontrol keacakan respons model. Suhu yang lebih rendah menghasilkan respons yang lebih dapat diprediksi. Suhu 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 golden dataset.

hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

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

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

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

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. Nilai minimum 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. Nilai minimum keberhasilan untuk keseluruhan ketepatan pemanggilan alat. Harus berupa float antara 0 dan 1. Default-nya 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. Nilai minimum keberhasilan untuk kebenaran parameter pemanggilan alat individual. Harus berupa float antara 0 dan 1. Default-nya adalah 1.0.

ToolMatchingSettings

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

enum (ExtraToolCallBehavior)

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

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 yang diperlukan dari Type.OBJECT.

description

string

Opsional. Deskripsi data.

items

object (Schema)

Opsional. Skema elemen Type.ARRAY.

nullable

boolean

Opsional. Menunjukkan apakah nilai boleh 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 (atau beberapa) subskema dalam daftar.

enum[]

string

Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 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. Mengizinkan referensi tidak langsung antara node skema. Nilai harus berupa referensi yang valid ke turunan dari root defs.

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

Merepresentasikan null JSON.

numberValue

number

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

stringValue

string

Mewakili string JSON.

boolValue

boolean

Merepresentasikan 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 nilai yang diketik secara dinamis dan tidak diurutkan.

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

channelType

enum (ChannelType)

Opsional. Jenis profil saluran.

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 penyelaan pengguna dalam percakapan. - true: Interupsi pengguna dinonaktifkan saat agen berbicara. - false: Agen mempertahankan kontrol otomatis atas kapan pengguna dapat menyela.

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 origin situs yang memuat widget web dan hanya mengizinkannya dimuat di origin yang sama atau salah satu origin yang diizinkan.

allowedOrigins[]

string

Opsional. Origin yang diizinkan untuk menghosting widget web. Origin ditentukan oleh RFC 6454. Jika kosong, semua origin akan 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 secret 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. Origin HTTP(s) yang diizinkan yang dapat dipanggil langsung oleh alat OpenAPI di Aplikasi saat Kontrol Layanan VPC diaktifkan. String ini harus sama persis dengan origin, termasuk port jika ditentukan. Misalnya, "https://example.com" atau "https://example.com:443". Daftar ini belum berlaku untuk alat Python yang mungkin melakukan panggilan HTTP langsung.

DashboardSettings

Representasi JSON
{
  "defaultDashboard": string
}
Kolom
defaultDashboard

string

Opsional. Nama resource dasbor Contact Center Insights default yang terkait dengan aplikasi. Ini adalah dasbor yang akan ditampilkan saat pengguna membuka tampilan Monitoring 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)
  },
  "remoteA2aAgent": {
    object (RemoteA2aAgent)
  }
  // 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 hierarki agen. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

beforeAgentCallbacks[]

object (Callback)

Opsional. Callback yang akan dijalankan sebelum agen dipanggil. Callback yang disediakan dijalankan secara berurutan sesuai urutan 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 dijalankan secara berurutan sesuai urutan 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 dijalankan sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dijalankan beberapa kali. Callback yang disediakan dijalankan secara berurutan sesuai urutan 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 dijalankan setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dijalankan beberapa kali. Callback yang disediakan dijalankan secara berurutan sesuai urutan 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 dijalankan sebelum alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dijalankan beberapa kali. Callback yang disediakan dijalankan secara berurutan sesuai urutan 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 dijalankan beberapa kali. Callback yang disediakan dijalankan secara berurutan sesuai urutan 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 guardrail 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, update 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 tersebut.

transferRules[]

object (TransferRule)

Opsional. Aturan transfer agen. Jika beberapa aturan cocok, aturan pertama dalam daftar akan digunakan.

validationErrors[]

string

Hanya output. Kesalahan konfigurasi atau error pada 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 ditetapkan, semua properti tingkat agen lainnya akan diabaikan.

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

remoteA2aAgent

object (RemoteA2aAgent)

Opsional. Agen A2A jarak jauh yang akan digunakan untuk eksekusi agen.

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 dari 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 interupsi tingkat pesan yang dikonfigurasi di agen Dialogflow.

  • Jika salah: semua pesan respons dari agen Dialogflow mengikuti setelan penyelaan tingkat aplikasi.
  • Jika true: hanya pesan respons dengan allow_playback_interruption yang ditetapkan ke 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

RemoteA2aAgent

Representasi JSON
{
  "a2aConfig": {
    object (RemoteA2aConfig)
  }
}
Kolom
a2aConfig

object (RemoteA2aConfig)

Wajib. Konfigurasi koneksi A2A.

RemoteA2aConfig

Representasi JSON
{
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "streamingEnabled": boolean,
  "contextId": string,

  // Union field agent_spec can be only one of the following:
  "agentCard": {
    object (AgentCard)
  },
  "agentRegistry": string
  // End of list of possible types for union field agent_spec.
}
Kolom
apiAuthentication

object (ApiAuthentication)

Opsional. Konfigurasi autentikasi untuk memanggil agen jarak jauh. Opsional jika referensi registry sudah menangani autentikasi.

inputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama variabel input agen jarak jauh ke nama variabel GECX.

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

outputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama variabel output agen jarak jauh ke nama variabel GECX.

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

streamingEnabled

boolean

Opsional. Apakah streaming diaktifkan untuk remote agent.

contextId

string

Opsional. Jika tidak kosong, interaksi dengan agen A2A jarak jauh akan menggunakan ID konteks ini. Kolom context_id ini dapat merujuk ke variabel sesi seperti $context.variables.order_agent_session_id.

Kolom union agent_spec. Spesifikasi remote agent. agent_spec hanya ada berupa salah satu diantara berikut:
agentCard

object (AgentCard)

Opsional. Kartu agen lengkap yang ditentukan secara inline.

agentRegistry

string

Opsional. Referensi ke agen di Agent Registry. Format: projects/{project}/locations/{location}/agents/{agent}

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 yang 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 dan sangat mungkin berhasil dilakukan oleh 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 bentuk terbuka, yang dapat dengan mudah diperluas untuk binding protokol lainnya. 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 protokol A2A yang diekspos 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 keterampilan agen.

name

string

Wajib. Nama yang dapat dibaca manusia untuk keahlian.

description

string

Wajib. Deskripsi mendetail tentang keterampilan.

tags[]

string

Wajib. Serangkaian kata kunci yang menjelaskan kemampuan keahlian.

examples[]

string

Contoh perintah atau skenario yang dapat ditangani oleh keterampilan ini.

inputModes[]

string

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

outputModes[]

string

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

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

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. Client ID dari penyedia OAuth.

clientSecretVersion

string

Wajib. Nama resource versi rahasia 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 yang akan 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>.

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. Callback 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 dijalankan setelah menerima semua respons model. Mengaktifkan eksekusi proaktif dapat berdampak 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 yang menjadi target penerapan aturan. 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 mentransfer 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)
  },
  "readOnly": boolean,

  // 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 direferensikan secara langsung di tempat yang memerlukan alat.

displayName

string

Hanya output. Nama tampilan alat, yang diperoleh berdasarkan 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, 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, update akan menimpa perubahan serentak.

generatedSummary

string

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

toolFakeConfig

object (ToolFakeConfig)

Opsional. Konfigurasi untuk perilaku alat dalam mode palsu.

readOnly

boolean

Hanya output. Menunjukkan apakah alat bersifat hanya baca. Jika benar (true), alat tidak dapat diubah oleh pengguna.

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 Google Penelusuran.

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 remote agent.

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. Menyertakan sertifikat server kustom yang akan dipercaya klien.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan.

ignoreUnknownFields

boolean

Opsional. Jika 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.

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. Hal 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 mengganti trust store SSL default. Jika kosong atau tidak ditentukan, CES akan menggunakan trust store 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 Direktori Layanan. 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 grounding. 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". Anda hanya dapat menentukan maksimum 20 domain.

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 ditetapkan, perintah default akan digunakan.

voicePrompt

string

Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan suara. Jika tidak ditetapkan, 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 dari Koneksi Integration Connectors yang direferensikan. 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 untuk 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.

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 entity yang akan digunakan sebagai input untuk operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entity akan digunakan.

outputFields[]

string

Opsional. Kolom entity 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 entity 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 Engine. search_source hanya ada berupa salah satu diantara berikut:
dataStoreSource

object (DataStoreSource)

Opsional. Menelusuri dalam satu DataStore tertentu.

engineSource

object (EngineSource)

Opsional. Menelusuri dalam Engine (berpotensi di beberapa Penyimpanan Data).

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 resource lengkap 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 resource lengkap Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

dataStoreSources[]

object (DataStoreSource)

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

filter

string

Opsional. Filter yang diterapkan ke penelusuran di seluruh Mesin. Tidak relevan dan tidak digunakan jika 'data_store_sources' disediakan. 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 penguatan diterapkan. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.

spec[]

object (BoostSpec)

Wajib. Daftar spesifikasi penguatan.

BoostSpec

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

object (ConditionBoostSpec)

Wajib. Daftar spesifikasi penguatan.

ConditionBoostSpec

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

string

Wajib. Ekspresi yang menentukan kondisi penguatan. 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 en atau fr: (lang_code: ANY("en", "fr"))

boost

number

Opsional. Kekuatan penguatan, yang harus berada dalam [-1, 1]. Penguatan negatif berarti penurunan peringkat. Nilai defaultnya adalah 0,0.

Menetapkan ke 1,0 akan memberikan promosi besar pada saran. Namun, hal ini tidak berarti bahwa hasil teratas akan menjadi saran yang ditingkatkan.

Menyetel ke -1,0 akan memberikan penurunan peringkat yang besar pada saran. Namun, saran lain yang relevan mungkin masih ditampilkan.

Jika disetel ke 0,0, berarti tidak ada penguatan yang diterapkan. Kondisi penguatan 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 penguatan.

attributeType

enum (AttributeType)

Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah penguatan. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Dalam kasus numerik, hal ini mudah, yaitu attribute_value = numerical_field_value. Namun, dalam hal 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 monoton (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 dayTimeDuration XSD (subset terbatas dari nilai durasi ISO 8601). Polanya adalah: [nD][T[nH][nM][nS]].

boostAmount

number

Opsional. Nilai antara -1 hingga 1 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 rewriter.

summarizationConfig

object (SummarizationConfig)

Opsional. Konfigurasi ringkasan.

groundingConfig

object (GroundingConfig)

Opsional. Konfigurasi grounding.

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 ditetapkan, perintah default akan digunakan.

disabled

boolean

Opsional. Apakah penulisan 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 ditetapkan, perintah default akan digunakan.

disabled

boolean

Opsional. Apakah ringkasan dinonaktifkan.

GroundingConfig

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

number

Opsional. Nilai minimum keakuratan jawaban berdasarkan sumber yang diambil. Nilai ini memiliki rentang yang dapat dikonfigurasi, yaitu [1, 5]. Level ini digunakan untuk menetapkan nilai minimum keterbanyakan rujukan jawaban, yang berarti semua respons dengan skor keterbanyakan rujukan di bawah nilai minimum akan kembali menampilkan cuplikan yang relevan saja.

Misalnya, level 3 berarti skor keakuratan harus 3 atau lebih tinggi agar respons ditampilkan.

disabled

boolean

Opsional. Apakah grounding 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, semua cuplikan dari layanan akan ditampilkan secara default.

PythonFunction

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

string

Opsional. Nama fungsi Python yang akan dieksekusi. 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, yang diuraikan dari docstring kode Python.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan untuk alat ini.

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. 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 dibuat dengan MCP SDK, URL harus diakhiri dengan "/mcp/". Hanya server berbasis transport Streamable HTTP 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

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan untuk menjalankan alat di server MCP. Untuk autentikasi token pemilik, token hanya berlaku untuk eksekusi alat, bukan untuk mencantumkan alat. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi.

tlsConfig

object (TlsConfig)

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

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan untuk VPC-SC, yang digunakan untuk me-resolve 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 merupakan 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 menjadi 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 membuat 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)
  },
  "statefulAgent": boolean,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  }
}
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.

statefulAgent

boolean

Opsional. Jika diaktifkan, interaksi antara aplikasi CXAS dan agen jarak jauh akan memiliki konteks yang sama. Jika agen jarak jauh menampilkan context_id, ID tersebut akan dipertahankan selama keseluruhan sesi untuk alat agen jarak jauh ini.

inputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama variabel input agen jarak jauh ke nama variabel GECX.

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

outputVariableMapping

map (key: string, value: string)

Opsional. Pemetaan nama variabel output agen jarak jauh ke nama variabel GECX.

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

InputVariableMappingEntry

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

string

value

string

OutputVariableMappingEntry

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

string

value

string

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. Responsnya 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 palsu alat. Signature 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 (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 mewakili 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 ini dapat menjadi tidak valid jika resource yang direferensikan 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, update 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 potongan.

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

Bagian

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. Membagi data menjadi beberapa bagian. 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 mewakili variabel yang diperbarui dalam percakapan, yang diberi kunci berdasarkan nama variabel.

defaultVariables

object (Struct format)

Struct mewakili variabel default di awal percakapan, yang diberi kunci 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,
  "altText": 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.

altText

string

Opsional. Teks alternatif untuk gambar.

ToolCall

Representasi JSON
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": 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 di bawah panggilan yang memulainya, bukan merender setiap langkah sebagai sibling.

agentName

string

Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Contract Architect". Kosong saat agen root mengeluarkannya.

targetApp

string

Hanya output. Aplikasi yang ditargetkan oleh panggilan ini, yang diperoleh asisten dari argumen resource panggilan: nama resource aplikasi, PROJECT untuk alat yang tercakup dalam lokasi, atau kosong untuk alat lokal sesi. Hanya ditetapkan dalam sesi asisten yang tercakup dalam project.

Kolom union tool_identifier. ID alat yang akan dieksekusi. Alat ini dapat berupa alat yang dipertahankan atau alat dari toolset. 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 dijalankan.

ToolsetTool

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

string

Wajib. Nama resource Toolset yang menjadi asal alat ini. 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,
  "targetApp": 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 kecocokan 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 di bawah panggilan yang memulainya, bukan merender setiap langkah sebagai sibling.

agentName

string

Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Contract Architect". Kosong saat agen root mengeluarkannya.

targetApp

string

Hanya output. Aplikasi yang ditargetkan oleh alat yang dieksekusi; mencerminkan ToolCall.target_app.

Kolom union tool_identifier. ID alat yang dieksekusi. Alat ini dapat berupa alat yang dipertahankan atau alat dari toolset. 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 dijalankan.

AgentTransfer

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

string

Wajib. Agen yang akan menerima transfer percakapan. Agen akan menangani percakapan mulai dari titik ini. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayName

string

Hanya output. Nama tampilan agen.

Guardrail

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)
  },
  "supervisor": {
    object (Supervisor)
  }
  // End of list of possible types for union field guardrail_type.
}
Kolom
name

string

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

displayName

string

Wajib. Nama tampilan guardrail.

description

string

Opsional. Deskripsi guardrail.

enabled

boolean

Opsional. Apakah guardrail diaktifkan.

action

object (TriggerAction)

Opsional. Tindakan yang harus dilakukan saat guardrail dipicu.

createTime

string (Timestamp format)

Hanya output. Stempel waktu saat guardrail 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 guardrail 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, update akan menimpa perubahan serentak.

Kolom union guardrail_type. Jenis guardrail. guardrail_type hanya ada berupa salah satu diantara berikut:
contentFilter

object (ContentFilter)

Opsional. Guardrail yang melarang penggunaan konten tertentu dalam percakapan.

llmPromptSecurity

object (LlmPromptSecurity)

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

llmPolicy

object (LlmPolicy)

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

modelSafety

object (ModelSafety)

Opsional. Guardrail yang memblokir percakapan jika respons LLM dianggap tidak aman berdasarkan setelan keamanan model.

codeCallback

object (CodeCallback)

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

supervisor

object (Supervisor)

Opsional. Pedoman yang menjalankan intervensi supervisor.

ContentFilter

Representasi JSON
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean,
  "sensitiveWordsExemptions": [
    string
  ]
}
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 true, diakritik akan diabaikan selama pencocokan.

sensitiveWordsExemptions[]

string

Opsional. Entri daftar kata sensitif yang diizinkan oleh guardrail ini. Hanya valid jika match_type adalah SENSITIVE_WORDS. Setiap nilai harus sama dengan entri daftar (tidak peka huruf besar/kecil, spasi kosong di sekitarnya diabaikan); nilai lainnya tidak berpengaruh. Hanya berlaku untuk guardrail ini. Maksimum 1.000 entri dengan panjang masing-masing hingga 256 karakter.

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 guardrail mengalami error LLM. - Jika true: guardrail akan diabaikan. - Jika salah (default): guardrail akan dipicu/diblokir.

Catatan: Jika kebijakan kustom disediakan, 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 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 guardrail keamanan.

DefaultSecuritySettings

Representasi JSON
{
  "defaultPromptTemplate": string
}
Kolom
defaultPromptTemplate

string

Hanya output. Template perintah default yang digunakan oleh sistem. Kolom ini ditujukan untuk tujuan tampilan guna menunjukkan kepada pengguna perintah yang digunakan sistem secara default. Nilainya 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. Mendukung placeholder variabel sesi ({var}) serta {agent_system_instruction} untuk memasukkan petunjuk sistem yang telah di-resolve agen.

policyScope

enum (PolicyScope)

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

failOpen

boolean

Opsional. Jika terjadi error selama pemeriksaan kebijakan, fail open dan jangan picu guardrail.

allowShortUtterance

boolean

Opsional. Secara default, pemeriksaan kebijakan LLM dilewati untuk ucapan singkat. Jika setelan ini diaktifkan, pemeriksaan kebijakan akan diterapkan ke semua ucapan, termasuk ucapan 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. Batas blokir bahaya.

CodeCallback

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

object (Callback)

Opsional. Callback yang akan dijalankan 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 dijalankan sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dijalankan 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 dijalankan 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.

Supervisor

Representasi JSON
{
  "type": enum (Type),
  "detectionMode": enum (DetectionMode)
}
Kolom
type

enum (Type)

Opsional. Jenis supervisor.

detectionMode

enum (DetectionMode)

Opsional. Mode deteksi supervisor.

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 diambil. 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. Merespons 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, diakhiri dengan 's'. Contoh: "3.5s".

createTime

string (Timestamp format)

Hanya output. Stempel waktu saat set 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 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 read-modify-write. Jika etag kosong, update 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. Toolset yang menghasilkan 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 dibuat dengan MCP SDK, URL harus diakhiri dengan "/mcp/". Hanya server berbasis transport Streamable HTTP 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 di server MCP. Untuk autentikasi token pemilik, token hanya berlaku untuk eksekusi alat, bukan untuk mencantumkan alat. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Opsional. Konfigurasi Direktori Layanan untuk VPC-SC, yang digunakan untuk me-resolve nama layanan dalam perimeter.

tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Menyertakan 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 penyematan 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 seperti yang ditampilkan oleh server MCP.

nameOverride

string

Opsional. Jika ada, alat ini akan menggunakan nama ini di Agen, bukan nama aslinya. Ini terutama digunakan sebagai alias jika server MCP menawarkan alat dengan nama yang buruk.

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 pengganti 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. Hal 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 dari toolset.

apiAuthentication

object (ApiAuthentication)

Opsional. Informasi autentikasi yang diperlukan oleh API.

tlsConfig

object (TlsConfig)

Opsional. Konfigurasi TLS. Menyertakan 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 dalam toolset di 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 dari Koneksi Integration Connectors yang direferensikan. 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 untuk 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 entity yang akan dibuatkan alatnya.

PrebuiltAmbientNoise

Suara bising di sekitar bawaan.

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

WarningType

Jenis peringatan yang muncul selama pemrosesan sampel suara.

Enum
WARNING_TYPE_UNSPECIFIED Jenis peringatan yang tidak ditentukan.
LOW_AUDIO_LEVEL Tingkat audio sampel suara terlalu rendah (misalnya, amplitudo RMS rendah).

VoiceInstructionMode

Mode petunjuk untuk sampel suara.

Enum
VOICE_INSTRUCTION_MODE_UNSPECIFIED Mode petunjuk tidak ditentukan. Defaultnya adalah NO_INSTRUCTION.
NO_INSTRUCTION Tidak ada petunjuk suara yang akan digunakan.
GENERATE_INSTRUCTION Petunjuk suara akan otomatis dibuat oleh AI dari sampel audio.
CUSTOM_INSTRUCTION Petunjuk suara kustom yang diberikan oleh pengguna.

ErrorHandlingStrategy

Menentukan strategi untuk menangani error.

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

ThinkingLevel

Konfigurasi tingkat penalaran untuk model.

Enum
THINKING_LEVEL_UNSPECIFIED Tingkat penalaran tidak ditentukan.
DEFAULT Tingkat penalaran default.
LOW Tingkat penalaran rendah.
MEDIUM Tingkat penalaran sedang.
HIGH Tingkat penalaran tinggi.

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. Default-nya adalah PARALLEL.
PARALLEL Jika ada beberapa alat yang dipilih, alat tersebut akan dijalankan secara paralel, dengan ToolContext yang sama.
SEQUENTIAL Jika ada beberapa alat yang dipilih, alat tersebut akan dijalankan secara berurutan. Alat berikutnya hanya akan dijalankan 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. Default-nya adalah TEXT.
TEXT Gunakan kesamaan 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 ideal.

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

HallucinationMetricBehavior

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

Enum
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED Perilaku metrik halusinasi yang tidak ditentukan.
DISABLED Menonaktifkan 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 nomor.
BOOLEAN Jenis boolean.
OBJECT Jenis objek.
ARRAY Jenis array.

NullValue

Merepresentasikan null JSON.

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

Kolom jenis NullValue dengan nilai selain 0 dianggap tidak valid. Sebagian besar serializer ProtoJSON akan memunculkan Value dengan null_value yang ditetapkan sebagai null JSON, terlepas dari nilai bilangan bulatnya, sehingga 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 saluran.

Enum
UNKNOWN Jenis saluran tidak diketahui.
WEB_UI Saluran UI Web.
API Saluran API.
TWILIO Saluran Twilio.
GOOGLE_TELEPHONY_PLATFORM Saluran 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 Saluran Five9.
CONTACT_CENTER_INTEGRATION Saluran integrasi pusat kontak pihak ketiga.
WHATSAPP Saluran WhatsApp.
INSTAGRAM Instagram.

Persona

Persona channel.

Enum
UNKNOWN Persona UNKNOWN.
CONCISE Agen memberikan respons yang ringkas dan langsung pada 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.

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

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.

OperationType

Operasi yang akan dilakukan pada entity.

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

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 ke peringkat kustom.

Enum
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType tidak ditentukan.
NUMERICAL Nilai kolom numerik akan digunakan untuk memperbarui jumlah penguatan secara dinamis. Dalam hal ini, attribute_value (nilai x) dari 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 dayTimeDuration XSD (subset terbatas dari nilai durasi ISO 8601). Polanya adalah: [nD][T[nH][nM][nS]]. Misalnya, 5D, 3DT12H30M, T24H.

InterpolationType

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

Enum
INTERPOLATION_TYPE_UNSPECIFIED Jenis interpolasi tidak ditentukan. Dalam hal ini, setelan 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 datastore konektor. Untuk jenis datastore lainnya, parameter input filter dihilangkan.
ALWAYS_INCLUDE Selalu sertakan parameter filter untuk semua jenis datastore.
NEVER_INCLUDE Parameter filter tidak pernah disertakan dalam daftar parameter alat, apa pun jenis datastore-nya.

Negara bagian/Provinsi

Menunjukkan 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 ini ada di server, tetapi tidak cocok dengan versi di server.

CorpusType

Jenis korpus Vertex RAG.

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 formulir singkat.
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 respons teks dihasilkan.

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 diperlukan untuk menghasilkan respons teks.
STATIC Respons teks statis yang telah ditentukan sebelumnya selalu digunakan.

ExecutionType

Jenis eksekusi alat atau toolset.

Enum
EXECUTION_TYPE_UNSPECIFIED Jenis eksekusi tidak ditentukan. Setelan defaultnya adalah SYNCHRONOUS jika tidak ditentukan.
SYNCHRONOUS Alat ini dijalankan secara sinkron. Sesi akan diblokir hingga alat merespons.
ASYNCHRONOUS Alat ini dijalankan 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 dikelilingi oleh pembatas kata. Frasa yang dilarang juga dapat berisi pembatas kata.
REGEXP_MATCH Konten dicocokkan menggunakan sintaksis ekspresi reguler.
SENSITIVE_WORDS Konten dicocokkan dengan daftar kata dan frasa sensitif yang dikelola sistem. Memasang guardrail dengan jenis pencocokan ini ke aplikasi atau agen akan menggantikan filter kata sensitif default untuk agen yang terpengaruh; nonaktifkan guardrail untuk memilih tidak menggunakan filter default.

PolicyScope

Menentukan kapan harus menerapkan pemeriksaan kebijakan selama percakapan.

Enum
POLICY_SCOPE_UNSPECIFIED Cakupan kebijakan tidak ditentukan.
USER_QUERY Pemeriksaan kebijakan dipicu pada 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 bahayanya adalah ujaran kebencian.
HARM_CATEGORY_DANGEROUS_CONTENT Kategori bahayanya adalah konten berbahaya.
HARM_CATEGORY_HARASSMENT Kategori bahayanya 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 yang tidak ditentukan.
BLOCK_LOW_AND_ABOVE Blokir nilai minimum rendah dan yang lebih tinggi (yaitu, blokir lebih banyak).
BLOCK_MEDIUM_AND_ABOVE Blokir nilai minimum sedang dan yang lebih tinggi.
BLOCK_ONLY_HIGH Blokir hanya nilai minimum tinggi (yaitu, blokir lebih sedikit).
BLOCK_NONE Jangan blokir.
OFF Nonaktifkan filter keamanan.

Jenis

Jenis pengawas.

Enum
TYPE_UNSPECIFIED Jenis tidak ditentukan.
INVALID_TEXT Jenis masalah teks tidak valid.
LANGUAGE_SHIFT Jenis masalah peralihan bahasa.
SPEAKER_SHIFT Jenis masalah pergantian speaker.
AUDIO_MISMATCH Jenis masalah ketidakcocokan audio.
MISSING_TOOL_CALL Jenis masalah panggilan alat tidak ada.
CUSTOM Jenis masalah kustom.
CHOPPY_AUDIO Jenis masalah audio terputus-putus.
PROFANITY Jenis masalah kata-kata tidak sopan agen.

DetectionMode

Mode deteksi supervisor.

Enum
DETECTION_MODE_UNSPECIFIED Mode deteksi tidak ditentukan. Defaultnya adalah NON_BLOCKING.
NON_BLOCKING Mode deteksi tanpa pemblokiran. Respons tidak diblokir saat deteksi pengawas sedang berlangsung.
BLOCKING Mode deteksi pemblokiran. Respons diblokir saat deteksi pengawas sedang berlangsung.

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 tersebut dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim kepada pengguna.

Bersama dengan string judul, petunjuk boolean berikut ditentukan sebagai berikut:

  • readOnlyHint: Jika benar, alat tidak akan mengubah lingkungannya. Default: false.
  • destructiveHint: Jika benar, alat dapat melakukan tindakan destruktif. Jika salah, alat hanya dapat melakukan tindakan aditif. Default: true.
  • idempotentHint: Jika benar, memanggil alat berulang kali dengan argumen yang sama tidak akan memberikan efek tambahan pada lingkungannya. Default: false.
  • openWorldHint: Jika benar, alat dapat berinteraksi dengan 'open world' entitas eksternal. Jika salah, alat hanya dapat berinteraksi dengan entity internal. Misalnya, alat penelusuran web akan bersifat open world, sedangkan alat memori tidak akan bersifat open world.

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌