Package google.cloud.ces.v1beta

Hanya output. Latensi rata-rata panggilan alat.

ToolMetrics

Metrik untuk satu alat.

Kolom

tool

string

Hanya output. Nama alat.

pass_count

int32

Hanya output. Jumlah percobaan alat yang berhasil.

fail_count

int32

Hanya output. Frekuensi alat gagal.

TurnLatencyMetrics

Metrik untuk latensi giliran.

Kolom

average_latency

ApiKeyConfig.RequestLocation

Hanya output. Latensi rata-rata giliran.

AmbientSoundConfig

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

Kolom
`volume_gain_db`	`double` Opsional. Peningkatan volume (dalam dB) volume native normal yang didukung oleh suara bising di sekitar, dalam rentang [-96,0, 16,0]. Jika tidak disetel, atau disetel ke nilai 0,0 (dB), akan diputar pada amplitudo sinyal native normal. Nilai -6,0 (dB) akan diputar dengan sekitar setengah amplitudo sinyal native normal. Nilai +6,0 (dB) akan diputar dengan amplitudo sinyal native normal yang kira-kira dua kali lipat. Sebaiknya jangan melebihi +10 (dB) karena biasanya tidak ada peningkatan efektif dalam kerasnya suara 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:
`prebuilt_ambient_noise (deprecated)`	`AmbientSoundConfig.PrebuiltAmbientNoise` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: `prebuilt_ambient_noise` tidak digunakan lagi dan digantikan dengan `prebuilt_ambient_sound`.
`gcs_uri`	`string` Opsional. Suara bising di sekitar sebagai file WAV 16 kHz satu saluran yang disimpan di Cloud Storage. Catatan: Pastikan agen layanan CES `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com` memiliki izin `storage.objects.get` ke objek Cloud Storage.
`prebuilt_ambient_sound`	`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"

PrebuiltAmbientNoise

Suara bising di sekitar bawaan.

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

ApiAuthentication

Informasi autentikasi diperlukan untuk panggilan API.

Kolom
Kolom union `auth_config`. Konfigurasi autentikasi. `auth_config` hanya ada berupa salah satu diantara berikut:
`api_key_config`	`ApiKeyConfig` Opsional. Konfigurasi untuk autentikasi kunci API.
`oauth_config`	`OAuthConfig` Opsional. Konfigurasi untuk OAuth.
`service_agent_id_token_auth_config`	`ServiceAgentIdTokenAuthConfig` Opsional. Konfigurasi untuk autentikasi token ID yang dibuat dari agen layanan CES.
`service_account_auth_config`	`ServiceAccountAuthConfig` Opsional. Konfigurasi untuk autentikasi akun layanan.
`bearer_token_config`	`BearerTokenConfig` Opsional. Konfigurasi untuk autentikasi token pembawa.

ApiKeyConfig

Konfigurasi untuk autentikasi dengan kunci API.

Kolom

key_name

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.

api_key_secret_version

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.

request_location

Wajib. Lokasi kunci dalam permintaan.

RequestLocation

Lokasi kunci API dalam permintaan.

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

Aplikasi

Aplikasi berfungsi sebagai penampung tingkat teratas untuk sekelompok agen, termasuk agen root dan sub-agennya, beserta konfigurasi terkaitnya. Agen ini bekerja sama untuk mencapai sasaran tertentu dalam konteks aplikasi.

Kolom
`name`	`string` ID. ID unik aplikasi. Format: `projects/{project}/locations/{location}/apps/{app}`
`display_name`	`string` Wajib. Nama tampilan aplikasi.
`description`	`string` Opsional. Deskripsi aplikasi yang dapat dibaca manusia.
`pinned`	`bool` Opsional. Apakah aplikasi disematkan dalam daftar aplikasi.
`root_agent`	`string` Opsional. Agen root adalah titik entri aplikasi. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`language_settings`	`LanguageSettings` Opsional. Setelan bahasa aplikasi.
`time_zone_settings`	`TimeZoneSettings` Opsional. Setelan TimeZone aplikasi.
`audio_processing_config`	`AudioProcessingConfig` Opsional. Konfigurasi pemrosesan audio aplikasi.
`logging_settings`	`LoggingSettings` Opsional. Setelan pencatatan log aplikasi.
`error_handling_settings`	`ErrorHandlingSettings` Opsional. Menangani error setelan aplikasi.
`model_settings`	`ModelSettings` Opsional. Setelan model LLM default untuk aplikasi. Setiap resource (misalnya, agen, pembatas) dapat mengganti konfigurasi ini sesuai kebutuhan.
`tool_execution_mode`	`App.ToolExecutionMode` Opsional. Mode eksekusi alat untuk aplikasi. Jika tidak diberikan, defaultnya adalah PARALLEL.
`evaluation_metrics_thresholds`	`EvaluationMetricsThresholds` Opsional. Batas evaluasi untuk aplikasi.
`variable_declarations[]`	`App.VariableDeclaration` Opsional. Deklarasi variabel.
`predefined_variable_declarations[]`	`App.VariableDeclaration` Hanya output. Deklarasi variabel yang telah ditentukan sebelumnya untuk aplikasi.
`global_instruction`	`string` Opsional. Petunjuk untuk semua agen di aplikasi. Anda dapat menggunakan petunjuk ini untuk menyiapkan identitas atau kepribadian yang stabil di semua agen.
`guardrails[]`	`string` Opsional. Daftar pembatasan untuk aplikasi. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
`data_store_settings`	`DataStoreSettings` Opsional. Setelan penyimpanan data untuk aplikasi.
`default_channel_profile`	`ChannelProfile` Opsional. Profil saluran default yang digunakan oleh aplikasi.
`metadata`	`map<string, string>` Opsional. Metadata tentang aplikasi. Kolom ini dapat digunakan untuk menyimpan informasi tambahan yang relevan dengan detail atau penggunaan yang dimaksudkan dari aplikasi.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat aplikasi dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat aplikasi terakhir diperbarui.
`etag`	`string` Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
`deployment_count`	`int32` Hanya output. Jumlah deployment di aplikasi.
`client_certificate_settings`	`ClientCertificateSettings` Opsional. Setelan sertifikat klien default untuk aplikasi.
`vpc_sc_settings`	`VpcScSettings` Opsional. Setelan VPC-SC untuk aplikasi.
`locked`	`bool` Opsional. Menunjukkan apakah aplikasi dikunci untuk perubahan. Jika aplikasi dikunci, modifikasi pada resource aplikasi akan ditolak.
`evaluation_personas[]`	`EvaluationPersona` Opsional. Persona evaluasi untuk aplikasi. Kolom ini digunakan untuk menentukan persona yang dapat digunakan untuk evaluasi. Maksimum 30 persona dapat ditentukan.
`evaluation_settings`	`EvaluationSettings` Opsional. Setelan evaluasi untuk aplikasi.
`validation_errors[]`	`string` Hanya output. Kesalahan konfigurasi atau peringatan di aplikasi.
`dashboard_settings`	`DashboardSettings` Opsional. Setelan dasbor khusus aplikasi untuk menautkan dan mengonfigurasi dasbor Contact Center Insights.

ToolExecutionMode

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

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

VariableDeclaration

Menentukan struktur dan metadata untuk variabel.

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

Schema

Wajib. Skema variabel.

AppSnapshot

Snapshot aplikasi.

Kolom
`app`	`App` Opsional. Setelan dasar untuk aplikasi.
`agents[]`	`Agent` Opsional. Daftar agen di aplikasi.
`tools[]`	`Tool` Opsional. Daftar alat di aplikasi.
`examples[]`	`Example` Opsional. Daftar contoh dalam aplikasi.
`guardrails[]`	`Guardrail` Opsional. Daftar pembatasan dalam aplikasi.
`toolsets[]`	`Toolset` Opsional. Daftar toolset di aplikasi.

AppVersion

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

Kolom
`name`	`string` ID. ID unik versi aplikasi. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`display_name`	`string` Opsional. Nama tampilan versi aplikasi.
`description`	`string` Opsional. Deskripsi versi aplikasi.
`creator`	`string` Hanya output. Email pengguna yang membuat versi aplikasi.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat versi aplikasi dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat versi aplikasi terakhir diperbarui.
`snapshot`	`AppSnapshot` Hanya output. Snapshot aplikasi saat versi dibuat.
`etag`	`string` Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

AudioEncoding

AudioEncoding menentukan format encoding untuk data audio.

Enum
`AUDIO_ENCODING_UNSPECIFIED`	Encoding audio tidak ditentukan.
`LINEAR16`	Encoding audio PCM linear 16-bit.
`MULAW`	Sampel 8-bit yang memadatkan sampel audio 14-bit menggunakan G.711 PCMU/mu-law.
`ALAW`	Sampel 8-bit yang memadatkan sampel audio 14-bit menggunakan G.711 PCMU/A-law.

AudioProcessingConfig

Konfigurasi untuk cara pemrosesan dan pengiriman audio input dan output.

Kolom
`synthesize_speech_configs`	`map<string, SynthesizeSpeechConfig>` Opsional. Konfigurasi cara respons agen harus disintesis, pemetaan dari kode bahasa ke `SynthesizeSpeechConfig`. Jika konfigurasi untuk kode bahasa yang ditentukan tidak ditemukan, konfigurasi untuk kode bahasa root akan digunakan. Misalnya, jika peta berisi "en-us" dan "en", dan kode bahasa yang ditentukan adalah "en-gb", maka konfigurasi "en" akan digunakan. Catatan: Kode bahasa tidak peka huruf besar/kecil.
`barge_in_config`	`BargeInConfig` Opsional. Mengonfigurasi perilaku agen untuk aktivitas interupsi pengguna.
`inactivity_timeout`	`Duration` Opsional. Durasi tidak aktif pengguna (tidak ada ucapan atau interaksi) sebelum agen meminta pengguna untuk berinteraksi kembali. Jika tidak disetel, agen tidak akan meminta pengguna untuk berinteraksi kembali.
`ambient_sound_config`	`AmbientSoundConfig` Opsional. Konfigurasi untuk suara sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan.
`custom_voice_samples[]`	`CustomVoiceSample` Opsional. Mengonfigurasi contoh suara kustom untuk kloning suara.

AudioRecordingConfig

Konfigurasi cara interaksi audio harus direkam.

Kolom

gcs_bucket

string

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

Pilih lokasi bucket yang memenuhi persyaratan residensi data Anda.

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

gcs_path_prefix

string

Opsional. Awalan jalur Cloud Storage untuk rekaman audio.

Awalan ini dapat mencakup 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.

BargeInConfig

Konfigurasi cara penanganan aktivitas interupsi pengguna.

Kolom

disable_barge_in
(deprecated)

bool

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

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

barge_in_awareness

bool

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

BatchDeleteConversationsRequest

Pesan permintaan untuk AgentService.BatchDeleteConversations.

Kolom

parent

string

Wajib. Nama resource aplikasi yang percakapannya akan dihapus. Format: projects/{project}/locations/{location}/apps/{app}

conversations[]

string

Wajib. Nama resource percakapan yang akan dihapus.

BatchDeleteConversationsResponse

Pesan respons untuk AgentService.BatchDeleteConversations.

Kolom

deleted_conversations[]

string

Daftar percakapan yang berhasil dihapus.

failed_conversations[]

string

Daftar percakapan yang gagal dihapus.

error_messages[]

string

Opsional. Daftar pesan error yang terkait dengan percakapan yang gagal dihapus.

BearerTokenConfig

Konfigurasi untuk autentikasi dengan token pembawa.

Kolom

token

string

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

BidiSessionClientMessage

Pesan tingkat teratas yang dikirim oleh klien untuk metode SessionService.BidiRunSession.

Kolom

Kolom union message_type. Jenis pesan. message_type hanya ada berupa salah satu diantara berikut:

config

SessionConfig

Opsional. Pesan konfigurasi awal untuk sesi.

realtime_input

SessionInput

Opsional. Input real-time untuk sesi.

BidiSessionServerMessage

Pesan tingkat teratas yang ditampilkan dari metode SessionService.BidiRunSession.

Kolom
Kolom union `message_type`. Jenis pesan. `message_type` hanya ada berupa salah satu diantara berikut:
`session_output`	`SessionOutput` Opsional. Hasil pemrosesan dari agen CES.
`recognition_result`	`RecognitionResult` Opsional. Hasil pengenalan ucapan real-time untuk input audio.
`interruption_signal`	`InterruptionSignal` Opsional. Menunjukkan bahwa respons audio agen telah terganggu.
`end_session`	`EndSession` Opsional. Menunjukkan bahwa sesi telah berakhir.
`go_away`	`GoAway` Opsional. Menunjukkan bahwa server akan segera terputus dan klien harus menutup sebagian dan memulai ulang koneksi.

BigQueryExportSettings

Setelan untuk menjelaskan perilaku BigQuery Export untuk aplikasi.

Kolom

enabled

bool

Opsional. Menunjukkan apakah BigQuery Export diaktifkan.

project

string

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

Catatan: Jika set data BigQuery berada dalam 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.

Blob

Menampilkan input atau output blob dalam percakapan.

Kolom

mime_type

string

Wajib. Jenis MIME standar IANA dari data sumber.

data

bytes

Wajib. Byte mentah blob.

Callback

Callback menentukan logika kustom yang akan dieksekusi di berbagai tahap interaksi agen.

Kolom
`description`	`string` Opsional. Deskripsi callback yang dapat dibaca manusia.
`disabled`	`bool` Opsional. Apakah panggilan balik dinonaktifkan. Callback yang dinonaktifkan akan diabaikan oleh agen.
`proactive_execution_enabled`	`bool` Opsional. Jika diaktifkan, callback juga akan dieksekusi pada output model perantara. Setelan ini hanya memengaruhi callback setelah model. AKTIFKAN DENGAN HATI-HATI. Biasanya, callback setelah model hanya perlu dieksekusi setelah menerima semua respons model. Mengaktifkan eksekusi proaktif dapat berimplikasi negatif pada biaya dan latensi eksekusi, dan hanya boleh diaktifkan dalam situasi yang jarang terjadi.
Kolom union `callback`. Callback yang akan dieksekusi. `callback` hanya ada berupa salah satu diantara berikut:
`python_code`	`string` Wajib. Kode python yang akan dieksekusi untuk callback.

Log perubahan

Log perubahan mewakili perubahan yang dilakukan pada aplikasi atau pada resource dalam aplikasi.

Kolom
`name`	`string` ID. ID unik log perubahan. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}`
`author`	`string` Hanya output. Alamat email penulis perubahan.
`display_name`	`string` Hanya output. Nama tampilan perubahan. Biasanya, nilai ini adalah nama tampilan resource yang diubah.
`description`	`string` Hanya output. Deskripsi perubahan, yang biasanya mencakup kolom yang diubah dalam resource.
`resource`	`string` Hanya output. Resource yang diubah.
`resource_type`	`string` Hanya output. Jenis resource yang diubah.
`action`	`string` Hanya output. Tindakan yang dilakukan pada resource.
`original_resource`	`Struct` Hanya output. Resource asli sebelum perubahan.
`new_resource`	`Struct` Hanya output. Aset baru setelah perubahan.
`dependent_resources[]`	`Struct` Hanya output. Resource dependen yang diubah.
`create_time`	`Timestamp` Hanya output. Waktu saat perubahan dilakukan.
`sequence_number`	`int64` Hanya output. Nomor urut changelog yang meningkat secara monoton.

ChannelProfile

ChannelProfile mengonfigurasi perilaku agen untuk saluran komunikasi tertentu, seperti UI web atau telepon.

Kolom
`profile_id`	`string` Opsional. ID unik profil channel.
`channel_type`	`ChannelProfile.ChannelType` Opsional. Jenis profil saluran.
`persona_property`	`ChannelProfile.PersonaProperty` Opsional. Properti persona profil channel.
`web_widget_config`	`ChannelProfile.WebWidgetConfig` Opsional. Konfigurasi untuk widget web.
`whatsapp_config`	`ChannelProfile.WhatsAppConfig` Opsional. Konfigurasi khusus untuk deployment WhatsApp.
`instagram_config`	`ChannelProfile.InstagramConfig` Opsional. Konfigurasi khusus untuk deployment Instagram.
`disable_dtmf`	`bool` Opsional. Apakah akan menonaktifkan DTMF (nada ganda multi-frekuensi).
`disable_barge_in_control`	`bool` Opsional. Apakah akan menonaktifkan kontrol interupsi pengguna dalam percakapan. - true: Interupsi pengguna dinonaktifkan saat agen berbicara. - false: Agen mempertahankan kontrol otomatis atas kapan pengguna dapat menginterupsi.
`noise_suppression_level`	`string` Opsional. Tingkat peredam bising profil channel. Nilai yang tersedia adalah "low", "moderate", "high", "very_high".

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`	Channel Instagram.

InstagramConfig

Konfigurasi khusus untuk deployment Instagram.

Kolom
`instagram_account_id`	`string` Wajib. ID Akun Instagram.
`display_name`	`string` Hanya output. Nama halaman bisnis Meta yang diambil.
`thumbnail_url`	`string` Hanya output. URL thumbnail profil bisnis Meta yang diambil.
`description`	`string` Hanya output. Deskripsi halaman atau profil bisnis Meta.

PersonaProperty

Mewakili properti persona channel.

Kolom

persona

ChannelProfile.PersonaProperty.Persona

Opsional. Persona channel.

Persona

Persona channel.

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

WebWidgetConfig

Pesan untuk konfigurasi widget web.

Kolom
`modality`	`ChannelProfile.WebWidgetConfig.Modality` Opsional. Modalitas widget web.
`theme`	`ChannelProfile.WebWidgetConfig.Theme` Opsional. Tema widget web.
`web_widget_title`	`string` Opsional. Judul widget web.
`security_settings`	`ChannelProfile.WebWidgetConfig.SecuritySettings` Opsional. Setelan keamanan widget web.

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.

SecuritySettings

Setelan keamanan untuk widget web.

Kolom
`enable_public_access`	`bool` 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.
`enable_origin_check`	`bool` Opsional. Menunjukkan apakah pemeriksaan origin untuk widget web diaktifkan. Jika `true`, widget web akan memeriksa asal situs yang memuat widget web dan hanya mengizinkannya dimuat di asal yang sama atau salah satu asal yang diizinkan.
`allowed_origins[]`	`string` Opsional. Origin yang diizinkan untuk menghosting widget web. Origin ditentukan oleh RFC 6454. Jika kosong, semua origin diizinkan. Maksimum 100 origin diizinkan. Contoh: "https://example.com"
`enable_recaptcha`	`bool` Opsional. Menunjukkan apakah verifikasi reCAPTCHA untuk widget web diaktifkan.

Tema

Tema widget web.

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

WhatsAppConfig

Konfigurasi khusus untuk deployment WhatsApp.

Kolom
`waba_id`	`string` Wajib. ID Akun WhatsApp Business.
`phone_number_id`	`string` Wajib. ID nomor telepon Meta.
`phone_number`	`string` Opsional. Nomor telepon dalam format E.164.
`display_name`	`string` Hanya output. Nama halaman bisnis Meta yang diambil.
`thumbnail_url`	`string` Hanya output. URL thumbnail profil bisnis Meta yang diambil.
`description`	`string` Hanya output. Deskripsi halaman atau profil bisnis Meta.

Chunk

Potongan konten dalam pesan.

Kolom
Kolom union `data`. Data potongan. `data` hanya ada berupa salah satu diantara berikut:
`text`	`string` Opsional. Data teks.
`transcript`	`string` Opsional. Transkrip yang terkait dengan audio.
`blob`	`Blob` Opsional. Data blob.
`payload`	`Struct` Opsional. Data payload kustom.
`image`	`Image` Opsional. Data gambar.
`tool_call`	`ToolCall` Opsional. Permintaan eksekusi alat.
`tool_response`	`ToolResponse` Opsional. Respons eksekusi alat.
`agent_transfer`	`AgentTransfer` Opsional. Peristiwa transfer agen.
`updated_variables`	`Struct` Struct merepresentasikan variabel yang diperbarui dalam percakapan, yang dikelompokkan berdasarkan nama variabel.
`default_variables`	`Struct` Struct merepresentasikan variabel default di awal percakapan, yang dikelompokkan berdasarkan nama variabel.

Kutipan

Kutipan yang terkait dengan respons agen.

Kolom

cited_chunks[]

Citations.CitedChunk

Daftar informasi yang dikutip.

inline_citations[]

Citations.InlineCitation

Opsional. Daftar kutipan inline dalam respons agen.

CitedChunk

Bagian informasi yang dikutip.

Kolom
`uri`	`string` URI yang digunakan untuk kutipan.
`title`	`string` Judul dokumen yang dikutip.
`text`	`string` Teks yang digunakan untuk kutipan.
`requires_attribution`	`bool` Apakah kutipan ini memerlukan atribusi yang ditampilkan kepada pengguna akhir.

InlineCitation

Kutipan inline dalam teks respons.

Kolom

start_index

int32

Indeks awal (dalam byte) segmen teks dalam respons agen.

end_index

int32

Indeks akhir (dalam byte) segmen teks dalam respons agen.

cited_chunk_indices[]

int32

Indeks potongan yang dikutip yang mendukung segmen teks ini. Indeks mengacu pada elemen dalam cited_chunks.

ClientCertificateSettings

Setelan untuk sertifikat klien kustom.

Kolom

tls_certificate

string

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

private_key

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 secret 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}

ClientFunction

Mewakili fungsi sisi klien yang dapat dipanggil oleh agen. Saat alat dipilih oleh agen, kontrol akan diserahkan kepada klien. Klien bertanggung jawab untuk menjalankan fungsi dan menampilkan hasilnya sebagai ToolResponse untuk melanjutkan interaksi dengan agen.

Kolom
`name`	`string` Wajib. Nama fungsi.
`description`	`string` Opsional. Deskripsi fungsi.
`parameters`	`Schema` Opsional. Skema parameter fungsi.
`response`	`Schema` Opsional. Skema respons fungsi.

CloudLoggingSettings

Setelan untuk menjelaskan perilaku Cloud Logging untuk aplikasi.

Kolom

enable_cloud_logging

bool

Opsional. Apakah akan mengaktifkan Cloud Logging untuk sesi.

CodeBlock

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

Kolom

python_code

string

Wajib. Kode Python yang akan dipanggil dalam mode palsu alat. Tanda tangan fungsi Python yang diharapkan - Untuk menangkap semua panggilan alat: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Untuk menangkap panggilan alat tertentu: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Jika fungsi menampilkan None, alat yang sebenarnya akan dipanggil.

ConnectorTool

ConnectorTool memungkinkan koneksi ke berbagai integrasi. Lihat: https://cloud.google.com/integration-connectors/docs/overview.

Kolom
`connection`	`string` Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: `projects/{project}/locations/{location}/connections/{connection}`
`action`	`Action` Wajib. Tindakan untuk alat yang akan digunakan.
`auth_config`	`EndUserAuthConfig` Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan ConnectorTool akan gagal. Lihat https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override untuk mengetahui detailnya.
`name`	`string` Opsional. Nama alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini.
`description`	`string` Opsional. Deskripsi alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak.

ConnectorToolset

Kumpulan alat yang membuat alat dari Koneksi Integration Connectors.

Kolom

connection

string

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

auth_config

EndUserAuthConfig

Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan Toolset akan gagal. Lihat: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override

connector_actions[]

Action

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

Percakapan

Percakapan mewakili interaksi antara pengguna akhir dan aplikasi CES.

Kolom
`name`	`string` ID. ID unik percakapan. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}`
`start_time`	`Timestamp` Hanya output. Stempel waktu saat percakapan dibuat.
`end_time`	`Timestamp` Hanya output. Stempel waktu saat percakapan selesai.
`turns[]`	`Conversation.Turn` Wajib. Giliran dalam percakapan.
`turn_count`	`int32` Hanya output. Jumlah giliran dalam percakapan.
`channel_type (deprecated)`	`Conversation.ChannelType` Item ini tidak digunakan lagi. TIDAK DIGUNAKAN LAGI. Sebagai gantinya, gunakan `input_types`.
`source`	`Conversation.Source` Hanya output. Menunjukkan sumber percakapan.
`input_types[]`	`Conversation.InputType` Hanya output. Jenis input percakapan.
`entry_agent`	`string` Hanya output. Agen yang awalnya menangani percakapan. Jika tidak ditentukan, percakapan akan ditangani oleh agen root. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`deployment`	`string` Hanya output. Deployment aplikasi yang digunakan untuk memproses percakapan. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`app_version`	`string` Hanya output. Versi aplikasi yang digunakan untuk memproses percakapan. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`language_code`	`string` Hanya output. Kode bahasa percakapan.
`messages[] (deprecated)`	`Message` Item ini tidak digunakan lagi. Tidak digunakan lagi. Gunakan giliran sebagai gantinya.

ChannelType

Jenis channel percakapan.

Enum
`CHANNEL_TYPE_UNSPECIFIED`	Jenis saluran tidak ditentukan.
`TEXT`	Percakapan hanya berisi pesan teks antara pengguna akhir dan agen.
`AUDIO`	Percakapan berisi pesan audio antara pengguna akhir dan agen.
`MULTIMODAL`	Pesan multi-modal percakapan (misalnya, gambar) antara pengguna akhir dan agen.

InputType

Jenis pesan input.

Enum
`INPUT_TYPE_UNSPECIFIED`	Jenis input tidak ditentukan.
`INPUT_TYPE_TEXT`	Input teks.
`INPUT_TYPE_EVENT`	Input acara.
`INPUT_TYPE_AUDIO`	Input audio.
`INPUT_TYPE_IMAGE`	Input gambar.
`INPUT_TYPE_BLOB`	Input blob.
`INPUT_TYPE_TOOL_RESPONSE`	Input respons alat fungsi klien.
`INPUT_TYPE_VARIABLES`	Input variabel.

Sumber

Sumber percakapan.

Enum
`SOURCE_UNSPECIFIED`	Sumber tidak ditentukan.
`LIVE`	Percakapan berasal dari pengguna akhir yang aktif.
`SIMULATOR`	Percakapan berasal dari simulator.
`EVAL`	Percakapan berasal dari evaluasi.
`AGENT_TOOL`	Percakapan berasal dari alat agen. Alat agen menjalankan agen dalam sesi terpisah, yang dipertahankan untuk tujuan pengujian dan proses debug.

Belok

Semua informasi tentang satu giliran dalam percakapan.

Kolom

messages[]

Message

Opsional. Daftar pesan dalam giliran percakapan, termasuk input pengguna, respons agen, dan peristiwa perantara selama pemrosesan.

root_span

Span

Opsional. Rentang root pemrosesan tindakan.

user_intended_text

string

Opsional. Teks kebenaran nyata yang dimaksud dari Penelepon Simulasi (Polysynth). Hanya diisi jika metrik rasio kesalahan kata diaktifkan.

ConversationLoggingSettings

Setelan untuk menjelaskan perilaku logging percakapan untuk aplikasi.

Kolom

disable_conversation_logging

bool

Opsional. Apakah akan menonaktifkan logging percakapan untuk sesi.

retention_window

CustomVoiceSample.Warning.WarningType

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

Konfigurasi untuk sampel suara kustom yang digunakan untuk kloning suara.

Kolom
`name`	`string` Opsional. Nama yang ditentukan pengguna untuk sampel suara kustom.
`voice_sample_gcs_uri`	`string` Opsional. Cloud Storage URI ke sampel audio untuk kloning suara. Contoh audio harus berupa file WAV 24 kHz satu saluran.
`consent_audio_gcs_uri`	`string` Opsional. Menyetujui audio untuk kloning suara.
`voice_instruction`	`string` Opsional. Petunjuk bahasa alami untuk gaya suara, nada, kecepatan, atau pengucapan.
`preview_audio_content`	`bytes` Hanya output. Audio pratinjau yang disintesis untuk suara kustom, diformat sebagai WAV kanonis (LINEAR16, 24 kHz, 16 bit, mono).
`preview_text`	`string` Opsional. Teks untuk menyintesis audio pratinjau untuk suara kustom.
`warnings[]`	`CustomVoiceSample.Warning` Hanya output. Pesan peringatan yang muncul selama pemrosesan klon suara (misalnya, level audio rendah).
`voice_instruction_mode`	`CustomVoiceSample.VoiceInstructionMode` Opsional. Mode petunjuk untuk sampel suara. Jika tidak ditentukan, defaultnya adalah NO_INSTRUCTION.

VoiceInstructionMode

Mode petunjuk untuk sampel suara.

Enum
`VOICE_INSTRUCTION_MODE_UNSPECIFIED`	Mode petunjuk tidak ditentukan. Nilai defaultnya adalah NO_INSTRUCTION.
`NO_INSTRUCTION`	Tidak ada perintah 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.

Peringatan

Pesan peringatan yang muncul selama pemrosesan sampel suara.

Kolom

message

string

Hanya output. Deskripsi peringatan yang dapat dibaca manusia.

type

Hanya output. Jenis peringatan.

WarningType

Jenis peringatan yang muncul selama pemrosesan sampel suara.

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

DashboardSettings

Setelan untuk dasbor yang terkait dengan aplikasi, yang muncul di tampilan Monitoring.

Kolom

default_dashboard

string

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

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

DataStore

Resource DataStore di Vertex AI Search.

Kolom
`name`	`string` Wajib. Nama lengkap resource DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
`type`	`DataStore.DataStoreType` Hanya output. Jenis penyimpanan data. Kolom ini bersifat hanya baca dan diisi oleh server.
`document_processing_mode`	`DataStore.DocumentProcessingMode` Hanya output. Mode pemrosesan dokumen untuk koneksi penyimpanan data. Hanya ditetapkan untuk penyimpanan data PUBLIC_WEB dan UNSTRUCTURED.
`display_name`	`string` Hanya output. Nama tampilan penyimpanan data.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat penyimpanan data dibuat.
`connector_config`	`DataStore.ConnectorConfig` Hanya output. Konfigurasi konektor untuk koneksi penyimpanan data.

ConnectorConfig

Konfigurasi konektor untuk koneksi penyimpanan data.

Kolom

collection

string

Nama resource koleksi tempat penyimpanan data berada.

collection_display_name

string

Nama tampilan koleksi tempat penyimpanan data berada.

data_source

string

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

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.

DataStoreSettings

Setelan terkait penyimpanan data untuk aplikasi.

Kolom

engines[]

DataStoreSettings.Engine

Hanya output. Mesin untuk aplikasi.

Mesin

Mesin yang terhubung ke penyimpanan data. Lihat Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Kolom

name

string

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

type

DataStoreSettings.Engine.Type

Hanya output. Jenis mesin.

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_SEARCH`	Mesin SOLUTION_TYPE_SEARCH untuk aplikasi. Semua penyimpanan data konektor yang ditambahkan ke aplikasi akan ditambahkan ke mesin ini.
`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.

DataStoreTool

Alat untuk mengambil dari datastore atau mesin Vertex AI Search untuk melakukan perujukan. Menerima datastore atau mesin, tetapi tidak keduanya. Lihat Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Kolom
`name`	`string` Wajib. Nama alat penyimpanan data.
`description`	`string` Opsional. Deskripsi alat.
`boost_specs[]`	`DataStoreTool.BoostSpecs` Opsional. Spesifikasi penguatan untuk menguatkan dokumen tertentu.
`modality_configs[]`	`DataStoreTool.ModalityConfig` Opsional. Konfigurasi modalitas untuk penyimpanan data.
`filter_parameter_behavior`	`DataStoreTool.FilterParameterBehavior` Opsional. Perilaku parameter filter.
Kolom union `search_source`. Menentukan sumber penelusuran, baik DataStore tunggal maupun Mesin Telusur. `search_source` hanya ada berupa salah satu diantara berikut:
`data_store_source`	`DataStoreTool.DataStoreSource` Opsional. Menelusuri dalam satu DataStore tertentu.
`engine_source`	`DataStoreTool.EngineSource` Opsional. Menelusuri dalam Engine (berpotensi di beberapa DataStore).

BoostSpec

Spesifikasi penguatan untuk menguatkan dokumen tertentu.

Kolom

condition_boost_specs[]

DataStoreTool.BoostSpec.ConditionBoostSpec

Wajib. Daftar spesifikasi peningkat.

ConditionBoostSpec

Spesifikasi penguatan untuk suatu kondisi.

Kolom

condition

string

Wajib. Ekspresi yang menentukan kondisi peningkat. Sintaksisnya sama dengan sintaksis ekspresi filter. Saat ini, satu-satunya kondisi yang didukung adalah daftar kode bahasa BCP-47. Contoh: Untuk meningkatkan saran dalam bahasa Inggris atau Prancis: (lang_code: ANY("en", "fr"))

boost

float

Opsional. Kekuatan peningkat, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Defaultnya adalah 0,0.

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

Menetapkan ke -1,0 akan menurunkan saran secara signifikan. Namun, saran lain yang relevan mungkin masih ditampilkan.

Menyetel ke 0,0 berarti tidak ada peningkatan yang diterapkan. Kondisi peningkatan diabaikan.

boost_control_spec

DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec

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

BoostControlSpec

Spesifikasi untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan. Hal ini memberikan lebih banyak kontrol untuk peringkat yang disesuaikan daripada kombinasi sederhana (kondisi, peningkatan) di atas.

Kolom
`field_name`	`string` Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
`attribute_type`	`DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType` Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Untuk nilai numerik, caranya cukup mudah, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType` Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
`control_points[]`	`DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint` Opsional. Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolation_type di atas) melewati titik kontrol yang tercantum di sini.

AttributeType

Atribut(atau fungsi) yang akan diterapkan peringkat kustomnya.

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

ControlPoint

Titik kontrol yang digunakan untuk menentukan kurva. Kurva yang ditentukan melalui titik kontrol ini hanya dapat meningkat atau menurun secara monoton(nilai konstan dapat diterima).

Kolom

attribute_value

string

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

boost_amount

float

Opsional. Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attribute_value dievaluasi ke nilai yang ditentukan di atas.

InterpolationType

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

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

BoostSpecs

Spesifikasi penguatan untuk menguatkan dokumen tertentu. Untuk mengetahui informasi selengkapnya, lihat https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Kolom

data_stores[]

string

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

spec[]

DataStoreTool.BoostSpec

Wajib. Daftar spesifikasi peningkat.

DataStoreSource

Konfigurasi untuk menelusuri dalam DataStore tertentu.

Kolom

filter

string

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

data_store

DataStore

Opsional. Penyimpanan data.

EngineSource

Konfigurasi untuk menelusuri dalam Mesin, yang berpotensi menargetkan DataStore tertentu.

Kolom

engine

string

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

data_store_sources[]

DataStoreTool.DataStoreSource

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

filter

string

Opsional. Filter yang diterapkan pada penelusuran di seluruh Mesin Telusur. Tidak relevan dan tidak digunakan jika 'data_store_sources' disediakan. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

Perilaku parameter filter.

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

GroundingConfig

Konfigurasi perujukan.

Kolom

grounding_level

float

Opsional. Nilai minimum perujukan jawaban berdasarkan sumber yang diambil. Nilai memiliki rentang yang dapat dikonfigurasi [1, 5]. Tingkat ini digunakan untuk menentukan batas bawah perujukan jawaban, yang berarti bahwa semua respons dengan skor perujukan di bawah batas bawah akan kembali menampilkan hanya cuplikan yang relevan.

Misalnya, tingkat 3 berarti skor perujukan harus 3 atau lebih tinggi agar respons ditampilkan.

disabled

bool

Opsional. Apakah perujukan dinonaktifkan.

ModalityConfig

Jika ditentukan, akan menerapkan konfigurasi yang diberikan untuk modalitas yang ditentukan.

Kolom
`modality_type`	`DataStoreTool.ModalityConfig.ModalityType` Wajib. Jenis modalitas.
`rewriter_config`	`DataStoreTool.RewriterConfig` Opsional. Konfigurasi penulis ulang.
`summarization_config`	`DataStoreTool.SummarizationConfig` Opsional. Konfigurasi ringkasan.
`grounding_config`	`DataStoreTool.GroundingConfig` Opsional. Konfigurasi perujukan.
`snippets_config`	`DataStoreTool.SnippetsConfig` Opsional. Konfigurasi cuplikan.

ModalityType

Jenis modalitas.

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

RewriterConfig

Konfigurasi penulis ulang.

Kolom

model_settings

ModelSettings

Wajib. Konfigurasi untuk model LLM.

prompt

string

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

disabled

bool

Opsional. Apakah penulis ulang dinonaktifkan.

SnippetsConfig

Konfigurasi cuplikan.

Kolom

enable_snippets

bool

Opsional. Apakah cuplikan diaktifkan atau tidak.

max_snippets

int32

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

SummarizationConfig

Konfigurasi ringkasan.

Kolom

model_settings

ModelSettings

Opsional. Konfigurasi untuk model LLM.

prompt

string

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

disabled

bool

Opsional. Apakah ringkasan dinonaktifkan.

DeleteAgentRequest

Pesan permintaan untuk AgentService.DeleteAgent.

Kolom

name

string

Wajib. Nama resource agen yang akan dihapus.

force

bool

Opsional. Menunjukkan apakah agen akan dihapus secara paksa, meskipun masih direferensikan oleh aplikasi/agen/contoh lain.

Jika force = false, penghapusan akan gagal jika agen/contoh lain mereferensikannya.
Jika force = true, hapus agen dan hapus dari semua aplikasi/agen/contoh yang mereferensikannya.

etag

string

Opsional. ETag agen saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag agen saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteAppRequest

Pesan permintaan untuk AgentService.DeleteApp.

Kolom

name

string

Wajib. Nama resource aplikasi yang akan dihapus.

etag

string

Opsional. ETag aplikasi saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag aplikasi saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteAppVersionRequest

Pesan permintaan untuk AgentService.DeleteAppVersion.

Kolom

name

string

Wajib. Nama resource versi aplikasi yang akan dihapus.

etag

string

Opsional. ETag versi aplikasi saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag versi aplikasi saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteConversationRequest

Pesan permintaan untuk AgentService.DeleteConversation.

Kolom

name

string

Wajib. Nama resource percakapan yang akan dihapus.

source
(deprecated)

Conversation.Source

Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, Source.Live akan diterapkan secara default.

DeleteDeploymentRequest

Pesan permintaan untuk AgentService.DeleteDeployment.

Kolom

name

string

Wajib. Nama deployment yang akan dihapus. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

etag

string

Opsional. ETag deployment. Jika etag diberikan dan tidak cocok dengan etag deployment saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteEvaluationDatasetRequest

Pesan permintaan untuk EvaluationService.DeleteEvaluationDataset.

Kolom

name

string

Wajib. Nama resource set data evaluasi yang akan dihapus.

etag

string

Opsional. ETag set data evaluasi saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag saat ini dari set data evaluasi, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteEvaluationExpectationRequest

Pesan permintaan untuk EvaluationService.DeleteEvaluationExpectation.

Kolom

name

string

Wajib. Nama resource ekspektasi evaluasi yang akan dihapus.

etag

string

Opsional. ETag ekspektasi evaluasi saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag saat ini dari ekspektasi evaluasi, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteEvaluationRequest

Pesan permintaan untuk EvaluationService.DeleteEvaluation.

Kolom

name

string

Wajib. Nama resource evaluasi yang akan dihapus.

force

bool

Opsional. Menunjukkan apakah akan menghapus evaluasi secara paksa, meskipun masih dirujuk oleh set data evaluasi.

Jika force = false, penghapusan akan gagal jika ada set data yang masih mereferensikan evaluasi.
Jika force = true, semua referensi yang ada dari set data akan dihapus dan evaluasi akan dihapus.

etag

Pesan permintaan untuk AgentService.DeleteGuardrail.

Kolom

name

string

Wajib. Nama resource pembatasan yang akan dihapus.

force

bool

Opsional. Menunjukkan apakah akan menghapus batas aman secara paksa, meskipun masih dirujuk oleh aplikasi/agen.

Jika force = false, penghapusan akan gagal jika ada aplikasi/agen yang masih mereferensikan pembatasan.
Jika force = true, semua referensi yang ada dari aplikasi/agen akan dihapus dan pembatasan akan dihapus.

etag

string

Opsional. ETag saat ini dari pembatasan. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag saat ini dari pembatasan, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteScheduledEvaluationRunRequest

Pesan permintaan untuk EvaluationService.DeleteScheduledEvaluationRun.

Kolom

name

string

Wajib. Nama resource dari proses evaluasi terjadwal yang akan dihapus.

etag

string

Opsional. ETag ScheduledEvaluationRun. Jika disediakan, harus cocok dengan etag server.

DeleteToolRequest

Pesan permintaan untuk AgentService.DeleteTool.

Kolom

name

string

Wajib. Nama resource alat yang akan dihapus.

force

bool

Opsional. Menunjukkan apakah alat akan dihapus secara paksa, meskipun masih direferensikan oleh agen/contoh.

Jika force = false, penghapusan akan gagal jika ada agen yang masih mereferensikan alat tersebut.
Jika force = true, semua referensi yang ada dari agen akan dihapus dan alat akan dihapus.

etag

string

Opsional. ETag alat saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag alat saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteToolsetRequest

Pesan permintaan untuk AgentService.DeleteToolset.

Kolom

name

string

Wajib. Nama resource toolset yang akan dihapus.

force

bool

Opsional. Menunjukkan apakah akan menghapus toolset secara paksa, meskipun masih dirujuk oleh aplikasi/agen.

Jika force = false, penghapusan akan gagal jika ada agen yang masih mereferensikan toolset.
Jika force = true, semua referensi yang ada dari agen akan dihapus dan toolset akan dihapus.

etag

string

Opsional. ETag set alat saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag toolset saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeployChannelResponse

Pesan respons untuk AgentService.DeployChannel.

Kolom

deployment

Deployment

Deployment yang dibuat.

Deployment

Deployment mewakili versi aplikasi yang tidak dapat diubah dan dapat dikueri. Deployment digunakan untuk men-deploy versi aplikasi dengan profil saluran tertentu.

Kolom
`name`	`string` ID. Nama resource deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`display_name`	`string` Wajib. Nama tampilan deployment.
`app_version`	`string` Opsional. Nama resource versi aplikasi yang akan di-deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Gunakan `projects/{project}/locations/{location}/apps/{app}/versions/-` untuk menggunakan aplikasi draf.
`channel_profile`	`ChannelProfile` Wajib. Profil channel yang digunakan dalam deployment.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat deployment ini dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat deployment ini terakhir diperbarui.
`etag`	`string` Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
`experiment_config`	`ExperimentConfig` Opsional. Konfigurasi eksperimen untuk deployment.
`whatsapp_credentials`	`WhatsAppCredentials` Opsional. Hanya input. Kredensial WhatsApp sementara diperlukan saat mengonfigurasi profil saluran WhatsApp.
`instagram_credentials`	`InstagramCredentials` Opsional. Hanya input. Kredensial Instagram sementara diperlukan saat mengonfigurasi profil channel Instagram.
`model_settings`	`ModelSettings` Opsional. Setelan model untuk deployment. Menggantikan setelan model yang dikonfigurasi di tingkat aplikasi/agen. Catatan: Penggantian setelan model tingkat deployment dibatasi di belakang daftar yang diizinkan. Hubungi tim CXAS untuk mengaktifkan kolom ini.
`modality`	`Deployment.Modality` Opsional. Modalitas deployment. Catatan: Penggantian modalitas tingkat deployment hanya dapat dilakukan oleh pihak yang masuk dalam daftar yang diizinkan. Hubungi tim CXAS untuk mengaktifkan kolom ini.
`agent_registry_deployment`	`AgentRegistryDeployment` Opsional. Konfigurasi untuk men-deploy deployment ini ke Agent Registry. Jika ada, deployment ini akan dipublikasikan ke Agent Registry.

Modalitas

Modalitas deployment.

Enum
`MODALITY_UNSPECIFIED`	Modalitas tidak diketahui.
`MODALITY_TEXT`	Modalitas teks.
`MODALITY_VOICE`	Modalitas suara.
`MODALITY_VIDEO`	Modalitas video.

EndSession

Menunjukkan bahwa sesi telah berakhir, karena berhasil diselesaikan (misalnya, pengguna mengatakan "Selamat tinggal!" ) atau eskalasi agen.

Agen tidak akan memproses input lebih lanjut setelah sesi dihentikan dan klien harus menutup sebagian dan memutuskan koneksi setelah menerima semua respons yang tersisa dari agen.

Kolom

metadata

EndUserAuthConfig.Oauth2AuthCodeConfig

Opsional. Memberikan informasi tambahan tentang sinyal akhir sesi, seperti alasan mengakhiri sesi.

EndUserAuthConfig

Konfigurasi autentikasi pengguna akhir yang digunakan untuk panggilan Connection. Nilai kolom harus berupa nama variabel konteks dalam format $context.variables.<name_of_variable>.

Kolom

Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut:

oauth2_auth_code_config

Autentikasi Kode Otorisasi OAuth 2.0.

oauth2_jwt_bearer_config

EndUserAuthConfig.Oauth2JwtBearerConfig

Autentikasi Pemberian Otorisasi OAuth 2.0 Profil JWT.

Oauth2AuthCodeConfig

Konfigurasi autentikasi Kode Otorisasi OAuth 2.0.

Kolom

oauth_token

string

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

Oauth2JwtBearerConfig

Konfigurasi autentikasi Pemberian Otorisasi OAuth 2.0 Profil JWT.

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

client_key

string

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

EndpointControlPolicy

Menentukan kebijakan kontrol endpoint tingkat project/lokasi.

Kolom

enforcement_scope

EndpointControlPolicy.EnforcementScope

Opsional. Cakupan tempat daftar allowed_origins kebijakan ini diterapkan.

allowed_origins[]

string

Opsional. Origin HTTP(s) yang diizinkan yang dapat dipanggil langsung oleh alat di Aplikasi. Penerapan bergantung pada nilai enforcement_scope dan status VPC-SC project. Jika nomor port tidak diberikan, semua port akan diizinkan. Jika tidak, nomor port harus sama persis. Misalnya, "https://example.com" akan cocok dengan "https://example.com:443" dan port lainnya. "https://example.com:443" hanya akan cocok dengan "https://example.com:443".

EnforcementScope

Menentukan cakupan tempat daftar allowed_origins kebijakan ini diterapkan.

Enum
`ENFORCEMENT_SCOPE_UNSPECIFIED`	Tidak ditentukan. Kebijakan ini akan diperlakukan sebagai VPCSC_ONLY.
`VPCSC_ONLY`	Kebijakan ini hanya berlaku jika VPC-SC aktif.
`ALWAYS`	Kebijakan ini SELALU berlaku, terlepas dari status VPC-SC.

ErrorHandlingSettings

Setelan untuk menjelaskan cara error harus ditangani di aplikasi.

Kolom

error_handling_strategy

ErrorHandlingSettings.ErrorHandlingStrategy

Opsional. Strategi yang digunakan untuk penanganan error.

fallback_response_config

ErrorHandlingSettings.FallbackResponseConfig

Opsional. Konfigurasi untuk menangani respons penggantian.

end_session_config

ErrorHandlingSettings.EndSessionConfig

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

EndSessionConfig

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

Kolom

escalate_session

bool

Opsional. Apakah akan meningkatkan sesi di EndSession. Jika sesi ditingkatkan, 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.

ErrorHandlingStrategy

Menentukan strategi untuk menangani error.

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

FallbackResponseConfig

Konfigurasi untuk menangani respons penggantian.

Kolom

custom_fallback_messages

map<string, string>

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

max_fallback_attempts

int32

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

Evaluasi

Evaluasi merepresentasikan semua informasi yang diperlukan untuk menyimulasikan dan mengevaluasi agen.

Kolom
`name`	`string` ID. ID unik evaluasi ini. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`display_name`	`string` Wajib. Nama tampilan evaluasi yang ditentukan pengguna. Unik dalam Aplikasi.
`description`	`string` Opsional. Deskripsi evaluasi yang ditentukan pengguna.
`tags[]`	`string` Opsional. Tag yang ditentukan pengguna untuk mengategorikan evaluasi.
`evaluation_datasets[]`	`string` Hanya output. Daftar set data evaluasi yang termasuk dalam evaluasi. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`create_time`	`Timestamp` Hanya output. Stempel waktu saat evaluasi dibuat.
`created_by`	`string` Hanya output. Pengguna yang membuat evaluasi.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat evaluasi terakhir diperbarui.
`last_updated_by`	`string` Hanya output. Pengguna yang terakhir memperbarui evaluasi.
`evaluation_runs[]`	`string` Hanya output. EvaluationRuns yang terkait dengan Evaluasi ini.
`etag`	`string` Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
`aggregated_metrics`	`AggregatedMetrics` Hanya output. Metrik gabungan untuk evaluasi ini di semua proses.
`last_completed_result`	`EvaluationResult` Hanya output. Hasil evaluasi terbaru untuk evaluasi ini.
`invalid`	`bool` Hanya output. Apakah evaluasi tidak valid. Hal ini dapat terjadi jika evaluasi mereferensikan alat, toolset, atau agen yang telah dihapus.
`last_ten_results[]`	`EvaluationResult` Hanya output. 10 hasil evaluasi terakhir untuk evaluasi ini. Ini hanya diisi jika include_last_ten_results disetel ke benar (true) di ListEvaluationsRequest atau GetEvaluationRequest.
`evaluation_metrics_threshold_override`	`EvaluationMetricsThresholds` Opsional. Mengganti nilai minimum metrik untuk evaluasi spesifik ini.
`evaluation_metrics_config_override`	`EvaluationMetricsConfig` Opsional. Mengganti konfigurasi metrik untuk evaluasi spesifik ini.
Kolom union `inputs`. Input untuk evaluasi `inputs` hanya dapat berupa salah satu dari berikut:
`golden`	`Evaluation.Golden` Opsional. Langkah-langkah ideal yang akan dievaluasi.
`scenario`	`Evaluation.Scenario` Opsional. Konfigurasi untuk skenario.

Keemasan

Langkah-langkah yang diperlukan untuk memutar ulang percakapan emas.

Kolom

turns[]

Evaluation.GoldenTurn

Wajib. Jumlah putaran emas yang diperlukan untuk memutar ulang percakapan emas. Jumlah belokan maksimum yang diizinkan adalah 100.

evaluation_expectations[]

string

Opsional. Ekspektasi evaluasi untuk mengevaluasi percakapan yang diputar ulang. Format: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

GoldenExpectation

Mewakili satu persyaratan yang dapat dicentang.

Kolom
`note`	`string` Opsional. Catatan untuk persyaratan ini, berguna dalam pelaporan saat pemeriksaan tertentu gagal. Misalnya, "Check_Payment_Tool_Called".
`skip_evaluation`	`bool` Opsional. Jika disetel ke benar (true), ekspektasi khusus ini tidak akan dievaluasi.
`expectation_level_metrics_thresholds_override`	`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds` Opsional. Mengganti metrik di tingkat langkah.
`agent_response_semantic_similarity_metrics_config_override`	`EvaluationMetricsConfig.SemanticSimilarityMetricsConfig` Opsional. Penggantian untuk metrik kemiripan semantik agent_response.
`agent_response_hallucination_metrics_config_override`	`EvaluationMetricsConfig.HallucinationMetricsConfig` Opsional. Penggantian untuk metrik halusinasi agent_response.
`comparison_type`	`EvaluationMetricsConfig.ComparisonType` Opsional. Jenis perbandingan yang akan digunakan untuk pemeriksaan ekspektasi.
Kolom union `condition`. Pemeriksaan sebenarnya yang akan dilakukan. `condition` hanya ada berupa salah satu diantara berikut:
`tool_call`	`ToolCall` Opsional. Periksa apakah alat tertentu dipanggil dengan parameter.
`tool_response`	`ToolResponse` Opsional. Periksa apakah alat tertentu memberikan respons yang diharapkan.
`agent_response`	`Message` Opsional. Periksa apakah agen merespons dengan respons yang benar. Peran "agen" tersirat.
`agent_transfer`	`AgentTransfer` Opsional. Periksa apakah agen mengalihkan percakapan ke agen lain.
`updated_variables`	`Struct` Opsional. Pastikan agen memperbarui variabel sesi ke nilai yang diharapkan. Juga digunakan untuk merekam pembaruan variabel agen untuk evaluasi emas.
`mock_tool_response`	`ToolResponse` Opsional. Respons alat yang akan di-mock, dengan parameter yang diinginkan ditentukan. Parameter apa pun yang tidak ditentukan akan dihalusinasi oleh LLM.
`no_tool_calls`	`bool` Opsional. Periksa apakah tidak ada alat yang dipanggil selama giliran ini.

GoldenTurn

Giliran emas menentukan satu giliran dalam percakapan emas.

Kolom
`steps[]`	`Evaluation.Step` Wajib. Langkah-langkah yang diperlukan untuk memutar ulang percakapan emas.
`root_span`	`Span` Opsional. Rentang root dari belokan emas untuk memproses dan mempertahankan informasi audio. URI untuk audio harus berisi audio yang disimpan dalam frekuensi sampel 16 Khz.
`turn_level_metrics_thresholds_override`	`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds` Opsional. Penggantian untuk nilai minimum metrik tingkat giliran.
`hallucination_metric_behavior_override`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Opsional. Penggantian untuk perilaku metrik halusinasi tingkat belokan.

Skenario

Konfigurasi untuk skenario

Kolom
`task`	`string` Wajib. Tugas yang akan ditargetkan oleh skenario.
`user_facts[]`	`Evaluation.Scenario.UserFact` Opsional. Fakta pengguna yang akan digunakan oleh skenario.
`max_turns`	`int32` Opsional. Jumlah belokan maksimum yang akan disimulasikan. Nilai maksimum yang diizinkan adalah 100. Nilai defaultnya adalah 100.
`rubrics[]`	`string` Wajib. Rubrik untuk memberi skor pada skenario.
`scenario_expectations[]`	`Evaluation.ScenarioExpectation` Wajib. ScenarioExpectations untuk mengevaluasi percakapan yang dihasilkan oleh simulasi pengguna.
`variable_overrides`	`Struct` Opsional. Variabel / Parameter Sesi sebagai konteks untuk sesi, yang dikelompokkan menurut nama variabel. Anggota struct ini akan menggantikan nilai default yang ditetapkan oleh sistem. Perhatikan bahwa fakta ini berbeda dengan fakta pengguna, yang merupakan fakta yang diketahui pengguna. Variabel adalah parameter yang diketahui oleh agen: yaitu MDN (nomor telepon) yang diteruskan oleh sistem telepon.
`task_completion_behavior (deprecated)`	`Evaluation.Scenario.TaskCompletionBehavior` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi. Gunakan user_goal_behavior sebagai gantinya.
`user_goal_behavior`	`Evaluation.Scenario.UserGoalBehavior` Opsional. Perilaku yang diharapkan dari tujuan pengguna.
`evaluation_expectations[]`	`string` Opsional. Ekspektasi evaluasi untuk mengevaluasi percakapan yang dihasilkan oleh simulasi. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}`
`scenario_execution_mode`	`EvaluationSettings.ScenarioExecutionMode` Opsional. Mode eksekusi untuk evaluasi skenario.

TaskCompletionBehavior

Perilaku yang diharapkan dari tugas pengguna. Hal ini digunakan untuk menentukan apakah skenario berhasil.

Enum
`TASK_COMPLETION_BEHAVIOR_UNSPECIFIED`	Perilaku tidak ditentukan. Defaultnya adalah TASK_SATISFIED.
`TASK_SATISFIED`	Tugas pengguna harus berhasil diselesaikan.
`TASK_REJECTED`	Tugas pengguna harus ditolak.

UserFact

Fakta tentang pengguna sebagai key-value pair.

Kolom

name

string

Wajib. Nama fakta pengguna.

value

string

Wajib. Nilai fakta pengguna.

UserGoalBehavior

Perilaku yang diharapkan dari tujuan pengguna. Hal ini digunakan untuk menentukan apakah skenario berhasil.

Enum
`USER_GOAL_BEHAVIOR_UNSPECIFIED`	Perilaku tidak ditentukan. Defaultnya adalah USER_GOAL_SATISFIED.
`USER_GOAL_SATISFIED`	Tujuan pengguna harus berhasil diselesaikan.
`USER_GOAL_REJECTED`	Tujuan pengguna harus ditolak.
`USER_GOAL_IGNORED`	Mengabaikan status sasaran pengguna.

ScenarioExpectation

Ekspektasi untuk mengevaluasi percakapan yang dihasilkan oleh simulasi.

Kolom

Kolom union expectation. Ekspektasi untuk mengevaluasi percakapan yang dihasilkan oleh simulasi. expectation hanya ada berupa salah satu diantara berikut:

tool_expectation

Evaluation.ScenarioExpectation.ToolExpectation

Opsional. Pasangan panggilan dan respons alat yang akan dievaluasi.

agent_response

Message

Opsional. Respons agen yang akan dievaluasi.

ToolExpectation

Pasangan panggilan dan respons alat yang akan dievaluasi.

Kolom

expected_tool_call

ToolCall

Wajib. Panggilan alat yang diharapkan, dengan parameter yang diinginkan ditentukan. Parameter apa pun yang tidak ditentukan akan dihalusinasi oleh LLM.

mock_tool_response

ToolResponse

Wajib. Respons alat yang akan di-mock, dengan parameter yang diinginkan ditentukan. Parameter apa pun yang tidak ditentukan akan dihalusinasi oleh LLM.

Langkah

Langkah menentukan satu tindakan yang akan terjadi selama evaluasi.

Kolom
Kolom union `step`. Langkah yang akan dilakukan. `step` hanya ada berupa salah satu diantara berikut:
`user_input`	`SessionInput` Opsional. Input pengguna untuk percakapan.
`agent_transfer`	`AgentTransfer` Opsional. Mentransfer percakapan ke agen lain.
`expectation`	`Evaluation.GoldenExpectation` Opsional. Mengeksekusi ekspektasi pada giliran saat ini.

EvaluationConfig

EvaluationConfig mengonfigurasi setelan untuk menjalankan evaluasi.

Kolom
`input_audio_config`	`InputAudioConfig` Opsional. Konfigurasi untuk memproses audio input.
`output_audio_config`	`OutputAudioConfig` Opsional. Konfigurasi untuk membuat audio output.
`evaluation_channel`	`EvaluationConfig.EvaluationChannel` Opsional. Channel yang akan dievaluasi.
`tool_call_behaviour`	`EvaluationToolCallBehaviour` Opsional. Menentukan apakah evaluasi harus menggunakan panggilan alat asli atau alat palsu.

EvaluationChannel

Channel yang akan dievaluasi.

Enum
`EVALUATION_CHANNEL_UNSPECIFIED`	Saluran evaluasi tidak ditentukan.
`TEXT`	Saluran evaluasi hanya teks.
`AUDIO`	Saluran evaluasi audio.

EvaluationDataset

Set data evaluasi mewakili serangkaian evaluasi yang dikelompokkan bersama berdasarkan tag bersama.

Kolom
`name`	`string` ID. ID unik set data evaluasi ini. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`display_name`	`string` Wajib. Nama tampilan yang ditentukan pengguna untuk set data evaluasi. Unik dalam Aplikasi.
`evaluations[]`	`string` Opsional. Evaluasi yang disertakan dalam set data ini.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat set data evaluasi dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat set data evaluasi terakhir diperbarui.
`etag`	`string` Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
`created_by`	`string` Hanya output. Pengguna yang membuat set data evaluasi.
`last_updated_by`	`string` Hanya output. Pengguna yang terakhir kali memperbarui set data evaluasi.
`aggregated_metrics`	`AggregatedMetrics` Hanya output. Metrik gabungan untuk set data evaluasi ini di semua proses.

EvaluationErrorInfo

Informasi tentang error yang terjadi selama eksekusi evaluasi.

Kolom
`error_type`	`EvaluationErrorInfo.ErrorType` Hanya output. Jenis error.
`error_message`	`string` Hanya output. Pesan error.
`session_id`	`string` Hanya output. ID sesi untuk percakapan yang menyebabkan error.
`user_facing_error_message`	`string` Hanya output. Pesan error yang ditampilkan kepada pengguna.

ErrorType

Jenis error

Enum
`ERROR_TYPE_UNSPECIFIED`	Jenis error tidak ditentukan.
`RUNTIME_FAILURE`	Kegagalan selama eksekusi runtime.
`CONVERSATION_RETRIEVAL_FAILURE`	Gagal mengambil percakapan dari CES Runtime.
`METRIC_CALCULATION_FAILURE`	Gagal menghitung metrik / hasil.
`EVALUATION_UPDATE_FAILURE`	Gagal memperbarui evaluasi.
`QUOTA_EXHAUSTED`	Kehabisan kuota.
`USER_SIMULATION_FAILURE`	Kegagalan selama simulasi pengguna.

EvaluationExpectation

Ekspektasi evaluasi mewakili kriteria spesifik yang akan dievaluasi.

Kolom
`name`	`string` ID. ID unik ekspektasi evaluasi ini. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`
`display_name`	`string` Wajib. Nama tampilan yang ditentukan pengguna. Harus unik dalam aplikasi.
`tags[]`	`string` Opsional. Tag yang ditentukan pengguna untuk ekspektasi. Dapat digunakan untuk memfilter ekspektasi.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat ekspektasi evaluasi dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat ekspektasi evaluasi terakhir diperbarui.
`etag`	`string` Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
Kolom union `criteria`. Definisi kriteria yang digunakan untuk evaluasi. `criteria` hanya ada berupa salah satu diantara berikut:
`llm_criteria`	`EvaluationExpectation.LlmCriteria` Opsional. Kriteria evaluasi berdasarkan perintah LLM.

LlmCriteria

Konfigurasi untuk kriteria evaluasi berbasis LLM.

Kolom

prompt

string

Wajib. Perintah/petunjuk yang diberikan kepada hakim LLM.

EvaluationMetricsConfig

Mengonfigurasi metrik untuk evaluasi.

Kolom

golden_metrics_config

EvaluationMetricsConfig.GoldenMetricsConfig

Opsional. Konfigurasi untuk metrik utama untuk evaluasi.

scenario_metrics_config

EvaluationMetricsConfig.ScenarioMetricsConfig

Opsional. Konfigurasi untuk metrik skenario untuk evaluasi.

ComparisonType

Jenis perbandingan yang didukung untuk memeriksa respons agen.

Enum
`COMPARISON_TYPE_UNSPECIFIED`	Jenis perbandingan tidak ditentukan. Perilaku default adalah SEMANTIC_SIMILARITY untuk respons agen dan panggilan alat.
`EQUALS`	Pencocokan string persis.
`CONTAINS`	Pencocokan substring (memeriksa apakah string yang diharapkan terdapat dalam respons sebenarnya).
`SEMANTIC_SIMILARITY`	Kecocokan kemiripan semantik (mengevaluasi kemiripan makna menggunakan LLM).

ExpectationsMetMetricsConfig

Konfigurasi untuk metrik tingkat ekspektasi untuk evaluasi. Untuk menonaktifkan metrik, tetapkan pesan, tetapi jangan tetapkan kolom enable_expectations_met_metrics ke benar (atau tetapkan secara eksplisit ke salah). Untuk membatalkan setelan konfigurasi dan kembali ke perilaku default, hapus pesan sepenuhnya.

Kolom

enable_expectations_met_metrics

bool

Opsional. Apakah akan menghitung metrik tingkat ekspektasi untuk evaluasi.

GoldenMetricsConfig

Konfigurasi untuk metrik utama untuk evaluasi.

Kolom

semantic_similarity_metrics_config

EvaluationMetricsConfig.SemanticSimilarityMetricsConfig

Opsional. Konfigurasi global untuk metrik kemiripan semantik.

tool_correctness_metrics_config

EvaluationMetricsConfig.ToolCorrectnessMetricsConfig

Opsional. Konfigurasi untuk metrik kebenaran alat tingkat giliran.

step_tool_correctness_metrics_config

EvaluationMetricsConfig.ToolCorrectnessMetricsConfig

Opsional. Konfigurasi untuk metrik kebenaran alat tingkat langkah.

HallucinationMetricsConfig

Konfigurasi untuk metrik halusinasi untuk evaluasi. Untuk menonaktifkan metrik, tetapkan pesan, tetapi jangan tetapkan kolom enable_hallucination_metrics ke benar (atau tetapkan secara eksplisit ke salah). Untuk membatalkan setelan konfigurasi dan kembali ke perilaku default, hapus pesan sepenuhnya.

Kolom

enable_hallucination_metrics

bool

Opsional. Apakah akan menghitung metrik halusinasi untuk evaluasi.

ScenarioMetricsConfig

Konfigurasi untuk metrik skenario untuk evaluasi.

Kolom

user_goal_met_metrics_config

EvaluationMetricsConfig.UserGoalMetMetricsConfig

Opsional. Konfigurasi untuk metrik target pengguna tercapai.

expectations_met_metrics_config

EvaluationMetricsConfig.ExpectationsMetMetricsConfig

Opsional. Konfigurasi untuk metrik tingkat ekspektasi.

SemanticSimilarityMetricsConfig

Konfigurasi untuk metrik kesamaan untuk evaluasi. Untuk menonaktifkan metrik, tetapkan pesan, tetapi jangan tetapkan kolom enable_semantic_similarity_metrics ke benar (atau tetapkan secara eksplisit ke salah). Untuk membatalkan setelan konfigurasi dan kembali ke perilaku default, hapus pesan sepenuhnya.

Kolom

enable_semantic_similarity_metrics

bool

Opsional. Apakah akan menghitung metrik kemiripan semantik untuk evaluasi.

ToolCorrectnessMetricsConfig

Konfigurasi untuk metrik kebenaran untuk evaluasi. Untuk menonaktifkan metrik, tetapkan pesan, tetapi jangan tetapkan kolom enable_tool_correctness_metrics ke benar (atau tetapkan secara eksplisit ke salah). Untuk membatalkan setelan konfigurasi dan kembali ke perilaku default, hapus pesan sepenuhnya.

Kolom

enable_tool_correctness_metrics

bool

Opsional. Apakah akan menghitung metrik kebenaran alat untuk evaluasi.

UserGoalMetMetricsConfig

Konfigurasi untuk metrik yang memenuhi syarat tujuan pengguna untuk evaluasi. Untuk menonaktifkan metrik, tetapkan pesan, tetapi jangan tetapkan kolom enable_user_goal_met_metrics ke benar (atau tetapkan secara eksplisit ke salah). Untuk membatalkan setelan konfigurasi dan kembali ke perilaku default, hapus pesan sepenuhnya.

Kolom

enable_user_goal_met_metrics

bool

Opsional. Apakah akan menghitung metrik tujuan pengguna yang tercapai untuk evaluasi.

EvaluationMetricsThresholds

Setelan nilai minimum untuk metrik dalam Evaluasi.

Kolom
`golden_evaluation_metrics_thresholds`	`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds` Opsional. Nilai minimum metrik evaluasi emas.
`hallucination_metric_behavior (deprecated)`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: Gunakan `golden_hallucination_metric_behavior` sebagai gantinya. Perilaku metrik halusinasi saat ini digunakan untuk evaluasi utama.
`golden_hallucination_metric_behavior`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Opsional. Perilaku metrik halusinasi untuk evaluasi golden dataset.
`scenario_hallucination_metric_behavior`	`EvaluationMetricsThresholds.HallucinationMetricBehavior` Opsional. Perilaku metrik halusinasi untuk evaluasi skenario.

GoldenEvaluationMetricsThresholds

Setelan untuk evaluasi golden dataset.

Kolom

turn_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

Opsional. Nilai minimum metrik tingkat giliran.

expectation_level_metrics_thresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

Opsional. Nilai minimum metrik tingkat ekspektasi.

tool_matching_settings

EvaluationMetricsThresholds.ToolMatchingSettings

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

ExpectationLevelMetricsThresholds

Nilai minimum metrik tingkat ekspektasi.

Kolom

tool_invocation_parameter_correctness_threshold

float

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

TurnLevelMetricsThresholds

Mengaktifkan batas metrik tingkat.

Kolom

semantic_similarity_channel

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

Opsional. Saluran kemiripan semantik yang akan digunakan untuk evaluasi.

semantic_similarity_success_threshold

int32

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

overall_tool_invocation_correctness_threshold

float

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

SemanticSimilarityChannel

Saluran kemiripan semantik yang akan digunakan.

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

HallucinationMetricBehavior

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

Enum
`HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED`	Perilaku metrik halusinasi tidak ditentukan.
`DISABLED`	Menonaktifkan metrik halusinasi.
`ENABLED`	Aktifkan metrik halusinasi.

ToolMatchingSettings

Setelan untuk panggilan alat pencocokan.

Kolom

extra_tool_call_behavior

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

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

ExtraToolCallBehavior

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

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

EvaluationPersona

Persona mewakili pengguna akhir dalam evaluasi.

Kolom
`name`	`string` Wajib. ID unik persona. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`
`description`	`string` Opsional. Deskripsi persona.
`display_name`	`string` Wajib. Nama tampilan persona. Unik dalam aplikasi.
`personality`	`string` Wajib. Instruksi untuk agen tentang cara berperilaku dalam evaluasi.
`speech_config`	`EvaluationPersona.SpeechConfig` Opsional. Konfigurasi cara persona berbicara (setelan TTS).

SpeechConfig

Konfigurasi untuk pembuatan Text-to-Speech.

Kolom

speaking_rate

double

Opsional. Kecepatan bicara. 1,0 adalah normal. Nilai yang lebih rendah lebih lambat (misalnya, 0,8), nilai yang lebih tinggi lebih cepat (misalnya, 1,5). Berguna untuk menguji cara agen menangani orang yang berbicara cepat.

environment

EvaluationPersona.SpeechConfig.BackgroundEnvironment

Opsional. Lingkungan audio simulasi.

voice_id

string

Opsional. ID/aksen suara tertentu yang akan digunakan. Contoh: "en-US-Wavenet-D" atau "en-GB-Standard-A"

BackgroundEnvironment

Lingkungan audio simulasi.

Enum
`BACKGROUND_ENVIRONMENT_UNSPECIFIED`	Lingkungan latar belakang tidak ditentukan.
`CALL_CENTER`	Lingkungan pusat panggilan.
`TRAFFIC`	Lingkungan bising lalu lintas.
`KIDS_NOISE`	Lingkungan bising anak-anak.
`CAFE`	Lingkungan kafe.

EvaluationResult

Hasil evaluasi menampilkan output dari menjalankan Evaluasi.

Kolom
`name`	`string` ID. ID unik hasil evaluasi. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`
`display_name`	`string` Wajib. Nama tampilan Hasil Evaluasi. Unik dalam Evaluasi. Secara default, formatnya adalah: " result - ".
`create_time`	`Timestamp` Hanya output. Stempel waktu saat hasil evaluasi dibuat.
`evaluation_status`	`EvaluationResult.Outcome` Hanya output. Hasil evaluasi. Hanya diisi jika execution_state adalah COMPLETE.
`evaluation_run`	`string` Hanya output. Jalannya evaluasi yang menghasilkan hasil ini. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`
`persona`	`EvaluationPersona` Hanya output. Persona yang digunakan untuk membuat percakapan untuk hasil evaluasi.
`error_info`	`EvaluationErrorInfo` Hanya output. Informasi error untuk hasil evaluasi.
`error (deprecated)`	`Status` Item ini tidak digunakan lagi. Hanya output. Tidak digunakan lagi: Gunakan `error_info` sebagai gantinya. Terjadi error selama eksekusi.
`initiated_by`	`string` Hanya output. Pengguna yang memulai proses evaluasi yang menghasilkan hasil ini.
`app_version`	`string` Hanya output. Versi aplikasi yang digunakan untuk membuat percakapan yang menghasilkan hasil ini. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`app_version_display_name`	`string` Hanya output. Nama tampilan `app_version` yang digunakan untuk menjalankan evaluasi.
`changelog`	`string` Hanya output. Log perubahan versi aplikasi yang digunakan untuk menjalankan evaluasi. Kolom ini diisi jika pengguna menjalankan evaluasi pada versi terbaru/draf.
`changelog_create_time`	`Timestamp` Hanya output. Waktu pembuatan log perubahan versi aplikasi yang digunakan untuk menjalankan evaluasi. Kolom ini diisi jika pengguna menjalankan evaluasi pada versi terbaru/draf.
`execution_state`	`EvaluationResult.ExecutionState` Hanya output. Status eksekusi hasil evaluasi.
`evaluation_metrics_thresholds`	`EvaluationMetricsThresholds` Hanya output. Nilai minimum evaluasi untuk hasil.
`config`	`EvaluationConfig` Hanya output. Konfigurasi yang digunakan dalam proses evaluasi yang menghasilkan hasil ini.
`golden_run_method`	`GoldenRunMethod` Hanya output. Metode yang digunakan untuk menjalankan evaluasi emas.
`root_span`	`Span` Hanya output. Rentang root eksekusi evaluasi, yang mencakup informasi tentang setiap langkah evaluasi.
`outcome_metadata`	`EvaluationResult.OutcomeMetadata` Hanya output. Metadata hasil evaluasi. Hanya diisi jika execution_state adalah COMPLETE.
Kolom union `result`. Hasil evaluasi. Hanya diisi jika execution_state adalah COMPLETED. `result` hanya ada berupa salah satu diantara berikut:
`golden_result`	`EvaluationResult.GoldenResult` Hanya output. Hasil evaluasi golden.
`scenario_result`	`EvaluationResult.ScenarioResult` Hanya output. Hasil evaluasi skenario.

EvaluationExpectationResult

Hasil ekspektasi evaluasi tunggal.

Kolom
`evaluation_expectation`	`string` Hanya output. Ekspektasi evaluasi. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}`
`prompt`	`string` Hanya output. Perintah yang digunakan untuk evaluasi.
`outcome`	`EvaluationResult.Outcome` Hanya output. Hasil ekspektasi evaluasi.
`explanation`	`string` Hanya output. Penjelasan untuk hasil.

ExecutionState

Status eksekusi hasil evaluasi.

Enum
`EXECUTION_STATE_UNSPECIFIED`	Status eksekusi hasil evaluasi tidak ditentukan.
`QUEUED`	Eksekusi hasil evaluasi diantrekan.
`RUNNING`	Eksekusi hasil evaluasi sedang berjalan.
`COMPLETED`	Eksekusi hasil evaluasi telah selesai.
`ERROR`	Eksekusi hasil evaluasi gagal karena error internal.
`CANCELLED`	Eksekusi hasil evaluasi dibatalkan.

GoldenExpectationOutcome

Menentukan ekspektasi dan hasil dari ekspektasi tersebut.

Kolom
`expectation`	`Evaluation.GoldenExpectation` Hanya output. Ekspektasi yang dievaluasi.
`outcome`	`EvaluationResult.Outcome` Hanya output. Hasil dari ekspektasi.
`semantic_similarity_result (deprecated)`	`EvaluationResult.SemanticSimilarityResult` Item ini tidak digunakan lagi. Hanya output. Hasil pemeriksaan kemiripan semantik.
`tool_invocation_result`	`EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult` Hanya output. Hasil pemeriksaan pemanggilan alat.
Kolom union `result`. Hasil ekspektasi. `result` hanya ada berupa salah satu diantara berikut:
`observed_tool_call`	`ToolCall` Hanya output. Hasil ekspektasi panggilan alat.
`observed_tool_response`	`ToolResponse` Hanya output. Hasil ekspektasi respons alat.
`observed_agent_response`	`Message` Hanya output. Hasil ekspektasi respons agen.
`observed_agent_transfer`	`AgentTransfer` Hanya output. Hasil ekspektasi transfer agen.
`observed_payload`	`Struct` Hanya output. Payload kustom yang diamati. Tidak ada ekspektasi untuk payload kustom. Hal ini hanya digunakan untuk penghitungan metrik. Hasilnya selalu DILEWATI.

ToolInvocationResult

Hasil pemeriksaan pemanggilan alat.

Kolom

outcome

EvaluationResult.Outcome

Hanya output. Hasil pemeriksaan pemanggilan alat. Hal ini ditentukan dengan membandingkan parameter_correctness_score dengan nilai minimum. Jika skor sama dengan atau di atas nilai minimum, hasilnya adalah LULUS. Jika tidak, hasilnya akan GAGAL.

explanation

string

Hanya output. Penjelasan teks bebas untuk hasil pemanggilan alat.

parameter_correctness_score

float

Hanya output. Skor kebenaran parameter pemanggilan alat. Ini menunjukkan persentase parameter dari panggilan alat yang diharapkan yang juga ada dalam panggilan alat sebenarnya.

GoldenResult

Hasil evaluasi golden.

Kolom

turn_replay_results[]

EvaluationResult.GoldenResult.TurnReplayResult

Hanya output. Hasil menjalankan setiap giliran percakapan emas.

evaluation_expectation_results[]

EvaluationResult.EvaluationExpectationResult

Hanya output. Hasil ekspektasi evaluasi.

TurnReplayResult

Hasil menjalankan satu giliran percakapan emas.

Kolom
`conversation`	`string` Hanya output. Percakapan yang dibuat untuk giliran ini.
`expectation_outcome[]`	`EvaluationResult.GoldenExpectationOutcome` Hanya output. Hasil dari setiap ekspektasi.
`hallucination_result`	`EvaluationResult.HallucinationResult` Hanya output. Hasil pemeriksaan halusinasi.
`tool_invocation_score (deprecated)`	`float` Item ini tidak digunakan lagi. Hanya output. Tidak digunakan lagi. Sebagai gantinya, gunakan OverallToolInvocationResult.
`turn_latency`	`Duration` Hanya output. Durasi giliran.
`tool_call_latencies[]`	`EvaluationResult.ToolCallLatency` Hanya output. Latensi setiap panggilan alat dalam giliran.
`semantic_similarity_result`	`EvaluationResult.SemanticSimilarityResult` Hanya output. Hasil pemeriksaan kemiripan semantik.
`overall_tool_invocation_result`	`EvaluationResult.OverallToolInvocationResult` Hanya output. Hasil pemeriksaan pemanggilan alat secara keseluruhan.
`error_info`	`EvaluationErrorInfo` Hanya output. Informasi tentang error yang terjadi selama giliran ini.
`span_latencies[]`	`EvaluationResult.SpanLatency` Hanya output. Latensi rentang dalam giliran.
`tool_ordered_invocation_score`	`float` Hanya output. Skor pemanggilan alat keseluruhan yang dipesan untuk giliran ini. Ini menunjukkan persentase keseluruhan alat dari belokan yang diharapkan yang benar-benar dipanggil dalam urutan yang diharapkan.

HallucinationResult

Hasil pemeriksaan halusinasi untuk satu giliran.

Kolom

label

string

Hanya output. Label yang terkait dengan setiap skor. Skor 1: Dibenarkan Skor 0: Tidak Dibenarkan Skor -1: Tidak Ada Klaim untuk Dinilai

explanation

string

Hanya output. Penjelasan untuk skor halusinasi.

score

int32

Hanya output. Skor halusinasi. Dapat berupa -1, 0, 1.

Hasil

Hasil evaluasi atau ekspektasi.

Enum
`OUTCOME_UNSPECIFIED`	Hasil evaluasi tidak ditentukan.
`PASS`	Evaluasi/Ekspektasi terpenuhi. Dalam kasus evaluasi, hal ini berarti semua ekspektasi terpenuhi.
`FAIL`	Evaluasi/Ekspektasi gagal. Dalam kasus evaluasi, hal ini berarti setidaknya ada satu ekspektasi yang tidak terpenuhi.
`SKIPPED`	Evaluasi/Ekspektasi dilewati.

OutcomeMetadata

Metadata tentang hasil evaluasi.

Enum
`OUTCOME_METADATA_UNSPECIFIED`	Metadata hasil tidak ditentukan.
`GRACEFUL_HANDOFF`	Evaluasi menghasilkan pengalihan yang lancar kepada perwakilan manusia.

OverallToolInvocationResult

Hasil pemeriksaan pemanggilan alat secara keseluruhan.

Kolom

outcome

EvaluationResult.Outcome

Hanya output. Hasil pemeriksaan pemanggilan alat. Hal ini ditentukan dengan membandingkan tool_invocation_score dengan overall_tool_invocation_correctness_threshold. Jika skor sama dengan atau di atas nilai minimum, hasilnya adalah LULUS. Jika tidak, hasilnya akan GAGAL.

tool_invocation_score

float

Skor pemanggilan alat keseluruhan untuk giliran ini. Ini menunjukkan persentase keseluruhan alat dari belokan yang diharapkan yang benar-benar dipanggil.

ScenarioExpectationOutcome

Hasil ekspektasi skenario.

Kolom
`expectation`	`Evaluation.ScenarioExpectation` Hanya output. Ekspektasi yang dievaluasi.
`outcome`	`EvaluationResult.Outcome` Hanya output. Hasil ScenarioExpectation.
Kolom union `result`. Hasil ekspektasi. `result` hanya ada berupa salah satu diantara berikut:
`observed_tool_call`	`EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall` Hanya output. Panggilan alat yang diamati.
`observed_agent_response`	`Message` Hanya output. Respons agen yang diamati.

ObservedToolCall

Panggilan dan respons alat yang diamati.

Kolom

tool_call

ToolCall

Hanya output. Panggilan alat yang diamati.

tool_response

ToolResponse

Hanya output. Respons alat yang diamati.

ScenarioResult

Hasil evaluasi skenario.

Kolom
`conversation`	`string` Hanya output. Percakapan yang dihasilkan dalam skenario.
`task`	`string` Hanya output. Tugas yang digunakan saat menjalankan skenario untuk hasil ini.
`user_facts[]`	`Evaluation.Scenario.UserFact` Hanya output. Fakta pengguna yang digunakan oleh skenario untuk hasil ini.
`expectation_outcomes[]`	`EvaluationResult.ScenarioExpectationOutcome` Hanya output. Hasil dari setiap ekspektasi.
`rubric_outcomes[]`	`EvaluationResult.ScenarioRubricOutcome` Hanya output. Hasil rubrik.
`hallucination_result[]`	`EvaluationResult.HallucinationResult` Hanya output. Hasil pemeriksaan halusinasi. Akan ada satu hasil halusinasi untuk setiap giliran dalam percakapan.
`task_completion_result (deprecated)`	`EvaluationResult.TaskCompletionResult` Item ini tidak digunakan lagi. Hanya output. Hasil pemeriksaan penyelesaian tugas.
`tool_call_latencies[]`	`EvaluationResult.ToolCallLatency` Hanya output. Latensi setiap eksekusi panggilan alat dalam percakapan.
`user_goal_satisfaction_result`	`EvaluationResult.UserGoalSatisfactionResult` Hanya output. Hasil pemeriksaan kepuasan target pengguna.
`span_latencies[]`	`EvaluationResult.SpanLatency` Hanya output. Latensi rentang dalam percakapan.
`evaluation_expectation_results[]`	`EvaluationResult.EvaluationExpectationResult` Hanya output. Hasil ekspektasi evaluasi.
`all_expectations_satisfied`	`bool` Hanya output. Apakah semua ekspektasi terpenuhi untuk giliran ini.
`task_completed`	`bool` Hanya output. Apakah tugas telah diselesaikan untuk giliran ini. Ini adalah gabungan dari semua ekspektasi yang terpenuhi, tidak ada halusinasi, dan kepuasan tujuan pengguna.

ScenarioRubricOutcome

Hasil evaluasi berdasarkan rubrik.

Kolom

rubric

string

Hanya output. Rubrik yang digunakan untuk mengevaluasi percakapan.

score_explanation

string

Hanya output. Respons pemberi rating terhadap rubrik.

score

float

Hanya output. Skor percakapan berdasarkan rubrik.

SemanticSimilarityResult

Hasil pemeriksaan kemiripan semantik.

Kolom
`label`	`string` Hanya output. Label yang terkait dengan setiap skor. Skor 4: Skor Sepenuhnya Konsisten Skor 3: Skor Sebagian Besar Konsisten Skor 2: Sebagian Konsisten (Kelalaian Ringan) Skor 1: Sebagian Besar Tidak Konsisten (Kelalaian Berat) Skor 0: Sepenuhnya Tidak Konsisten / Bertentangan
`explanation`	`string` Hanya output. Penjelasan untuk skor kemiripan semantik.
`outcome`	`EvaluationResult.Outcome` Hanya output. Hasil pemeriksaan kemiripan semantik. Hal ini ditentukan dengan membandingkan skor dengan semantic_similarity_success_threshold. Jika skor sama dengan atau di atas nilai minimum, hasilnya adalah LULUS. Jika tidak, hasilnya akan GAGAL.
`score`	`int32` Hanya output. Skor kemiripan semantik. Dapat berupa 0, 1, 2, 3, atau 4.

SpanLatency

Latensi eksekusi rentang.

Kolom
`type`	`EvaluationResult.SpanLatency.Type` Hanya output. Jenis rentang.
`display_name`	`string` Hanya output. Nama tampilan rentang. Berlaku untuk rentang alat dan pedoman.
`start_time`	`Timestamp` Hanya output. Waktu mulai rentang.
`end_time`	`Timestamp` Hanya output. Waktu akhir rentang.
`execution_latency`	`Duration` Hanya output. Latensi rentang.
Kolom union `identifier`. ID item tertentu berdasarkan jenisnya. `identifier` hanya ada berupa salah satu diantara berikut:
`resource`	`string` Hanya output. Nama resource rentang alat atau batas aman.
`toolset`	`ToolsetTool` Hanya output. ID alat toolset.
`model`	`string` Hanya output. Nama rentang LLM.
`callback`	`string` Hanya output. Nama rentang callback pengguna.

Jenis

Jenis rentang. Nilai tambahan dapat ditambahkan di masa mendatang.

Enum
`TYPE_UNSPECIFIED`	Nilai default. Nilai ini tidak digunakan.
`TOOL`	Rentang panggilan alat.
`USER_CALLBACK`	Rentang panggilan balik pengguna.
`GUARDRAIL`	Rentang pagar pembatas.
`LLM`	Rentang LLM.

TaskCompletionResult

Hasil pemeriksaan penyelesaian tugas untuk percakapan.

Kolom

label

string

Hanya output. Label yang terkait dengan setiap skor. Skor 1: Tugas Selesai Skor 0: Tugas Belum Selesai Skor -1: Target Pengguna Tidak Ditentukan

explanation

string

Hanya output. Penjelasan untuk skor penyelesaian tugas.

score

int32

Hanya output. Skor penyelesaian tugas. Dapat berupa -1, 0, 1

ToolCallLatency

Latensi eksekusi panggilan alat.

Kolom
`tool`	`string` Hanya output. Nama alat yang dijalankan. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.
`display_name`	`string` Hanya output. Nama tampilan alat.
`start_time`	`Timestamp` Hanya output. Waktu mulai eksekusi panggilan alat.
`end_time`	`Timestamp` Hanya output. Waktu berakhir eksekusi panggilan alat.
`execution_latency`	`Duration` Hanya output. Latensi eksekusi panggilan alat.

UserGoalSatisfactionResult

Hasil pemeriksaan kepuasan tujuan pengguna untuk percakapan.

Kolom

label

string

Hanya output. Label yang terkait dengan setiap skor. Skor 2: Skor Pengalihan yang Lancar 1: Tugas Pengguna Selesai 0: Tugas Pengguna Tidak Selesai Skor -1: Tugas Pengguna Tidak Ditentukan

explanation

string

Hanya output. Penjelasan untuk skor kepuasan tugas pengguna.

score

int32

Hanya output. Skor kepuasan tugas pengguna. Dapat berupa -1, 0, 1, 2.

EvaluationRun

Jalannya evaluasi mewakili semua hasil evaluasi dari eksekusi evaluasi.

Kolom
`name`	`string` ID. ID unik proses evaluasi. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`
`display_name`	`string` Opsional. Nama tampilan yang ditentukan pengguna untuk proses evaluasi. default: " run - ".
`evaluation_results[]`	`string` Hanya output. Hasil evaluasi yang merupakan bagian dari proses ini. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}`
`create_time`	`Timestamp` Hanya output. Stempel waktu saat proses evaluasi dibuat.
`initiated_by`	`string` Hanya output. Pengguna yang memulai proses evaluasi.
`app_version`	`string` Hanya output. Versi aplikasi yang akan dievaluasi. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`app_version_display_name`	`string` Hanya output. Nama tampilan `app_version` yang digunakan untuk menjalankan evaluasi.
`changelog`	`string` Hanya output. Log perubahan versi aplikasi yang digunakan untuk menjalankan evaluasi. Kolom ini diisi jika pengguna menjalankan evaluasi pada versi terbaru/draf.
`changelog_create_time`	`Timestamp` Hanya output. Waktu pembuatan log perubahan versi aplikasi yang digunakan untuk menjalankan evaluasi. Kolom ini diisi jika pengguna menjalankan evaluasi pada versi terbaru/draf.
`evaluations[]`	`string` Hanya output. Evaluasi yang merupakan bagian dari proses ini. Daftar dapat berisi evaluasi dari kedua jenis. Kolom ini tidak dapat muncul bersamaan dengan `evaluation_dataset`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`evaluation_dataset`	`string` Hanya output. Set data evaluasi yang terkait dengan proses ini. Kolom ini tidak dapat muncul bersamaan dengan `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`evaluation_type`	`EvaluationRun.EvaluationType` Hanya output. Jenis evaluasi dalam proses ini.
`state`	`EvaluationRun.EvaluationRunState` Hanya output. Status proses evaluasi.
`progress`	`EvaluationRun.Progress` Hanya output. Progres eksekusi evaluasi.
`config`	`EvaluationConfig` Hanya output. Konfigurasi yang digunakan dalam run.
`error (deprecated)`	`Status` Item ini tidak digunakan lagi. Hanya output. Tidak digunakan lagi: Gunakan error_info sebagai gantinya. Terjadi error selama eksekusi.
`error_info`	`EvaluationErrorInfo` Hanya output. Informasi error untuk proses evaluasi.
`evaluation_run_summaries`	`map<string, EvaluationRun.EvaluationRunSummary>` Hanya output. Peta nama evaluasi ke EvaluationRunSummary.
`latency_report`	`LatencyReport` Hanya output. Laporan latensi untuk proses evaluasi.
`run_count`	`int32` Hanya output. Jumlah berapa kali evaluasi di dalam proses dijalankan.
`persona_run_configs[]`	`PersonaRunConfig` Hanya output. Konfigurasi yang akan digunakan untuk menjalankan per persona.
`optimization_config`	`OptimizationConfig` Opsional. Konfigurasi untuk menjalankan langkah pengoptimalan setelah menjalankan evaluasi. Jika tidak disetel, langkah pengoptimalan tidak akan dijalankan.
`scheduled_evaluation_run`	`string` Hanya output. Nama resource eksekusi evaluasi terjadwal yang membuat eksekusi evaluasi ini. Kolom ini hanya disetel jika proses evaluasi dibuat oleh proses evaluasi terjadwal. Format: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`
`golden_run_method`	`GoldenRunMethod` Hanya output. Metode yang digunakan untuk menjalankan evaluasi.
`operation`	`string` Hanya output. Operasi yang membuat proses evaluasi ini. Format: `projects/{project}/locations/{location}/operations/{operation}`

EvaluationRunState

Status proses evaluasi.

Enum
`EVALUATION_RUN_STATE_UNSPECIFIED`	Status eksekusi evaluasi tidak ditentukan.
`QUEUED`	Menunjukkan bahwa proses evaluasi dimasukkan dalam antrean.
`RUNNING`	Evaluasi sedang berjalan.
`COMPLETED`	Eksekusi evaluasi telah selesai.
`ERROR`	Terjadi error pada proses evaluasi.
`CANCELLED`	Eksekusi evaluasi dibatalkan.

EvaluationRunSummary

Berisi ringkasan jumlah hasil lulus dan gagal untuk evaluasi tertentu dalam proses evaluasi.

Kolom

passed_count

int32

Hanya output. Jumlah hasil lulus untuk Evaluasi terkait dalam proses ini.

failed_count

int32

Hanya output. Jumlah hasil yang gagal untuk Evaluasi terkait dalam operasi ini.

error_count

int32

Hanya output. Jumlah hasil error untuk Evaluasi terkait dalam proses ini.

EvaluationType

Jenis evaluasi dalam proses ini. Nilai tambahan dapat ditambahkan di masa mendatang.

Enum
`EVALUATION_TYPE_UNSPECIFIED`	Jenis evaluasi tidak ditentukan.
`GOLDEN`	Evaluasi golden.
`SCENARIO`	Evaluasi skenario.
`MIXED`	Menunjukkan bahwa proses mencakup campuran evaluasi emas dan skenario.

Progres

Progres eksekusi evaluasi.

Kolom
`total_count`	`int32` Hanya output. Jumlah total hasil evaluasi dalam proses ini.
`failed_count`	`int32` Hanya output. Jumlah hasil evaluasi yang selesai dengan hasil GAGAL. (EvaluationResult.execution_state adalah COMPLETED dan EvaluationResult.evaluation_status adalah FAIL).
`error_count`	`int32` Hanya output. Jumlah hasil evaluasi yang gagal dieksekusi. (EvaluationResult.execution_state adalah ERROR).
`completed_count`	`int32` Hanya output. Jumlah hasil evaluasi yang berhasil diselesaikan. (EvaluationResult.execution_state adalah COMPLETED).
`passed_count`	`int32` Hanya output. Jumlah hasil evaluasi yang selesai dengan hasil LULUS. (EvaluationResult.execution_state adalah COMPLETED dan EvaluationResult.evaluation_status adalah PASS).
`cancelled_count`	`int32` Hanya output. Jumlah hasil evaluasi yang dibatalkan. (EvaluationResult.execution_state adalah CANCELLED).

EvaluationRunCachingSettings

Setelan untuk caching eksekusi evaluasi.

Kolom

run_caching_mode

EvaluationRunCachingSettings.EvaluationRunCachingMode

Opsional. Mode penayangan iklan yang akan digunakan untuk menjalankan evaluasi. Jika tidak disetel, default-nya adalah FORCE_RUN.

EvaluationRunCachingMode

Perilaku caching hasil evaluasi. Mengontrol apakah akan menampilkan hasil evaluasi terakhir yang telah selesai (jika ada) atau menjalankan evaluasi baru.

Enum
`EVALUATION_RUN_CACHING_MODE_UNSPECIFIED`	Mode caching run tidak ditentukan.
`FORCE_RUN`	Selalu jalankan simulasi langsung penuh, terlepas dari apakah log perubahan ada atau tidak.
`SKIP_IF_UNCHANGED`	Lewati eksekusi dan salin hasil terverifikasi sebelumnya jika tidak ada dependensi yang berubah, saluran evaluasi/metode eksekusi sama.

EvaluationSettings

Setelan untuk evaluasi.

Kolom
`scenario_conversation_initiator`	`EvaluationSettings.ScenarioConversationInitiator` Opsional. Siapa yang memulai percakapan dalam evaluasi skenario.
`golden_run_method`	`GoldenRunMethod` Opsional. Metode default yang digunakan untuk menjalankan evaluasi golden dataset. Metode ini akan digunakan jika tidak ada golden_run_method yang ditentukan dalam RunEvaluationRequest.
`golden_evaluation_tool_call_behaviour`	`EvaluationToolCallBehaviour` Opsional. Mengonfigurasi perilaku panggilan alat default untuk evaluasi emas.
`scenario_evaluation_tool_call_behaviour`	`EvaluationToolCallBehaviour` Opsional. Mengonfigurasi perilaku panggilan alat default untuk evaluasi skenario.
`metrics_config`	`EvaluationMetricsConfig` Opsional. Mengonfigurasi metrik default untuk evaluasi.
`scenario_execution_mode`	`EvaluationSettings.ScenarioExecutionMode` Opsional. Mode eksekusi untuk evaluasi skenario. Jika tidak diberikan, defaultnya adalah QUALITY_OPTIMIZED.
`evaluation_run_caching_settings`	`EvaluationRunCachingSettings` Opsional. Setelan penyiapan yang akan digunakan untuk menjalankan evaluasi.

ScenarioConversationInitiator

Menentukan siapa yang memulai percakapan dalam sesi evaluasi skenario.

Enum
`SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED`	Tidak ditentukan. Nilai defaultnya adalah USER.
`USER`	Pengguna memulai percakapan.
`AGENT`	Agen memulai percakapan.

ScenarioExecutionMode

Mode eksekusi untuk evaluasi skenario.

Enum
`SCENARIO_EXECUTION_MODE_UNSPECIFIED`	Mode eksekusi tidak ditentukan. Nilai defaultnya adalah QUALITY_OPTIMIZED.
`QUALITY_OPTIMIZED`	Mode yang dioptimalkan untuk kualitas.
`SPEED_OPTIMIZED`	Mode yang dioptimalkan untuk kecepatan.

EvaluationToolCallBehaviour

Mengonfigurasi perilaku panggilan alat untuk menjalankan evaluasi.

Enum
`EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED`	Perilaku panggilan alat tidak ditentukan. Akan menggunakan panggilan alat asli secara default.
`REAL`	Gunakan panggilan alat sebenarnya.
`FAKE`	Menggunakan panggilan alat palsu.

Acara

Input acara.

Kolom

event

string

Wajib. Nama acara.

variables

ExperimentConfig.VersionRelease

Opsional. Variabel tambahan yang terkait dengan peristiwa.

Contoh

Contoh mewakili contoh percakapan antara pengguna dan agen.

Kolom
`name`	`string` ID. ID unik contoh. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
`display_name`	`string` Wajib. Nama tampilan contoh.
`description`	`string` Opsional. Deskripsi contoh yang dapat dibaca manusia.
`entry_agent`	`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[]`	`Message` Opsional. Kumpulan pesan yang membentuk percakapan.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat contoh dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat contoh terakhir diperbarui.
`invalid`	`bool` Hanya output. Contoh dapat menjadi tidak valid jika resource yang dirujuk dihapus. Contoh yang tidak valid tidak akan digunakan sebagai contoh few-shot.
`etag`	`string` ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

ExecuteToolRequest

Pesan permintaan untuk ToolService.ExecuteTool.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi yang memiliki alat/kumpulan alat. Format: `projects/{project}/locations/{location}/apps/{app}`
`args`	`Struct` Opsional. Parameter dan nilai input untuk alat dalam format objek JSON.
`mock_config`	`MockConfig` Opsional. Konfigurasi tiruan untuk eksekusi alat. Jika kolom ini disetel, alat yang memanggil alat lain akan di-mock berdasarkan pola dan respons yang diberikan.
Kolom union `tool_identifier`. ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool`	`string` Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
`toolset_tool`	`ToolsetTool` Opsional. Alat toolset yang akan dijalankan. Hanya satu alat yang harus cocok dengan predikat dari toolset. Jika tidak, error akan ditampilkan.
Kolom union `tool_execution_context`. Konteks tambahan yang akan diberikan untuk eksekusi alat `tool_execution_context` hanya dapat berupa salah satu dari berikut:
`variables`	`Struct` Opsional. Variabel yang tersedia untuk eksekusi alat.
`context`	`Struct` Opsional. [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment untuk mengetahui detailnya) yang akan diteruskan ke alat Python.

ExecuteToolResponse

Pesan respons untuk ToolService.ExecuteTool.

Kolom
`response`	`Struct` 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.
`variables`	`Struct` Nilai variabel di akhir eksekusi alat.
`citations`	`Citations` Kutipan yang memberikan informasi sumber untuk eksekusi alat.
`google_search_suggestions`	`GoogleSearchSuggestions` Saran yang ditampilkan dari Google Penelusuran sebagai hasil dari pemanggilan Alat Penelusuran Google selama eksekusi alat.
Kolom union `tool_identifier`. ID alat yang dieksekusi. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool`	`string` Nama alat yang dijalankan. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Alat toolset yang dieksekusi.

ExecutionType

Jenis eksekusi alat atau set alat.

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

ExperimentConfig

Eksperimen untuk deployment.

Kolom

version_release

Opsional. Rilis versi untuk eksperimen.

Negara Bagian

Status eksperimen.

Enum
`STATE_UNSPECIFIED`	Status tidak ditentukan.
`PENDING`	Tidak digunakan lagi: Status ini tidak digunakan lagi.
`RUNNING`	Status berjalan. Eksperimen sedang berjalan dan valid.
`DONE`	Tidak digunakan lagi: Status ini tidak digunakan lagi.
`EXPIRED`	Tidak digunakan lagi: Status ini tidak digunakan lagi.

VersionRelease

Rilis versi untuk eksperimen.

Kolom

state

ExperimentConfig.State

Opsional. Status rilis versi.

traffic_allocations[]

ExperimentConfig.VersionRelease.TrafficAllocation

Opsional. Alokasi traffic untuk rilis versi.

TrafficAllocation

Alokasi traffic untuk rilis versi.

Kolom

id

string

Opsional. ID alokasi traffic. String format bebas, hingga 128 karakter.

traffic_percentage

int32

Opsional. Persentase traffic dari alokasi traffic. Harus antara 0 dan 100.

app_version

string

Opsional. Versi aplikasi alokasi traffic. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

Pesan permintaan untuk AgentService.ExportApp.

Kolom
`name`	`string` Wajib. Nama resource aplikasi yang akan diekspor.
`export_format`	`ExportAppRequest.ExportFormat` Wajib. Format untuk mengekspor aplikasi.
`gcs_uri`	`string` Opsional. URI Google Cloud Storage tempat aplikasi akan diekspor. Format URI ini harus `gs://<bucket-name>/<object-name>`. Arsip aplikasi yang diekspor akan ditulis langsung ke objek GCS yang ditentukan.
`app_version`	`string` Opsional. Nama resource versi aplikasi yang akan diekspor. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`.

ExportFormat

Format ekspor untuk aplikasi.

Enum
`EXPORT_FORMAT_UNSPECIFIED`	Format ekspor tidak ditentukan.
`JSON`	Format ekspornya adalah JSON.
`YAML`	Format ekspor adalah YAML.

ExportAppResponse

Pesan respons untuk AgentService.ExportApp.

Kolom

Kolom union app. Aplikasi yang diekspor. app hanya dapat berupa salah satu dari berikut:

app_content

bytes

Folder aplikasi dikompresi sebagai file zip.

app_uri

string

URI Google Cloud Storage tempat aplikasi diekspor.

ExportEvaluationResultsOperationMetadata

Jenis ini tidak memiliki kolom.

Metadata operasi untuk EvaluationService.ExportEvaluationResults.

ExportEvaluationResultsRequest

Pesan permintaan untuk EvaluationService.ExportEvaluationResults.

Kolom

parent

string

Wajib. Nama resource evaluasi untuk mengekspor hasil evaluasi. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

names[]

string

Wajib. Nama resource hasil evaluasi yang akan diekspor.

export_options

ExportOptions

Opsional. Opsi ekspor untuk hasil evaluasi.

ExportEvaluationResultsResponse

Pesan respons untuk EvaluationService.ExportEvaluationResults.

Kolom

Kolom union evaluation_results. Hasil evaluasi yang diekspor. evaluation_results hanya ada berupa salah satu diantara berikut:

evaluation_results_content

bytes

Konten Hasil Evaluasi yang diekspor. Kolom ini akan diisi jika gcs_uri tidak ditentukan dalam permintaan.

evaluation_results_uri

string

Folder URI Google Cloud Storage tempat Hasil Evaluasi yang diekspor ditulis. Kolom ini akan diisi jika gcs_uri ditentukan dalam permintaan.

ExportEvaluationRunsOperationMetadata

Jenis ini tidak memiliki kolom.

Metadata operasi untuk EvaluationService.ExportEvaluationRuns.

ExportEvaluationRunsRequest

Pesan permintaan untuk EvaluationService.ExportEvaluationRuns.

Kolom

parent

string

Wajib. Nama resource aplikasi yang akan diekspor dari evaluasi berjalan. Format: projects/{project}/locations/{location}/apps/{app}

names[]

string

Wajib. Nama resource dari proses evaluasi yang akan diekspor.

export_options

ExportOptions

Opsional. Opsi ekspor untuk proses evaluasi.

ExportEvaluationRunsResponse

Pesan respons untuk EvaluationService.ExportEvaluationRuns.

Kolom

Kolom union evaluation_runs. Evaluasi yang diekspor akan berjalan. evaluation_runs hanya ada berupa salah satu diantara berikut:

evaluation_runs_content

bytes

Konten Ekspor Evaluasi yang dijalankan. Kolom ini akan diisi jika gcs_uri tidak ditentukan dalam permintaan.

evaluation_runs_uri

string

Folder URI Google Cloud Storage tempat Evaluasi Berjalan yang diekspor ditulis. Kolom ini akan diisi jika gcs_uri ditentukan dalam permintaan.

ExportEvaluationsRequest

Pesan permintaan untuk EvaluationService.ExportEvaluations.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi yang akan diekspor evaluasinya. Format: `projects/{project}/locations/{location}/apps/{app}`
`names[]`	`string` Wajib. Nama resource evaluasi yang akan diekspor.
`export_options`	`ExportOptions` Opsional. Opsi ekspor untuk evaluasi.
`include_evaluation_results`	`bool` Opsional. Menyertakan hasil evaluasi dalam ekspor. Setidaknya salah satu dari include_evaluation_results atau include_evaluations harus ditetapkan.
`include_evaluations`	`bool` Opsional. Menyertakan evaluasi dalam ekspor. Setidaknya salah satu dari include_evaluation_results atau include_evaluations harus ditetapkan.

ExportEvaluationsResponse

Pesan respons untuk EvaluationService.ExportEvaluations.

Kolom
`failed_evaluations`	`map<string, string>` Hanya output. Peta nama resource evaluasi yang tidak dapat diekspor, beserta alasan kegagalannya.
Kolom union `evaluations`. Evaluasi yang diekspor. `evaluations` hanya ada berupa salah satu diantara berikut:
`evaluations_content`	`bytes` Konten Evaluasi yang diekspor. Kolom ini akan diisi jika gcs_uri tidak ditentukan dalam permintaan.
`evaluations_uri`	`string` Folder URI Google Cloud Storage tempat evaluasi yang diekspor ditulis. Kolom ini akan diisi jika gcs_uri ditentukan dalam permintaan.

ExportOptions

Opsi untuk mengekspor resource evaluasi CES.

Kolom

export_format

ExportOptions.ExportFormat

Opsional. Format untuk mengekspor hasil evaluasi. Jika tidak ditentukan, setelan defaultnya adalah JSON.

gcs_uri

string

Opsional. URI Google Cloud Storage untuk menulis Hasil Evaluasi yang diekspor.

ExportFormat

Format untuk mengekspor item. Jika tidak ditentukan, setelan defaultnya adalah JSON.

Enum
`EXPORT_FORMAT_UNSPECIFIED`	Format tidak ditentukan.
`JSON`	Format JSON.
`YAML`	Format YAML.

ExpressionCondition

Kondisi ekspresi berdasarkan status sesi.

Kolom

expression

string

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

FileContext

File yang akan digunakan sebagai konteks. File dapat diberikan sebagai byte mentah.

Kolom

Kolom union file. File yang diberikan sebagai konteks. file hanya ada berupa salah satu diantara berikut:

file_bytes

FileContext.FileBytes

Opsional. File yang diberikan sebagai byte mentah.

FileBytes

File yang diberikan sebagai byte mentah.

Kolom

file_name

string

Wajib. Nama file yang diberikan sebagai byte mentah.

mime_type

string

Wajib. Jenis MIME standar IANA dari data sumber.

data

bytes

Wajib. Byte mentah file.

FileSearchTool

Alat penelusuran file memungkinkan agen menelusuri file yang diupload oleh developer aplikasi/agen. Gemini memiliki preset untuk memberikan penelusuran berkualitas cukup baik atas file yang diupload dan ringkasan hasil yang diambil.

Kolom
`corpus_type`	`FileSearchTool.CorpusType` Opsional. Jenis korpus. Default-nya adalah FULLY_MANAGED.
`name`	`string` Wajib. Nama alat.
`description`	`string` Opsional. Deskripsi alat.
`file_corpus`	`string` Opsional. Korpus tempat file disimpan. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Jenis korpus RAG Vertex.

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

GenerateAppResourceOperationMetadata

Metadata operasi untuk AgentService.GenerateAppResource.

Kolom
`generation_type`	`GenerateAppResourceOperationMetadata.GenerationType` Hanya output. Jenis operasi.
`message`	`string` Hanya output. Status operasi yang dapat dibaca manusia, jika ada.
`create_time`	`Timestamp` Hanya output. Waktu pembuatan operasi.
`end_time`	`Timestamp` Hanya output. Waktu selesainya operasi.
`target`	`string` Hanya output. Nama resource aplikasi yang terkait dengan operasi. Format: `projects/{project}/locations/{location}/apps/{app}`.
`partial_errors[]`	`Status` Hanya output. Pesan error dari proses pembuatan resource.

GenerationType

Jenis operasi pembuatan.

Enum
`GENERATION_TYPE_UNSPECIFIED`	Jenis operasi tidak ditentukan.
`AGENT_RESTRUCTURE`	Jenis penataan ulang petunjuk agen.
`AGENT_REFINE`	Jenis penyempurnaan petunjuk agen.
`AGENT_CREATE`	Pembuatan agen dari jenis.
`TOOL_CREATE`	Jenis pembuatan alat.
`SCENARIO_CREATE`	Jenis pembuatan skenario.
`SCENARIO_CREATE_FROM_TRANSCRIPTS`	Pembuatan skenario dari jenis transkrip.
`EVALUATION_PERSONA_CREATE`	Jenis pembuatan persona evaluasi.
`QUALITY_REPORT_CREATE`	Jenis pembuatan laporan kualitas.
`INSTRUCTION_FOLLOWING_FIX`	Jenis perbaikan mengikuti petunjuk (digunakan untuk perbaikan pendakian bukit).

GenerateAppResourceRequest

Pesan permintaan untuk AgentService.GenerateAppResource.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk membuat resource.
`refine_instructions[]`	`GenerateAppResourceRequest.RefineInstructions` Opsional. Daftar petunjuk penyempurnaan yang akan digunakan untuk menyempurnakan resource.
`tool_generation_config`	`GenerateAppResourceRequest.ToolGenerationConfig` Opsional. Konfigurasi yang akan digunakan untuk membuat alat.
`app_generation_config`	`GenerateAppResourceRequest.AppGenerationConfig` Opsional. Konfigurasi yang akan digunakan untuk membuat agen dan alat.
`evaluation_generation_config`	`GenerateAppResourceRequest.EvaluationGenerationConfig` Opsional. Konfigurasi yang akan digunakan untuk membuat evaluasi.
`evaluation_personas_generation_config`	`GenerateAppResourceRequest.EvaluationPersonasGenerationConfig` Opsional. Konfigurasi yang akan digunakan untuk membuat persona evaluasi.
`quality_report_generation_config`	`GenerateAppResourceRequest.QualityReportGenerationConfig` Opsional. Konfigurasi yang akan digunakan untuk pembuatan laporan kualitas.
`hill_climbing_fix_config`	`GenerateAppResourceRequest.HillClimbingFixConfig` Opsional. Konfigurasi yang akan digunakan untuk perbaikan pendakian bukit.
Kolom union `resource`. Resource yang akan dibuat. `resource` hanya ada berupa salah satu diantara berikut:
`agent`	`Agent` Resource agen yang akan digunakan oleh asisten LLM, dapat dikosongkan untuk membuat agen baru.
`tool`	`Tool` Resource alat yang akan digunakan oleh asisten LLM, dapat kosong untuk membuat alat baru.
`toolset`	`Toolset` Resource toolset yang akan digunakan oleh asisten LLM, dapat kosong untuk membuat toolset baru.
`app_version_context`	`GenerateAppResourceRequest.AppVersionContext` Konteks versi aplikasi yang menentukan snapshot dasar dan agen target.

AppGenerationConfig

Konfigurasi yang akan digunakan untuk membuat aplikasi.

Kolom
`context`	`string` Opsional. Konteks yang menjelaskan persyaratan agen & alat yang akan dibuat.
`file_contexts[]`	`FileContext` Opsional. File yang akan digunakan sebagai konteks.
`dataset_id`	`string` Opsional. Set data insight yang akan digunakan untuk mengambil data percakapan guna membuat agen & alat. Format: `projects/{project}/locations/{location}/datasets/{dataset}`.
`generate_evaluations`	`bool` Opsional. Apakah akan membuat evaluasi untuk aplikasi. Jika benar (true), konteks yang diberikan akan digunakan untuk membuat data evaluasi.
`gcs_location`	`string` Opsional. Lokasi Cloud Storage untuk menyimpan data jawaban pertanyaan yang dihasilkan untuk digunakan oleh alat Datastore. Data ini hanya dibuat saat menggunakan data percakapan sebagai sumber input. Lokasi harus berada dalam project yang sama dengan aplikasi. Format: `gs://...`.

AppVersionContext

Konteks versi aplikasi yang menentukan snapshot dasar dan agen target.

Kolom

app_version

string

Nama resource versi aplikasi yang akan digunakan oleh asisten LLM. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

agent_resource_name

Algoritma yang akan digunakan untuk atribusi kerugian.

Enum
`LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED`	Tidak ditentukan.
`APP_CENTRIC`	Atribusi kerugian yang berpusat pada aplikasi. Memperlakukan aplikasi sebagai satu unit.
`AGENT_CENTRIC`	Atribusi kerugian yang berfokus pada agen. Mengatribusikan kerugian kepada setiap agen.

RefineInstructions

Petunjuk yang akan digunakan untuk menyempurnakan bagian resource. Bagian resource dapat ditentukan dengan indeks awal, indeks akhir, dan mask kolom. Misalnya, jika Anda ingin menyempurnakan bagian petunjuk agen, Anda dapat menentukan indeks karakter pertama petunjuk, indeks karakter terakhir petunjuk, dan mask kolom sebagai "instructions".

Kolom
`start_index`	`int64` Wajib. Karakter pertama (inklusif) dari teks yang akan disempurnakan.
`end_index`	`int64` Wajib. Karakter terakhir (inklusif) dari teks yang akan disempurnakan.
`field_mask`	`FieldMask` Wajib. Kolom resource yang disempurnakan. Hanya satu kolom yang diizinkan per RefineInstructions. Jika menyempurnakan petunjuk agen, mask kolom harus berupa "instructions".
`instructions`	`string` Wajib. Petunjuk untuk menyaring resource.

ToolGenerationConfig

Konfigurasi yang akan digunakan untuk membuat alat.

Kolom

context

string

Opsional. Konteks yang menjelaskan alat yang akan dibuat. Kolom ini dapat kosong jika permintaan & respons alat diberikan.

file_contexts[]

FileContext

Opsional. File yang akan digunakan sebagai konteks.

open_api_toolset_generation_config

GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig

Opsional. Konfigurasi yang akan digunakan untuk membuat skema Open API.

OpenApiToolsetGenerationConfig

Konfigurasi yang akan digunakan untuk membuat skema Open API.

Kolom

uri

string

Wajib. URI dasar alat.

operation_generation_configs[]

GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig.OperationGenerationConfig

Wajib. Daftar operasi yang akan ditambahkan ke skema Open API.

OperationGenerationConfig

Konfigurasi yang akan digunakan untuk membuat operasi dalam skema Open API.

Kolom
`method`	`string` Wajib. URI alat. Ini harus mencakup parameter kueri dan jalur jika ada.
`path`	`string` Wajib. Jalur alat yang akan ditambahkan ke URI dasar. Ini harus mencakup parameter kueri dan jalur jika ada.
`request_json`	`string` Wajib. Contoh permintaan ke alat dalam format JSON. Lewati jika alat tidak mendukung isi permintaan.
`response_json`	`string` Wajib. Contoh respons dari alat dalam format JSON.

GenerateAppResourceResponse

Pesan respons untuk AgentService.GenerateAppResource.

Kolom
`generate_result_info`	`GenerateAppResourceResponse.GenerateResultInfo` Informasi tambahan tentang hasil yang dihasilkan.
Kolom union `generated_resource`. Resource yang dibuat. `generated_resource` hanya ada berupa salah satu diantara berikut:
`agent`	`Agent` Agen yang dibuat oleh asisten LLM.
`toolset`	`Toolset` Toolset yang dihasilkan oleh asisten LLM. Mendukung pembuatan skema set alat Open API.
`app_snapshot`	`AppSnapshot` Snapshot aplikasi yang dibuat oleh asisten LLM. Snapshot ini berisi aplikasi, agen, dan alat yang dihasilkan oleh asisten LLM.
`tools`	`GenerateAppResourceResponse.Tools` Daftar alat yang dihasilkan oleh asisten LLM.
`evaluations`	`GenerateAppResourceResponse.Evaluations` Evaluasi yang dihasilkan oleh asisten LLM.
`app_resources`	`GenerateAppResourceResponse.AppResources` Resource aplikasi yang dihasilkan oleh asisten LLM.
`quality_report`	`QualityReport` Laporan kualitas yang dihasilkan oleh asisten LLM.

AppResources

Daftar resource aplikasi yang dihasilkan oleh asisten LLM.

Kolom

app_snapshot

AppSnapshot

Snapshot aplikasi yang dibuat oleh asisten LLM. Snapshot ini berisi aplikasi, agen, dan alat yang dihasilkan oleh asisten LLM.

evaluations[]

Evaluation

Daftar evaluasi yang dihasilkan oleh asisten LLM.

Evaluasi

Daftar evaluasi yang dihasilkan oleh asisten LLM.

Kolom

evaluations[]

Evaluation

Daftar evaluasi yang dihasilkan.

GenerateResultInfo

Tindakan ini memberikan informasi tambahan tentang hasil yang dihasilkan.

Kolom

explanation

string

Penjelasan tentang perubahan pada resource yang dihasilkan.

Alat

Daftar alat yang dihasilkan oleh asisten LLM.

Kolom

tools[]

Tool

Daftar alat yang dihasilkan oleh asisten LLM.

GenerateChatTokenRequest

Pesan permintaan untuk WidgetService.GenerateChatToken.

Kolom
`name`	`string` Wajib. Nama sesi untuk membuat token chat. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
`deployment`	`string` Wajib. Deployment aplikasi yang akan digunakan untuk sesi. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
`recaptcha_token`	`string` Opsional. Token reCAPTCHA yang dihasilkan oleh widget chat sisi klien.
`live_handoff_enabled`	`bool` Opsional. Menunjukkan apakah pengalihan langsung diaktifkan untuk sesi.

GenerateChatTokenResponse

Pesan respons untuk WidgetService.GenerateChatToken.

Kolom

chat_token

string

Token cakupan sesi untuk widget chat guna mengautentikasi dengan Session API.

expire_time

GenerateEvaluationRequest.EvaluationType

Waktu saat token chat berakhir masa berlakunya.

GenerateEvaluationOperationMetadata

Jenis ini tidak memiliki kolom.

Metadata operasi untuk EvaluationService.GenerateEvaluation.

GenerateEvaluationRequest

Pesan permintaan untuk EvaluationService.GenerateEvaluation.

Kolom

conversation

string

Wajib. Percakapan untuk membuat evaluasi standar. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

source
(deprecated)

Conversation.Source

Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, semua sumber akan ditelusuri.

evaluation_type

Opsional. Jenis evaluasi yang akan dibuat. Jika tidak ditentukan, setelan defaultnya adalah GOLDEN.

EvaluationType

Jenis evaluasi yang akan dibuat.

Enum
`EVALUATION_TYPE_UNSPECIFIED`	Jenis tidak ditentukan. Nilai defaultnya adalah GOLDEN.
`GOLDEN`	Evaluasi golden.
`SCENARIO`	Evaluasi skenario.

GetAgentRequest

Pesan permintaan untuk AgentService.GetAgent.

Kolom

name

string

Wajib. Nama resource agen yang akan diambil.

GetAppRequest

Pesan permintaan untuk AgentService.GetApp.

Kolom

name

string

Wajib. Nama resource aplikasi yang akan diambil.

GetAppVersionRequest

Pesan permintaan untuk AgentService.GetAppVersion.

Kolom

name

string

Wajib. Nama resource versi aplikasi yang akan diambil.

GetChangelogRequest

Pesan permintaan untuk AgentService.GetChangelog.

Kolom

name

string

Wajib. Nama resource log perubahan yang akan diambil.

GetConversationRequest

Pesan permintaan untuk AgentService.GetConversation.

Kolom

name

string

Wajib. Nama resource percakapan yang akan diambil.

source
(deprecated)

string

Wajib. Nama resource toolset yang akan diambil.

GoAway

Jenis ini tidak memiliki kolom.

Menunjukkan bahwa server akan segera terputus dan klien harus menutup sebagian dan memulai ulang koneksi.

GoldenRunMethod

Metode yang digunakan untuk menjalankan evaluasi.

Enum
`GOLDEN_RUN_METHOD_UNSPECIFIED`	Metode menjalankan tidak ditentukan.
`STABLE`	Jalankan evaluasi sebagai pemutaran ulang yang stabil, dengan setiap giliran merupakan sesi unik dengan giliran yang diharapkan sebelumnya disisipkan sebagai konteks.
`NAIVE`	Jalankan evaluasi sebagai pemutaran ulang naif, dengan menjalankan satu sesi tanpa konteks yang disisipkan.

GoogleSearchSuggestions

Saran penelusuran dari Google Search Tool.

Kolom

htmls[]

string

Gaya HTML dan CSS yang sesuai untuk saran penelusuran. HTML dan CSS yang disediakan akan otomatis menyesuaikan setelan perangkat Anda, ditampilkan dalam mode terang atau gelap yang ditunjukkan oleh @media(prefers-color-scheme).

web_search_queries[]

WebSearchQuery

Daftar kueri yang digunakan untuk melakukan penelusuran Google beserta URI hasil penelusuran yang membentuk saran penelusuran.

GoogleSearchTool

Menampilkan alat untuk melakukan penelusuran web Google untuk grounding. Lihat https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Kolom
`name`	`string` Wajib. Nama alat.
`description`	`string` Opsional. Deskripsi tujuan alat.
`context_urls[]`	`string` Opsional. Konten akan diambil langsung dari URL ini untuk konteks dan perujukan. Contoh: "https://example.com/path.html". Maksimum 20 URL yang diizinkan.
`preferred_domains[]`	`string` Opsional. Menentukan domain untuk membatasi hasil penelusuran. Contoh: "example.com", "another.site". Maksimum 20 domain dapat ditentukan.
`exclude_domains[]`	`string` Opsional. Daftar domain yang akan dikecualikan dari hasil penelusuran. Contoh: "example.com". Maksimum 2.000 domain dapat dikecualikan.
`prompt_config`	`GoogleSearchTool.PromptConfig` Opsional. Petunjuk perintah yang diteruskan ke perencana tentang cara hasil penelusuran harus diproses untuk teks dan suara.

PromptConfig

Setelan perintah yang digunakan oleh model saat memproses atau meringkas hasil penelusuran Google.

Kolom

text_prompt

string

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

voice_prompt

string

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

Pagar pengaman

Pembatasan berisi daftar pemeriksaan dan keseimbangan untuk menjaga keamanan agen.

Kolom
`name`	`string` ID. ID unik pembatas. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
`display_name`	`string` Wajib. Nama tampilan pembatas.
`description`	`string` Opsional. Deskripsi pembatasan.
`enabled`	`bool` Opsional. Apakah pembatasan diaktifkan atau tidak.
`action`	`TriggerAction` Opsional. Tindakan yang harus diambil saat batasan pengaman dipicu.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat pembatasan dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat batas keamanan terakhir diperbarui.
`etag`	`string` ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
Kolom union `guardrail_type`. Jenis pembatasan. `guardrail_type` hanya ada berupa salah satu diantara berikut:
`content_filter`	`Guardrail.ContentFilter` Opsional. Pembatasan yang melarang penggunaan konten tertentu dalam percakapan.
`llm_prompt_security`	`Guardrail.LlmPromptSecurity` Opsional. Pembatas yang memblokir percakapan jika perintah dianggap tidak aman berdasarkan klasifikasi LLM.
`llm_policy`	`Guardrail.LlmPolicy` Opsional. Penjaga yang memblokir percakapan jika respons LLM dianggap melanggar kebijakan berdasarkan klasifikasi LLM.
`model_safety`	`Guardrail.ModelSafety` Opsional. Membatasi percakapan jika respons LLM dianggap tidak aman berdasarkan setelan keamanan model.
`code_callback`	`Guardrail.CodeCallback` Opsional. Pembatas yang berpotensi memblokir percakapan berdasarkan hasil eksekusi callback.
`supervisor`	`Guardrail.Supervisor` Opsional. Pedoman keamanan yang menjalankan intervensi supervisor.

CodeCallback

Pembatas yang memblokir percakapan berdasarkan callback kode yang diberikan.

Kolom
`before_agent_callback`	`Callback` Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'PICU' dapat menghentikan pemrosesan lebih lanjut.
`after_agent_callback`	`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 'PICU' dapat menghentikan pemrosesan lebih lanjut.
`before_model_callback`	`Callback` Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'PICU' dapat menghentikan pemrosesan lebih lanjut.
`after_model_callback`	`Callback` Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'PICU' dapat menghentikan pemrosesan lebih lanjut.

ContentFilter

Pembatasan yang melarang penggunaan konten tertentu dalam percakapan.

Kolom
`banned_contents[]`	`string` Opsional. Daftar frasa yang dilarang. Berlaku untuk input pengguna dan respons agen.
`banned_contents_in_user_input[]`	`string` Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk input pengguna.
`banned_contents_in_agent_response[]`	`string` Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk respons agen.
`match_type`	`Guardrail.ContentFilter.MatchType` Wajib. Jenis pencocokan untuk filter konten.
`disregard_diacritics`	`bool` Opsional. Jika benar (true), diakritik akan diabaikan selama pencocokan.

MatchType

Jenis pencocokan untuk filter konten.

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

LlmPolicy

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

Kolom
`max_conversation_messages`	`int32` Opsional. Saat memeriksa kebijakan ini, pertimbangkan 'n' pesan terakhir dalam percakapan. Jika tidak ditetapkan, nilai default 10 akan digunakan.
`model_settings`	`ModelSettings` Opsional. Setelan model.
`prompt`	`string` Wajib. Perintah kebijakan.
`policy_scope`	`Guardrail.LlmPolicy.PolicyScope` Wajib. Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan. Jika disetel ke `POLICY_SCOPE_UNSPECIFIED`, kebijakan akan diterapkan ke input pengguna. Saat menerapkan kebijakan ke respons agen, latensi tambahan akan terjadi sebelum agen dapat merespons.
`fail_open`	`bool` Opsional. Jika terjadi error selama pemeriksaan kebijakan, buka dan jangan memicu batasan pengaman.
`allow_short_utterance`	`bool` Opsional. Secara default, pemeriksaan kebijakan LLM dilewati untuk ucapan singkat. Mengaktifkan setelan ini akan menerapkan pemeriksaan kebijakan ke semua ucapan, termasuk yang biasanya akan dilewati.

PolicyScope

Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan.

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

LlmPromptSecurity

Batasan yang memblokir percakapan jika input dianggap tidak aman berdasarkan klasifikasi LLM.

Kolom
`fail_open`	`bool` Opsional. Menentukan perilaku saat batasan pengaman mengalami error LLM. - Jika benar (true): batas aman dilewati. - Jika salah (default): pembatasan akan dipicu/diblokir. Catatan: Jika kebijakan kustom diberikan, kolom ini akan diabaikan dan digantikan oleh konfigurasi 'fail_open' kebijakan.
Kolom union `security_config`. Menentukan mode konfigurasi keamanan. Pengguna harus memilih salah satu konfigurasi berikut. `security_config` hanya ada berupa salah satu diantara berikut:
`default_settings`	`Guardrail.LlmPromptSecurity.DefaultSecuritySettings` Opsional. Menggunakan setelan keamanan default bawaan sistem. Untuk memilih mode ini, sertakan pesan 'default_settings' kosong dalam permintaan. Kolom 'default_prompt_template' di dalamnya akan diisi oleh server dalam respons.
`custom_policy`	`Guardrail.LlmPolicy` Opsional. Gunakan LlmPolicy yang ditentukan pengguna untuk mengonfigurasi pembatasan keamanan.

DefaultSecuritySettings

Konfigurasi untuk setelan keamanan sistem default.

Kolom

default_prompt_template

string

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

ModelSafety

Penggantian setelan keamanan model. Jika disetel, setelan ini akan menggantikan setelan default dan memicu pembatasan jika respons dianggap tidak aman.

Kolom

safety_settings[]

Guardrail.ModelSafety.SafetySetting

Wajib. Daftar setelan keamanan.

HarmBlockThreshold

Tingkat nilai minimum berbasis probabilitas untuk pemblokiran.

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

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 bahayanya adalah kata-kata tidak sopan.
`HARM_CATEGORY_TOXIC`	Kategori bahayanya adalah beracun.

SafetySetting

Setelan keamanan.

Kolom

category

Guardrail.ModelSafety.HarmCategory

Wajib. Kategori bahaya.

threshold

Guardrail.ModelSafety.HarmBlockThreshold

Wajib. Batas blokir bahaya.

Supervisor

Pedoman keamanan yang menjalankan intervensi supervisor.

Kolom

type

Guardrail.Supervisor.Type

Opsional. Jenis pengawas.

detection_mode

Guardrail.Supervisor.DetectionMode

Opsional. Mode deteksi pengawas.

DetectionMode

Mode deteksi pengawas.

Enum
`DETECTION_MODE_UNSPECIFIED`	Mode deteksi tidak ditentukan. Defaultnya adalah NON_BLOCKING.
`NON_BLOCKING`	Mode deteksi tidak memblokir. Respons tidak diblokir saat deteksi supervisor sedang berlangsung.
`BLOCKING`	Mode deteksi pemblokiran. Respons diblokir saat deteksi supervisor sedang berlangsung.

Jenis

Jenis pengawas.

Enum
`TYPE_UNSPECIFIED`	Jenis tidak ditentukan.
`INVALID_TEXT`	Jenis masalah teks tidak valid.
`LANGUAGE_SHIFT`	Jenis masalah pergeseran bahasa.
`SPEAKER_SHIFT`	Jenis masalah perubahan pembicara.
`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.

Gambar

Menampilkan input atau output gambar dalam percakapan.

Kolom

mime_type

string

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

data

bytes

Wajib. Byte mentah gambar.

alt_text

string

Opsional. Teks alternatif untuk gambar.

ImportAppRequest

Pesan permintaan untuk AgentService.ImportApp.

Kolom
`parent`	`string` Wajib. Nama resource induk dengan lokasi aplikasi yang akan diimpor.
`display_name`	`string` Opsional. Nama tampilan aplikasi yang akan diimpor. * Jika aplikasi dibuat saat diimpor, dan nama tampilannya ditentukan, aplikasi yang diimpor akan menggunakan nama tampilan ini. Jika konflik terdeteksi dengan aplikasi yang ada, stempel waktu akan ditambahkan ke nama tampilan agar unik. * Jika aplikasi adalah impor ulang, kolom ini tidak boleh disetel. Memberikan nama tampilan selama impor ulang akan menghasilkan error INVALID_ARGUMENT.
`app_id`	`string` Opsional. ID yang akan digunakan untuk aplikasi yang diimpor. * Jika tidak ditentukan, ID unik akan otomatis ditetapkan untuk aplikasi. * Jika tidak, aplikasi yang diimpor akan menggunakan ID ini sebagai komponen akhir dari nama resource-nya. Jika aplikasi dengan ID yang sama sudah ada di lokasi yang ditentukan dalam project, konten aplikasi yang ada akan diganti.
`import_options`	`ImportAppRequest.ImportOptions` Opsional. Opsi yang mengatur proses impor untuk aplikasi.
`ignore_app_lock`	`bool` Opsional. Flag untuk mengganti kunci aplikasi selama impor. Jika disetel ke benar (true), proses impor akan mengabaikan kunci aplikasi.
Kolom union `app`. Aplikasi yang akan diimpor. `app` hanya ada berupa salah satu diantara berikut:
`gcs_uri`	`string` URI Google Cloud Storage tempat aplikasi akan diimpor. Format URI ini harus `gs://<bucket-name>/<object-name>`.
`app_content`	`bytes` Byte mentah yang merepresentasikan file ZIP terkompresi dengan struktur folder aplikasi.
Kolom union `json_patch`. Patch JSON yang akan diterapkan ke aplikasi yang diimpor. `json_patch` hanya dapat berupa salah satu dari berikut ini:
`json_patch_content`	`string` Opsional. Membuat patch konten sebagai string JSON.
`json_patch_gcs_uri`	`string` Opsional. Cloud Storage URI yang mengarah ke file JSON yang berisi patch.

ImportOptions

Opsi konfigurasi untuk proses impor aplikasi. Opsi ini mengontrol cara kerja impor, terutama saat terjadi konflik dengan data aplikasi yang ada.

Kolom

conflict_resolution_strategy

ImportAppRequest.ImportOptions.ConflictResolutionStrategy

Opsional. Strategi yang akan digunakan saat menyelesaikan konflik selama impor.

validate_only

bool

Opsional. Tanda untuk menjalankan proses impor uji coba. Jika disetel ke benar (true), proses impor hanya akan melakukan validasi dan tidak akan membuat perubahan apa pun pada aplikasi yang ada atau membuat aplikasi baru.

ConflictResolutionStrategy

Menentukan strategi untuk menangani konflik saat aplikasi dengan ID yang sama sudah ada, atau saat resource yang diimpor (seperti Agen, Alat, dll.) memiliki nama tampilan yang sama dengan resource yang ada dalam aplikasi tersebut.

Enum
`CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED`	Strategi resolusi konflik tidak ditentukan.
`REPLACE`	Mengganti data yang ada dengan data yang diimpor. Jika aplikasi dengan `app_id` yang sama sudah ada, kontennya akan diperbarui berdasarkan aplikasi yang diimpor. - Resource (Aplikasi, Agen, Alat, Contoh, Batas Keamanan, Kumpulan Alat) di aplikasi yang diimpor yang memiliki nama tampilan yang sama dengan resource yang ada akan menggantikan resource yang ada. - Resource yang diimpor dengan nama tampilan baru akan dibuat. - Resource yang ada yang tidak memiliki nama tampilan yang cocok di aplikasi yang diimpor tidak akan diubah.
`OVERWRITE`	Menimpa data yang ada dengan data yang diimpor. Jika aplikasi dengan `app_id` yang sama sudah ada, kontennya akan ditimpa dengan aplikasi yang diimpor. - Resource yang ada (Agen, Alat, Contoh, Batas, Kumpulan Alat) di aplikasi akan dihapus. - Resource yang diimpor akan dibuat sebagai resource baru.

ImportAppResponse

Pesan respons untuk AgentService.ImportApp.

Kolom

name

string

Nama resource aplikasi yang diimpor.

warnings[]

string

Pesan peringatan yang dihasilkan selama proses impor. Jika terjadi error untuk resource tertentu, resource tersebut tidak akan disertakan dalam aplikasi yang diimpor dan error akan disebutkan di sini.

ImportEvaluationsOperationMetadata

Mewakili metadata operasi yang berjalan lama untuk EvaluationService.ImportEvaluations.

Kolom

create_time

Hanya output. Waktu pembuatan operasi.

end_time

ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy

Hanya output. Waktu selesainya operasi.

status_message

string

Hanya output. Status operasi yang dapat dibaca manusia, jika ada.

ImportEvaluationsRequest

Pesan permintaan untuk EvaluationService.ImportEvaluations.

Kolom
`parent`	`string` Wajib. Aplikasi untuk mengimpor evaluasi. Format: `projects/{project}/locations/{location}/apps/{app}`
`import_options`	`ImportEvaluationsRequest.ImportOptions` Opsional. Opsi yang mengatur proses impor untuk evaluasi.
Kolom union `source`. Sumber evaluasi yang akan diimpor. `source` hanya ada berupa salah satu diantara berikut:
`conversation_list`	`ImportEvaluationsRequest.ConversationList` Percakapan untuk mengimpor evaluasi.
`gcs_uri`	`string` URI Google Cloud Storage tempat evaluasi akan diimpor. Format URI ini harus `gs://<bucket-name>/<object-name>`.
`csv_content`	`bytes` Byte mentah yang merepresentasikan file CSV dengan struktur evaluasi.

ConversationList

Daftar nama resource percakapan.

Kolom

conversations[]

string

Opsional. Nama resource percakapan.

ImportOptions

Opsi konfigurasi untuk proses impor evaluasi. Opsi ini mengontrol perilaku impor, terutama saat terjadi konflik dengan data evaluasi yang ada.

Kolom

conflict_resolution_strategy

Opsional. Strategi yang akan digunakan saat menyelesaikan konflik selama impor.

ConflictResolutionStrategy

Menentukan strategi untuk menangani konflik saat evaluasi dengan ID evaluasi yang sama sudah ada di aplikasi.

Enum
`CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED`	Strategi resolusi konflik tidak ditentukan.
`OVERWRITE`	Menimpa evaluasi yang ada dengan yang baru.
`SKIP`	Mempertahankan evaluasi yang ada dan melewati evaluasi baru.
`DUPLICATE`	Pertahankan evaluasi yang ada dan duplikasikan evaluasi baru sebagai evaluasi baru.

ImportEvaluationsResponse

Pesan respons untuk EvaluationService.ImportEvaluations.

Kolom
`evaluations[]`	`Evaluation` Daftar evaluasi yang diimpor ke dalam aplikasi.
`evaluation_results[]`	`EvaluationResult` Daftar hasil evaluasi yang diimpor ke aplikasi.
`evaluation_runs[]`	`EvaluationRun` Daftar proses evaluasi yang diimpor ke dalam aplikasi.
`error_messages[]`	`string` Opsional. Daftar pesan error yang terkait dengan evaluasi yang gagal diimpor.
`import_failure_count`	`int32` Jumlah evaluasi yang gagal diimpor sepenuhnya atau selesai diimpor dengan satu atau beberapa error.
`evaluation_result_import_failure_count`	`int32` Jumlah hasil evaluasi yang gagal diimpor sepenuhnya atau menyelesaikan impor dengan satu atau beberapa error.
`evaluation_run_import_failure_count`	`int32` Jumlah proses evaluasi yang gagal diimpor sepenuhnya atau menyelesaikan impor dengan satu atau beberapa error.

InputAudioConfig

InputAudioConfig mengonfigurasi cara agen CES harus menafsirkan data audio yang masuk.

Kolom

audio_encoding

AudioEncoding

Wajib. Encoding data audio input.

sample_rate_hertz

int32

Wajib. Frekuensi sampel (dalam Hertz) data audio input.

noise_suppression_level

string

Opsional. Apakah akan mengaktifkan peredam bising pada audio input. Nilai yang tersedia adalah "low", "moderate", "high", "very_high".

InstagramCredentials

Kredensial Meta efemeral untuk integrasi native Instagram.

Kolom

auth_code

string

Wajib. Kode autentikasi Meta yang disediakan oleh alur pendaftaran tersemat.

conversation_profile_id

string

Opsional. ID Profil Percakapan yang akan digunakan untuk deployment.

InterruptionSignal

Menunjukkan bahwa respons audio agen telah terganggu. Klien harus segera menghentikan pemutaran audio saat ini (misalnya, karena pengguna menyela atau respons agen baru sedang dibuat).

Kolom

barge_in

bool

Apakah interupsi disebabkan oleh peristiwa penyelaan pengguna.

LanguageSettings

Setelan bahasa aplikasi.

Kolom
`default_language_code`	`string` Opsional. Kode bahasa default aplikasi.
`supported_language_codes[]`	`string` Opsional. Daftar kode bahasa yang didukung oleh aplikasi, selain `default_language_code`.
`enable_multilingual_support`	`bool` Opsional. Mengaktifkan dukungan multibahasa. Jika benar (true), agen di aplikasi akan menggunakan petunjuk bawaan untuk meningkatkan penanganan input multibahasa.
`fallback_action (deprecated)`	`string` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: Fitur ini tidak lagi didukung. Gunakan `enable_multilingual_support` sebagai gantinya untuk meningkatkan penanganan input multibahasa. Tindakan yang harus dilakukan saat agen menerima input dalam bahasa yang tidak didukung. Tindakan ini dapat berupa tindakan standar atau panggilan alat kustom. Nilai yang valid adalah: - Nama lengkap resource alat, yang memicu eksekusi alat tertentu. - Tindakan sistem yang telah ditentukan sebelumnya, seperti "eskalasikan" atau "keluar", yang memicu sinyal `EndSession` dengan `metadata` yang sesuai untuk mengakhiri percakapan.

LatencyReport

Laporan latensi untuk proses evaluasi.

Kolom
`tool_latencies[]`	`LatencyReport.ToolLatency` Hanya output. Daftar yang tidak diurutkan. Metrik latensi untuk setiap alat.
`callback_latencies[]`	`LatencyReport.CallbackLatency` Hanya output. Daftar yang tidak diurutkan. Metrik latensi untuk setiap callback.
`guardrail_latencies[]`	`LatencyReport.GuardrailLatency` Hanya output. Daftar yang tidak diurutkan. Metrik latensi untuk setiap pembatas.
`llm_call_latencies[]`	`LatencyReport.LlmCallLatency` Hanya output. Daftar yang tidak diurutkan. Metrik latensi untuk setiap panggilan LLM.
`session_count`	`int32` Hanya output. Jumlah total sesi yang dipertimbangkan dalam laporan latensi.

CallbackLatency

Metrik latensi untuk satu callback.

Kolom

stage

string

Hanya output. Tahap callback.

latency_metrics

LatencyReport.LatencyMetrics

Hanya output. Metrik latensi untuk callback.

GuardrailLatency

Metrik latensi untuk satu pembatasan.

Kolom

guardrail

string

Hanya output. Nama pembatas. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}.

guardrail_display_name

string

Hanya output. Nama tampilan pembatas.

latency_metrics

LatencyReport.LatencyMetrics

Hanya output. Metrik latensi untuk pembatasan.

LatencyMetrics

Metrik latensi untuk komponen.

Kolom
`p50_latency`	`Duration` Hanya output. Latensi persentil ke-50.
`p90_latency`	`Duration` Hanya output. Latensi persentil ke-90.
`p99_latency`	`Duration` Hanya output. Latensi persentil ke-99.
`call_count`	`int32` Hanya output. Frekuensi resource dipanggil.

LlmCallLatency

Metrik latensi untuk satu panggilan LLM.

Kolom

model

string

Hanya output. Nama model.

latency_metrics

LatencyReport.LatencyMetrics

Hanya output. Metrik latensi untuk panggilan LLM.

ToolLatency

Metrik latensi untuk satu alat.

Kolom
`tool_display_name`	`string` Hanya output. Nama tampilan alat.
`latency_metrics`	`LatencyReport.LatencyMetrics` Hanya output. Metrik latensi untuk alat.
Kolom union `tool_identifier`. ID alat. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool`	`string` Hanya output. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`.
`toolset_tool`	`ToolsetTool` Hanya output. ID alat toolset.

ListAgentsRequest

Pesan permintaan untuk AgentService.ListAgents.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan agen.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListAgents` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan agen. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListAgentsResponse

Pesan respons untuk AgentService.ListAgents.

Kolom

agents[]

Agent

Daftar agen.

next_page_token

string

Token yang dapat dikirim sebagai ListAgentsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListAppVersionsRequest

Pesan permintaan untuk AgentService.ListAppVersions.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi yang akan mencantumkan versi aplikasi.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListAppVersions` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan versi aplikasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListAppVersionsResponse

Pesan respons untuk AgentService.ListAppVersions.

Kolom

app_versions[]

AppVersion

Daftar versi aplikasi.

next_page_token

string

Token yang dapat dikirim sebagai ListAppVersionsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListAppsRequest

Pesan permintaan untuk AgentService.ListApps.

Kolom
`parent`	`string` Wajib. Nama resource lokasi tempat aplikasi akan dicantumkan.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListApps` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan aplikasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListAppsResponse

Pesan respons untuk AgentService.ListApps.

Kolom

apps[]

App

Daftar aplikasi.

next_page_token

string

Token yang dapat dikirim sebagai ListAppsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

unreachable[]

string

Daftar yang tidak diurutkan. Lokasi yang tidak dapat dijangkau.

ListChangelogsRequest

Pesan permintaan untuk AgentService.ListChangelogs.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan log perubahannya.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListChangelogs` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan log perubahan. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya. String filter dapat digunakan untuk memfilter menurut `action`, `resource_type`, `resource_name`, `author`, dan `create_time`. Pembanding `:` dapat digunakan untuk pencocokan sebagian yang tidak peka huruf besar/kecil pada kolom string, sedangkan `=` melakukan pencocokan persis yang peka huruf besar/kecil. Contoh: * `action:update` (kecocokan parsial tidak peka huruf besar/kecil) * `action="Create"` (kecocokan persis peka huruf besar/kecil) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time > "2025-01-01T00:00:00Z"` * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool`
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListChangelogsResponse

Pesan respons untuk AgentService.ListChangelogs.

Kolom

changelogs[]

Changelog

Daftar log perubahan.

next_page_token

string

Token yang dapat dikirim sebagai ListChangelogsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListConversationsRequest

Pesan permintaan untuk AgentService.ListConversations.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan percakapan.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListConversations` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan percakapan. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`source`	`Conversation.Source` Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, Source.Live akan diterapkan secara default. Tidak akan digunakan lagi dan digantikan dengan kolom `sources`.
`sources[]`	`Conversation.Source` Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, semua sumber yang tersedia akan diterapkan secara default.

ListConversationsResponse

Pesan respons untuk AgentService.ListConversations.

Kolom

conversations[]

Conversation

Daftar percakapan.

next_page_token

string

Token yang dapat dikirim sebagai ListConversationsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListDeploymentsRequest

Pesan permintaan untuk AgentService.ListDeployments.

Kolom
`parent`	`string` Wajib. Aplikasi induk. Format: `projects/{project}/locations/{location}/apps/{app}`
`page_size`	`int32` Opsional. Jumlah maksimum deployment yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 50 deployment akan ditampilkan. Nilai maksimum adalah 1.000; nilai di atas 1.000 akan dikonversi menjadi 1.000.
`page_token`	`string` Opsional. Token halaman, yang diterima dari panggilan `ListDeployments` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk `ListDeployments` harus sesuai dengan panggilan yang memberikan token halaman.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListDeploymentsResponse

Pesan respons untuk AgentService.ListDeployments.

Kolom

deployments[]

Deployment

Daftar deployment.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListEvaluationDatasetsRequest

Pesan permintaan untuk EvaluationService.ListEvaluationDatasets.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan set data evaluasi.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `EvaluationService.ListEvaluationDatasets` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan set data evaluasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name", "create_time", dan "update_time" yang didukung. Kolom waktu diurutkan dalam urutan menurun, dan kolom nama diurutkan dalam urutan menaik. Jika tidak disertakan, "update_time" akan menjadi default. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListEvaluationDatasetsResponse

Pesan respons untuk EvaluationService.ListEvaluationDatasets.

Kolom

evaluation_datasets[]

EvaluationDataset

Daftar set data evaluasi.

next_page_token

string

Token yang dapat dikirim sebagai ListEvaluationDatasetsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListEvaluationExpectationsRequest

Pesan permintaan untuk EvaluationService.ListEvaluationExpectations.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan ekspektasi evaluasi.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `EvaluationService.ListEvaluationExpectations` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan ekspektasi evaluasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name", "create_time", dan "update_time" yang didukung. Kolom waktu diurutkan dalam urutan menurun, dan kolom nama diurutkan dalam urutan menaik. Jika tidak disertakan, "update_time" akan menjadi default. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListEvaluationExpectationsResponse

Pesan respons untuk EvaluationService.ListEvaluationExpectations.

Kolom

evaluation_expectations[]

EvaluationExpectation

Daftar ekspektasi evaluasi.

next_page_token

string

Token yang dapat dikirim sebagai ListEvaluationExpectationsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListEvaluationResultsRequest

Pesan permintaan untuk EvaluationService.ListEvaluationResults.

Kolom
`parent`	`string` Wajib. Nama resource evaluasi untuk mencantumkan hasil evaluasi. Untuk memfilter menurut proses evaluasi, gunakan `-` sebagai ID evaluasi dan tentukan ID proses evaluasi dalam filter. Contoh: `projects/{project}/locations/{location}/apps/{app}/evaluations/-`
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `EvaluationService.ListEvaluationResults` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan hasil evaluasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name", "create_time", dan "update_time" yang didukung. Kolom waktu diurutkan dalam urutan menurun, dan kolom nama diurutkan dalam urutan menaik. Jika tidak disertakan, "update_time" akan menjadi default. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListEvaluationResultsResponse

Pesan respons untuk EvaluationService.ListEvaluationResults.

Kolom

evaluation_results[]

EvaluationResult

Daftar hasil evaluasi.

next_page_token

string

Token yang dapat dikirim sebagai ListEvaluationResultsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListEvaluationRunsRequest

Pesan permintaan untuk EvaluationService.ListEvaluationRuns.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan proses evaluasi.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `EvaluationService.ListEvaluationRuns` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan proses evaluasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name", "create_time", dan "update_time" yang didukung. Kolom waktu diurutkan dalam urutan menurun, dan kolom nama diurutkan dalam urutan menaik. Jika tidak disertakan, "update_time" akan menjadi default. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListEvaluationRunsResponse

Pesan respons untuk EvaluationService.ListEvaluationRuns.

Kolom

evaluation_runs[]

EvaluationRun

Daftar operasi evaluasi.

next_page_token

string

Token yang dapat dikirim sebagai ListEvaluationRunsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListEvaluationsRequest

Pesan permintaan untuk EvaluationService.ListEvaluations.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan evaluasi.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `EvaluationService.ListEvaluations` daftar sebelumnya.
`filter (deprecated)`	`string` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: Sebagai gantinya, gunakan evaluation_filter dan evaluation_run_filter.
`evaluation_filter`	`string` Opsional. Filter yang akan diterapkan pada evaluasi saat mencantumkan evaluasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya. Kolom yang didukung: evaluation_datasets
`evaluation_run_filter`	`string` Opsional. String filter untuk kolom pada resource EvaluationRun terkait. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya. Kolom yang didukung: create_time, initiated_by, app_version_display_name
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name", "create_time", dan "update_time" yang didukung. Kolom waktu diurutkan dalam urutan menurun, dan kolom nama diurutkan dalam urutan menaik. Jika tidak disertakan, "update_time" akan menjadi default. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.
`last_ten_results`	`bool` Opsional. Apakah akan menyertakan 10 hasil evaluasi terakhir untuk setiap evaluasi dalam respons.

ListEvaluationsResponse

Pesan respons untuk EvaluationService.ListEvaluations.

Kolom

evaluations[]

Evaluation

Daftar evaluasi.

next_page_token

string

Token yang dapat dikirim sebagai ListEvaluationsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListExamplesRequest

Pesan permintaan untuk AgentService.ListExamples.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan contoh.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListExamples` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan contoh. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListExamplesResponse

Pesan respons untuk AgentService.ListExamples.

Kolom

examples[]

Example

Daftar contoh.

next_page_token

string

Token yang dapat dikirim sebagai ListExamplesRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListGuardrailsRequest

Pesan permintaan untuk AgentService.ListGuardrails.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi yang akan mencantumkan batas keamanannya.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListGuardrails` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan batas aman. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListGuardrailsResponse

Pesan respons untuk AgentService.ListGuardrails.

Kolom

guardrails[]

Guardrail

Daftar batasan.

next_page_token

string

Token yang dapat dikirim sebagai ListGuardrailsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListScheduledEvaluationRunsRequest

Pesan permintaan untuk EvaluationService.ListScheduledEvaluationRuns.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan proses evaluasi terjadwal.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `EvaluationService.ListScheduledEvaluationRuns` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan proses evaluasi terjadwal. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya. Saat ini mendukung pemfilteran menurut: * request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Kolom yang didukung adalah: "name" (menaik), "create_time" (menurun), "update_time" (menurun), "next_scheduled_execution" (menaik), dan "last_completed_run.create_time" (menurun). Jika tidak disertakan, "update_time" akan menjadi default. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListScheduledEvaluationRunsResponse

Pesan respons untuk EvaluationService.ListScheduledEvaluationRuns.

Kolom

scheduled_evaluation_runs[]

ScheduledEvaluationRun

Daftar operasi evaluasi terjadwal.

next_page_token

string

Token yang dapat dikirim sebagai ListScheduledEvaluationRunsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListToolsRequest

Pesan permintaan untuk AgentService.ListTools.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan alat.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListTools` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan alat. Gunakan "include_system_tools=true" untuk menyertakan alat sistem dalam respons. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListToolsResponse

Pesan respons untuk AgentService.ListTools.

Kolom

tools[]

Tool

Daftar alat.

next_page_token

string

Token yang dapat dikirim sebagai ListToolsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListToolsetsRequest

Pesan permintaan untuk AgentService.ListToolsets.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi untuk mencantumkan toolset.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
`page_token`	`string` Opsional. Nilai `next_page_token` yang ditampilkan dari panggilan `AgentService.ListToolsets` daftar sebelumnya.
`filter`	`string` Opsional. Filter yang akan diterapkan saat mencantumkan toolset. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
`order_by`	`string` Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListToolsetsResponse

Pesan respons untuk AgentService.ListToolsets.

Kolom

toolsets[]

Toolset

Daftar toolset.

next_page_token

string

Token yang dapat dikirim sebagai ListToolsetsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

LoggingSettings

Setelan untuk menjelaskan perilaku logging aplikasi.

Kolom
`redaction_config`	`RedactionConfig` Opsional. Konfigurasi cara data sensitif harus disamarkan.
`audio_recording_config`	`AudioRecordingConfig` Opsional. Konfigurasi cara interaksi audio harus direkam. Audio dapat disamarkan sesuai konfigurasi di `RedactionConfig`.
`unredacted_audio_recording_config`	`AudioRecordingConfig` Opsional. Mengonfigurasi rekaman tambahan audio yang tidak disamarkan. Salinan ini dapat digunakan untuk mempertahankan salinan audio mentah saat penyensoran audio `enabled`, biasanya untuk tujuan audit atau pemantauan.
`bigquery_export_settings`	`BigQueryExportSettings` Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan tunduk pada penyamaran seperti yang dikonfigurasi di `RedactionConfig`.
`unredacted_bigquery_export_settings`	`BigQueryExportSettings` Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan yang tidak disamarkan akan diekspor ke tabel BigQuery jika diaktifkan.
`cloud_logging_settings`	`CloudLoggingSettings` Opsional. Setelan untuk menjelaskan perilaku Cloud Logging untuk aplikasi.
`conversation_logging_settings`	`ConversationLoggingSettings` Opsional. Setelan untuk menjelaskan perilaku logging percakapan untuk aplikasi.
`evaluation_audio_recording_config`	`AudioRecordingConfig` Opsional. Konfigurasi cara interaksi audio harus direkam untuk evaluasi. Secara default, perekaman audio tidak diaktifkan untuk sesi evaluasi.
`metric_analysis_settings`	`MetricAnalysisSettings` Opsional. Setelan untuk menjelaskan perilaku pengumpulan data percakapan untuk pipeline analisis LLM untuk aplikasi.

McpTool

Alat MCP. Lihat https://modelcontextprotocol.io/specification/2025-06-18/server/tools untuk mengetahui detail selengkapnya.

Kolom
`name`	`string` Wajib. Nama alat MCP.
`name_override`	`string` Opsional. Penggantian nama alat MCP. Kolom ini diisi jika nama diganti oleh penggantian Toolset.
`description`	`string` Opsional. Deskripsi alat MCP.
`input_schema`	`Schema` Opsional. Skema argumen input alat MCP.
`output_schema`	`Schema` Opsional. Skema argumen output alat MCP.
`server_address`	`string` Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transportasi HTTP yang dapat di-streaming yang didukung. Hal ini sama dengan server_address di McpToolset. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
`api_authentication`	`ApiAuthentication` Opsional. Informasi autentikasi yang diperlukan untuk menjalankan alat terhadap server MCP. Untuk autentikasi token pembawa, token hanya berlaku untuk eksekusi alat, bukan untuk alat listingan. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi.
`tls_config`	`TlsConfig` Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
`service_directory_config`	`ServiceDirectoryConfig` Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
`custom_headers`	`map<string, 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.
`state`	`McpTool.State` Hanya output. Status ketersediaan dinamis alat di server eksternal.

Negara Bagian

Mewakili status ketersediaan dinamis alat.

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

McpToolDefinition

Penampung untuk elemen definisi inti alat yang diambil snapshotnya. Skema dalam snapshot digunakan sebagaimana adanya dan tidak dapat diganti.

Kolom

description

string

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

input_schema

Schema

Hanya output. Skema argumen input alat MCP.

output_schema

Schema

Hanya output. Skema argumen output alat MCP.

McpToolOverride

Penggantian yang terkait dengan alat tertentu dalam Toolset. Hal ini memungkinkan "penyematan" atau "penggantian" definisi alat dari server dinamis eksternal.

Kolom
`tool`	`string` Wajib. Nama asli alat sebagaimana dikeluarkan oleh server MCP.
`name_override`	`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 yang namanya kurang tepat.
`description_override`	`string` Opsional. Jika ada, alat ini akan menggunakan deskripsi ini, bukan deskripsi asli dari server.
`snapshot`	`McpToolDefinition` Hanya output. Jika ada, alat ini akan "Disematkan" dan menggunakan nilai snapshot sebagai penggantian jika server tidak tersedia untuk sementara atau jika tidak ada Penggantian.

McpToolset

Toolset yang berisi daftar alat yang ditawarkan oleh server MCP.

Kolom
`server_address`	`string` Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transportasi HTTP yang dapat di-streaming yang didukung. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
`api_authentication`	`ApiAuthentication` Opsional. Informasi autentikasi yang diperlukan untuk mengakses alat dan menjalankan alat terhadap server MCP. Untuk autentikasi token pembawa, token hanya berlaku untuk eksekusi alat, bukan untuk alat listingan. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi.
`service_directory_config`	`ServiceDirectoryConfig` Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
`tls_config`	`TlsConfig` Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
`custom_headers`	`map<string, 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.
`tool_overrides[]`	`McpToolOverride` Opsional. Penggantian untuk setiap alat dalam set alat ini. Hal ini memungkinkan penggantian detail tertentu seperti deskripsi, nama, atau menyematkan status alat sehingga tidak sepenuhnya dinamis.

Pesan

Pesan dalam percakapan.

Kolom

role

string

Opsional. Peran dalam percakapan, misalnya, pengguna, agen.

chunks[]

Chunk

Opsional. Konten pesan sebagai serangkaian potongan.

event_time

MockConfig.UnmatchedToolCallBehavior

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

MetricAnalysisSettings

Setelan untuk menjelaskan perilaku pengumpulan data percakapan untuk pipeline metrik analisis LLM.

Kolom

llm_metrics_opted_out

bool

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

MockConfig

Konfigurasi panggilan alat tiruan untuk sesi.

Kolom

mocked_tool_calls[]

MockedToolCall

Opsional. Semua panggilan alat yang akan di-mock selama durasi sesi.

unmatched_tool_call_behavior

Wajib. Perilaku untuk panggilan alat yang tidak cocok dengan pola argumen apa pun di mocked_tool_calls.

UnmatchedToolCallBehavior

Tindakan yang harus dilakukan saat panggilan alat tidak cocok dengan panggilan alat tiruan.

Enum
`UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED`	Nilai default. Nilai ini tidak digunakan.
`FAIL`	Menampilkan error untuk panggilan alat apa pun yang tidak cocok dengan pola input yang diharapkan tiruan.
`PASS_THROUGH`	Untuk panggilan alat yang tidak cocok, teruskan panggilan alat ke alat yang sebenarnya.

MockedToolCall

Panggilan alat tiruan.

Mengekspresikan alat target + pola untuk dicocokkan dengan argumen / input alat tersebut. Jika pola cocok, respons tiruan akan ditampilkan.

Kolom
`tool (deprecated)`	`string` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi. Gunakan tool_identifier sebagai gantinya.
`expected_args_pattern`	`Struct` Wajib. Pola untuk mencocokkan argumen / input dari semua panggilan alat yang dikirim. Jika input panggilan alat cocok dengan pola ini, output tiruan akan ditampilkan.
`mock_response`	`Struct` Opsional. Respons / output tiruan yang akan ditampilkan jika argumen / input panggilan alat cocok dengan pola.
Kolom union `tool_identifier`. ID alat yang akan di-mock. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool_id`	`string` Opsional. Nama alat yang akan di-mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset`	`ToolsetTool` Opsional. Kumpulan alat untuk membuat tiruan.

ModelSettings

Setelan model berisi berbagai konfigurasi untuk model LLM.

Kolom

model

string

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

thinking_level

ModelSettings.ThinkingLevel

Opsional. Tingkat penalaran model.

temperature

double

Opsional. Jika disetel, suhu ini akan digunakan untuk model LLM. Temperatur mengontrol keacakan respons model. Temperatur yang lebih rendah menghasilkan respons yang lebih dapat diprediksi. Temperatur yang lebih tinggi menghasilkan respons yang lebih kreatif.

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 pemikiran tinggi.

OAuthConfig

Konfigurasi untuk autentikasi dengan OAuth.

Kolom
`oauth_grant_type`	`OAuthConfig.OauthGrantType` Wajib. Jenis pemberian izin OAuth.
`client_id`	`string` Wajib. Client ID dari penyedia OAuth.
`client_secret_version`	`string` Wajib. Nama resource versi secret SecretManager yang menyimpan rahasia klien. Format: `projects/{project}/secrets/{secret}/versions/{version}` Catatan: Anda harus memberikan peran `roles/secretmanager.secretAccessor` kepada agen layanan CES `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`.
`token_endpoint`	`string` Wajib. Endpoint token di penyedia OAuth untuk ditukar dengan token akses.
`scopes[]`	`string` Opsional. Cakupan OAuth yang akan diberikan.

OauthGrantType

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

Enum
`OAUTH_GRANT_TYPE_UNSPECIFIED`	Tidak ditentukan. Nilai defaultnya adalah CLIENT_CREDENTIAL.
`CLIENT_CREDENTIAL`	Mewakili alur kredensial klien.

OpenApiTool

Alat API jarak jauh yang ditentukan oleh skema OpenAPI.

Kolom
`open_api_schema`	`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`.
`api_authentication`	`ApiAuthentication` Opsional. Informasi autentikasi yang diperlukan oleh API.
`tls_config`	`TlsConfig` Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang akan dipercayai klien.
`service_directory_config`	`ServiceDirectoryConfig` Opsional. Konfigurasi Service Directory.
`ignore_unknown_fields`	`bool` Opsional. Jika benar (true), agen akan mengabaikan kolom yang tidak diketahui dalam respons API.
`url`	`string` Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di alat dalam dependensi lingkungan selama proses ekspor jika skema berisi URL server. Selama proses impor, jika URL ini ada dalam dependensi lingkungan dan skema memiliki placeholder $env_var, URL ini akan menggantikan placeholder dalam skema.

OpenApiToolset

Toolset yang berisi daftar alat yang ditentukan oleh skema OpenAPI.

Kolom
`open_api_schema`	`string` Wajib. Skema OpenAPI toolset.
`api_authentication`	`ApiAuthentication` Opsional. Informasi autentikasi yang diperlukan oleh API.
`tls_config`	`TlsConfig` Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom
`service_directory_config`	`ServiceDirectoryConfig` Opsional. Konfigurasi Service Directory.
`ignore_unknown_fields`	`bool` Opsional. Jika benar, agen akan mengabaikan kolom yang tidak diketahui dalam respons API untuk semua operasi yang ditentukan dalam skema OpenAPI.
`url`	`string` Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di toolset dalam dependensi lingkungan selama proses ekspor jika skema berisi URL server. Selama proses impor, jika URL ini ada dalam dependensi lingkungan dan skema memiliki placeholder $env_var, URL ini akan menggantikan placeholder dalam skema.

OperationMetadata

Menampilkan metadata operasi yang berjalan lama.

Kolom
`create_time`	`Timestamp` Hanya output. Waktu pembuatan operasi.
`end_time`	`Timestamp` Hanya output. Waktu selesainya operasi.
`status_message`	`string` Hanya output. Status operasi yang dapat dibaca manusia, jika ada.
`requested_cancellation`	`bool` Hanya output. Mengidentifikasi apakah pengguna telah meminta pembatalan operasi. Operasi yang berhasil dibatalkan memiliki nilai `google.longrunning.Operation.error` dengan `google.rpc.Status.code` `1`, yang sesuai dengan `Code.CANCELLED`.

OptimizationConfig

Konfigurasi untuk menjalankan langkah pengoptimalan setelah menjalankan evaluasi.

Kolom
`generate_loss_report`	`bool` Opsional. Apakah akan membuat laporan kehilangan.
`assistant_session`	`string` Hanya output. Sesi asisten yang akan digunakan untuk pengoptimalan berdasarkan proses evaluasi ini. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}`
`report_summary`	`string` Hanya output. Ringkasan laporan kehilangan.
`should_suggest_fix`	`bool` Hanya output. Apakah akan menyarankan perbaikan untuk kerugian.
`status`	`OptimizationConfig.OptimizationStatus` Hanya output. Status proses pengoptimalan.
`error_message`	`string` Hanya output. Pesan error jika proses pengoptimalan gagal.
`loss_report`	`Struct` Hanya output. Laporan kerugian yang dibuat.

OptimizationStatus

Status proses pengoptimalan.

Enum
`OPTIMIZATION_STATUS_UNSPECIFIED`	Status pengoptimalan tidak ditentukan.
`RUNNING`	Pengoptimalan sedang berjalan.
`COMPLETED`	Pengoptimalan telah selesai.
`ERROR`	Pengoptimalan gagal karena error internal.

OutputAudioConfig

OutputAudioConfig mengonfigurasi cara agen CES harus menyintesis respons audio keluar.

Kolom

audio_encoding

AudioEncoding

Wajib. Encoding data audio output.

sample_rate_hertz

int32

Wajib. Frekuensi sampel (dalam Hertz) data audio output.

PersonaRunConfig

Konfigurasi untuk menjalankan evaluasi untuk persona tertentu.

Kolom

persona

string

Opsional. Persona yang akan digunakan untuk evaluasi. Format: projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}

task_count

int32

Opsional. Jumlah tugas yang akan dijalankan untuk persona.

PythonCodeCondition

Blok kode Python untuk mengevaluasi kondisi.

Kolom

python_code

string

Wajib. Kode python yang akan dieksekusi.

PythonFunction

Alat fungsi Python.

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.
`python_code`	`string` Opsional. Kode Python yang akan dieksekusi untuk alat.
`description`	`string` Hanya output. Deskripsi fungsi Python, diuraikan dari docstring kode python.
`service_directory_config`	`ServiceDirectoryConfig` Opsional. Konfigurasi Service Directory untuk alat.

QualityReport

Laporan yang menjelaskan masalah kualitas yang teridentifikasi dalam aplikasi.

Kolom

issues[]

QualityReport.AgentIssues

Opsional. Masalah yang dikelompokkan menurut agen.

evaluation_runs[]

string

Opsional. Daftar proses evaluasi yang digunakan untuk membuat laporan kualitas. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}.

general_issues[]

QualityReport.Issue

Opsional. Masalah umum yang tidak spesifik untuk agen tertentu.

AgentIssues

Masalah yang teridentifikasi untuk satu agen.

Kolom

agent

string

Opsional. Nama agen yang terkait dengan masalah. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

issues[]

QualityReport.Issue

Opsional. Daftar masalah yang ditemukan untuk agen ini.

Masalah

Masalah yang teridentifikasi.

Kolom

description

string

Opsional. Deskripsi masalah yang ditemukan.

occurrence_count

int32

Opsional. Berapa kali masalah ini terjadi.

proposed_solution

string

Opsional. Solusi yang diusulkan untuk memperbaiki masalah dengan mengubah petunjuk atau alat.

RecognitionResult

Hasil pengenalan ucapan untuk input audio.

Kolom

transcript

string

Opsional. Segmen ucapan pengguna yang digabungkan dan direkam selama giliran saat ini.

RedactionConfig

Konfigurasi untuk menginstruksikan cara menangani data sensitif.

Kolom

enable_redaction

bool

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

inspect_template

string

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

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

deidentify_template

string

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

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

RemoteA2aConfig

Konfigurasi bersama untuk terhubung ke agen A2A jarak jauh.

Kolom
`api_authentication`	`ApiAuthentication` Opsional. Konfigurasi autentikasi untuk memanggil agen jarak jauh. Opsional jika referensi registry sudah menangani autentikasi.
`input_variable_mapping`	`map<string, string>` Opsional. Pemetaan nama variabel input agen jarak jauh ke nama variabel GECX.
`output_variable_mapping`	`map<string, string>` Opsional. Pemetaan nama variabel output agen jarak jauh ke nama variabel GECX.
`streaming_enabled`	`bool` Opsional. Apakah streaming diaktifkan untuk agen jarak jauh.
`context_id`	`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 agen jarak jauh. `agent_spec` hanya ada berupa salah satu diantara berikut:
`agent_card`	`AgentCard` Opsional. Kartu agen lengkap yang ditentukan secara inline.
`agent_registry`	`string` Opsional. Referensi ke agen di Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`

RemoteAgentTool

Mewakili alat yang memungkinkan agen memanggil agen jarak jauh lain.

Kolom
`name`	`string` Wajib. Nama alat.
`description`	`string` Wajib. Deskripsi alat.
`agent_card`	`AgentCard` Wajib. Kartu agen dari agen jarak jauh yang dipanggil oleh alat ini.
`api_authentication`	`ApiAuthentication` Opsional. Konfigurasi autentikasi untuk memanggil agen jarak jauh.
`stateful_agent`	`bool` Opsional. Jika diaktifkan, interaksi antara aplikasi CXAS dan agen jarak jauh akan memiliki konteks yang sama. Jika agen jarak jauh menampilkan context_id, context_id tersebut akan dipertahankan selama sesi untuk alat agen jarak jauh ini.
`input_variable_mapping`	`map<string, string>` Opsional. Pemetaan nama variabel input agen jarak jauh ke nama variabel GECX.
`output_variable_mapping`	`map<string, string>` Opsional. Pemetaan nama variabel output agen jarak jauh ke nama variabel GECX.

RestoreAppVersionRequest

Pesan permintaan untuk AgentService.RestoreAppVersion

Kolom

name

string

Wajib. Nama resource versi aplikasi yang akan dipulihkan.

RestoreAppVersionResponse

Jenis ini tidak memiliki kolom.

Pesan respons untuk AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Pesan permintaan untuk ToolService.RetrieveToolSchema.

Kolom
`parent`	`string` Wajib. Nama resource aplikasi yang memiliki alat/kumpulan alat. Format: `projects/{project}/locations/{location}/apps/{app}`
Kolom union `tool_identifier`. ID alat untuk mengambil skemanya. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool`	`string` Opsional. Nama alat untuk mengambil skema. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
`toolset_tool`	`ToolsetTool` Opsional. Alat toolset untuk mengambil skema. Hanya satu alat yang harus cocok dengan predikat dari toolset. Jika tidak, error akan ditampilkan.

RetrieveToolSchemaResponse

Pesan respons untuk ToolService.RetrieveToolSchema.

Kolom
`input_schema`	`Schema` Skema parameter input alat.
`output_schema`	`Schema` Skema parameter output alat.
Kolom union `tool_identifier`. ID alat yang skemanya ditujukan untuknya. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool`	`string` Nama alat yang ditujukan untuk skema. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Alat toolset yang skemanya ditujukan untuk.

RetrieveToolsRequest

Pesan permintaan untuk ToolService.RetrieveTools.

Kolom

toolset

string

Wajib. Nama toolset untuk mengambil alat. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

tool_ids[]

string

Opsional. ID alat yang akan diambil dari toolset. Jika kosong, semua alat dalam toolset akan ditampilkan.

bypass_persistence_config

bool

Opsional. Jika benar (true), alat yang ditampilkan akan berisi deskripsi dan skema mentah langsung dari server, dengan melewati konfigurasi persistensi yang disimpan (penggantian/snapshot).

RetrieveToolsResponse

Pesan respons untuk ToolService.RetrieveTools.

Kolom

tools[]

Tool

Daftar alat yang disertakan dalam toolset yang ditentukan.

RunEvaluationOperationMetadata

Metadata operasi untuk EvaluationService.RunEvaluation.

Kolom
`evaluations[]`	`string` Hanya output. Daftar evaluasi yang dijalankan. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`evaluation_run`	`string` Hanya output. Jalankan evaluasi yang dibuat. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}`
`create_time`	`Timestamp` Hanya output. Waktu pembuatan operasi.
`end_time`	`Timestamp` Hanya output. Waktu operasi selesai.
`verb`	`string` Hanya output. Kata kerja operasi.
`cancel_requested`	`bool` Hanya output. Mengidentifikasi apakah pengguna telah meminta pembatalan operasi. Operasi yang berhasil dibatalkan memiliki nilai `google.longrunning.Operation.error` dengan `google.rpc.Status.code` `1`, yang sesuai dengan `Code.CANCELLED`.

RunEvaluationRequest

Pesan permintaan untuk EvaluationService.RunEvaluation.

Kolom
`app`	`string` Wajib. Aplikasi yang akan dievaluasi. Format: `projects/{project}/locations/{location}/apps/{app}`
`evaluations[]`	`string` Opsional. Daftar evaluasi yang akan dijalankan. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`
`evaluation_dataset`	`string` Opsional. Set data evaluasi yang akan dijalankan. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`
`display_name`	`string` Opsional. Nama tampilan proses evaluasi.
`app_version`	`string` Opsional. Versi aplikasi yang akan dievaluasi. Maksimal satu dari `app_version` atau `deployment` yang dapat ditetapkan. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
`config`	`EvaluationConfig` Opsional. Konfigurasi yang akan digunakan untuk run.
`persona_run_configs[]`	`PersonaRunConfig` Opsional. Konfigurasi yang akan digunakan untuk menjalankan per persona.
`optimization_config`	`OptimizationConfig` Opsional. Konfigurasi untuk menjalankan langkah pengoptimalan setelah menjalankan evaluasi. Jika tidak disetel, langkah pengoptimalan tidak akan dijalankan.
`scheduled_evaluation_run`	`string` Opsional. Nama resource `ScheduledEvaluationRun` yang memicu proses evaluasi ini. Jika kolom ini disetel, kolom `scheduled_evaluation_run` pada resource `EvaluationRun` yang dibuat akan diisi dari nilai ini. Format: `projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}`
`golden_run_method`	`GoldenRunMethod` Opsional. Metode untuk menjalankan evaluasi jika merupakan evaluasi standar. Jika tidak disetel, defaultnya adalah STABLE.
`generate_latency_report`	`bool` Opsional. Apakah akan membuat laporan latensi untuk proses evaluasi.
`evaluation_run_caching_settings`	`EvaluationRunCachingSettings` Opsional. Setelan penyiapan yang akan digunakan untuk menjalankan evaluasi.
`run_count`	`int32` Opsional. Jumlah waktu untuk menjalankan evaluasi. Jika tidak disetel, nilai defaultnya adalah 1 per emas, dan 5 per skenario.

RunEvaluationResponse

Pesan respons untuk EvaluationService.RunEvaluation.

Kolom

evaluation_run

string

Nama proses evaluasi yang dibuat. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

RunEvaluationResultMetricsOperationMetadata

Jenis ini tidak memiliki kolom.

Metadata operasi untuk EvaluationService.RunEvaluationResultMetrics.

RunEvaluationResultMetricsRequest

Pesan permintaan untuk EvaluationService.RunEvaluationResultMetrics.

Kolom

evaluation_result_id

string

Wajib. Hasil evaluasi untuk menjalankan metrik. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}

RunEvaluationResultMetricsResponse

Pesan respons untuk EvaluationService.RunEvaluationResultMetrics.

Kolom

status

EvaluationResult.Outcome

Hanya output. Status penghitungan metrik hasil evaluasi.

RunSessionRequest

Pesan permintaan untuk SessionService.RunSession.

Kolom

config

SessionConfig

Wajib. Konfigurasi untuk sesi.

inputs[]

SessionInput

Wajib. Input untuk sesi.

RunSessionResponse

Pesan respons untuk SessionService.RunSession.

Kolom

outputs[]

SessionOutput

Output untuk sesi.

ScheduledEvaluationRun

Mewakili konfigurasi operasi evaluasi terjadwal.

Kolom
`name`	`string` ID. ID unik konfigurasi eksekusi evaluasi terjadwal. Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}
`display_name`	`string` Wajib. Nama tampilan yang ditentukan pengguna untuk konfigurasi proses evaluasi terjadwal.
`request`	`RunEvaluationRequest` Wajib. RunEvaluationRequest yang akan dijadwalkan
`description`	`string` Opsional. Deskripsi yang ditentukan pengguna untuk menjalankan evaluasi terjadwal.
`scheduling_config`	`ScheduledEvaluationRun.SchedulingConfig` Wajib. Konfigurasi untuk waktu dan frekuensi pelaksanaan evaluasi.
`active`	`bool` Opsional. Apakah konfigurasi ini aktif
`last_completed_run`	`string` Hanya output. EvaluationRun terakhir yang berhasil dari eksekusi terjadwal ini. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}`
`total_executions`	`int32` Hanya output. Total jumlah eksekusi ini telah dijalankan
`next_scheduled_execution_time`	`Timestamp` Hanya output. Waktu berikutnya saat ini dijadwalkan untuk dieksekusi
`create_time`	`Timestamp` Hanya output. Stempel waktu saat eksekusi evaluasi terjadwal dibuat.
`created_by`	`string` Hanya output. Pengguna yang membuat proses evaluasi terjadwal.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat evaluasi terakhir diperbarui.
`last_updated_by`	`string` Hanya output. Pengguna yang terakhir memperbarui evaluasi.
`etag`	`string` Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

SchedulingConfig

Detail konfigurasi penjadwalan evaluasi

Kolom

frequency

ScheduledEvaluationRun.SchedulingConfig.Frequency

Wajib. Frekuensi untuk menjalankan evaluasi

start_time

Wajib. Stempel waktu saat evaluasi harus dimulai.

days_of_week[]

int32

Opsional. Hari dalam seminggu untuk menjalankan evaluasi. Hanya berlaku untuk frekuensi Mingguan dan Dua Mingguan. 1 adalah Senin, 2 adalah Selasa, ..., 7 adalah Minggu.

Frekuensi

Frekuensi evaluasi dapat dijalankan

Enum
`FREQUENCY_UNSPECIFIED`	Frekuensi tidak ditentukan.
`NONE`	Menunjukkan jadwal sekali jalan yang tidak boleh berulang
`DAILY`	Jalankan evaluasi setiap hari.
`WEEKLY`	Jalankan evaluasi setiap minggu.
`BIWEEKLY`	Jalankan evaluasi dua mingguan.

Skema

Mewakili subset objek skema OpenAPI 3.0 yang dipilih.

Kolom
`type`	`Schema.Type` Wajib. Jenis data.
`properties`	`map<string, Schema>` Opsional. Properti Type.OBJECT.
`required[]`	`string` Opsional. Properti wajib Type.OBJECT.
`description`	`string` Opsional. Deskripsi data.
`items`	`Schema` Opsional. Skema elemen Type.ARRAY.
`nullable`	`bool` Opsional. Menunjukkan apakah nilai mungkin null.
`unique_items`	`bool` Opsional. Menunjukkan bahwa item dalam array harus unik. Hanya berlaku untuk TYPE.ARRAY.
`prefix_items[]`	`Schema` Opsional. Skema elemen awal Type.ARRAY.
`additional_properties`	`Schema` Opsional. Dapat berupa boolean atau objek, mengontrol keberadaan properti tambahan.
`any_of[]`	`Schema` Opsional. Nilai harus divalidasi terhadap subskema apa pun (satu atau lebih) dalam daftar.
`enum[]`	`string` Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. Kita dapat menentukan arah sebagai : {type:STRING, format:enum, enum:["TIMUR", NORTH", "SELATAN", "BARAT"]} 2. Kita dapat menentukan nomor apartemen sebagai : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
`default`	`Value` Opsional. Nilai default data.
`ref`	`string` Opsional. Memungkinkan referensi tidak langsung antar-node skema. Nilai harus berupa referensi yang valid ke turunan `defs` akar. Misalnya, skema berikut menentukan referensi ke node skema bernama "Pet": `type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string` Nilai properti "pet" adalah referensi ke node skema bernama "Pet". Lihat detailnya di https://json-schema.org/understanding-json-schema/structuring.
`defs`	`map<string, Schema>` Opsional. Peta definisi untuk digunakan oleh `ref`. Hanya diizinkan di root skema.
`title`	`string` Opsional. Judul skema.
`min_items`	`int64` Opsional. Jumlah minimum elemen untuk Type.ARRAY.
`max_items`	`int64` Opsional. Jumlah maksimum elemen untuk Type.ARRAY.
`minimum`	`double` Opsional. Nilai minimum untuk Type.INTEGER dan Type.NUMBER.
`maximum`	`double` Opsional. Nilai maksimum untuk Type.INTEGER dan Type.NUMBER.

Jenis

Jenis data OpenAPI.

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

SecuritySettings

Setelan keamanan tingkat Project/Lokasi untuk CES.

Kolom
`name`	`string` ID. ID unik setelan keamanan. Format: `projects/{project}/locations/{location}/securitySettings`
`endpoint_control_policy`	`EndpointControlPolicy` Opsional. Setelan terkait kontrol endpoint.
`create_time`	`Timestamp` Hanya output. Waktu pembuatan setelan keamanan.
`update_time`	`Timestamp` Hanya output. Waktu update terakhir setelan keamanan.
`etag`	`string` Hanya output. Etag setelan keamanan.

ServiceAccountAuthConfig

Konfigurasi untuk autentikasi menggunakan akun layanan kustom.

Kolom

service_account

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.

ServiceAgentIdTokenAuthConfig

Jenis ini tidak memiliki kolom.

Konfigurasi untuk autentikasi dengan token ID yang dibuat dari agen layanan.

ServiceDirectoryConfig

Konfigurasi untuk alat yang menggunakan Direktori Layanan.

Kolom

service

string

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

SessionConfig

Konfigurasi untuk sesi.

Kolom
`session`	`string` Wajib. ID unik sesi. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`
`input_audio_config`	`InputAudioConfig` Opsional. Konfigurasi untuk memproses audio input.
`output_audio_config`	`OutputAudioConfig` Opsional. Konfigurasi untuk membuat audio output.
`historical_contexts[]`	`Message` Opsional. Konteks historis sesi, termasuk input pengguna, respons agen, dan pesan lainnya. Biasanya, agen CES akan mengelola sesi secara otomatis sehingga klien tidak perlu mengisi kolom ini secara eksplisit. Namun, klien dapat secara opsional mengganti konteks historis untuk memulai sesi dari status tertentu.
`entry_agent`	`string` Opsional. Agen entri untuk menangani sesi. Jika tidak ditentukan, sesi akan ditangani oleh `root agent` aplikasi. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`deployment`	`string` Opsional. Deployment aplikasi yang akan digunakan untuk sesi. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
`time_zone`	`string` Opsional. Zona waktu pengguna. Jika diberikan, agen akan menggunakan zona waktu untuk variabel terkait tanggal dan waktu. Jika tidak, agen akan menggunakan zona waktu yang ditentukan di App.time_zone_settings. Formatnya adalah zona waktu Database Zona Waktu IANA, misalnya "America/Los_Angeles".
`use_tool_fakes`	`bool` Opsional. Apakah akan menggunakan tiruan alat untuk sesi. Jika kolom ini disetel, agen akan mencoba menggunakan tiruan alat, bukan memanggil alat yang sebenarnya.
`remote_dialogflow_query_parameters`	`SessionConfig.RemoteDialogflowQueryParameters` Opsional. QueryParameters untuk dikirim ke agen Dialogflow jarak jauh saat kontrol sesi ditransfer ke agen jarak jauh.
`enable_text_streaming`	`bool` Opsional. Apakah akan mengaktifkan output teks streaming dari model. Secara default, output teks dari model dikumpulkan sebelum dikirim ke klien. CATATAN: Fitur ini hanya didukung untuk sesi teks (non-suara) melalui `StreamRunSession` atau `BidiRunSession`.
`exclude_diagnostic_info`	`bool` Opsional. Apakah akan mengecualikan info diagnostik dari output sesi.

RemoteDialogflowQueryParameters

QueryParameters untuk dikirim ke agen Dialogflow jarak jauh saat kontrol sesi ditransfer ke agen jarak jauh.

Kolom

webhook_headers

map<string, string>

Opsional. Header HTTP yang akan dikirim sebagai webhook_headers di QueryParameters.

payload

Opsional. Payload yang akan dikirim dalam QueryParameters.

end_user_metadata

Opsional. Metadata pengguna akhir yang akan dikirim dalam QueryParameters.

SessionInput

Input untuk sesi.

Kolom
`will_continue`	`bool` Opsional. Flag untuk menunjukkan apakah pesan saat ini adalah fragmen input yang lebih besar dalam sesi streaming bidi. Jika disetel ke `true`, agen akan menunda pemrosesan hingga menerima pesan berikutnya dengan `will_continue` adalah `false`, atau hingga sistem mendeteksi titik akhir dalam input audio. CATATAN: Kolom ini tidak berlaku untuk input audio dan DTMF, karena input tersebut selalu diproses secara otomatis berdasarkan sinyal pengakhiran.
Kolom union `input_type`. Jenis input. `input_type` hanya ada berupa salah satu diantara berikut:
`text`	`string` Opsional. Data teks dari pengguna akhir.
`dtmf`	`string` Opsional. Digit DTMF dari pengguna akhir.
`audio`	`bytes` Opsional. Data audio dari pengguna akhir.
`tool_responses`	`ToolResponses` Opsional. Hasil eksekusi untuk panggilan alat dari klien.
`image`	`Image` Opsional. Data gambar dari pengguna akhir.
`blob`	`Blob` Opsional. Data blob dari pengguna akhir.
`variables`	`Struct` Opsional. Variabel kontekstual untuk sesi, yang dikelompokkan berdasarkan nama. Hanya variabel yang dideklarasikan di aplikasi yang akan digunakan oleh agen CES. Variabel yang tidak dikenali akan tetap dikirim ke [agen Dialogflow][Agent.RemoteDialogflowAgent] sebagai parameter sesi tambahan.
`event`	`Event` Opsional. Input acara.

SessionOutput

Output untuk sesi.

Kolom
`turn_index`	`int32` Menunjukkan urutan percakapan yang berurutan yang menjadi bagian dari output ini, dimulai dari 1.
`turn_completed`	`bool` Jika benar (true), agen CES telah mendeteksi akhir giliran percakapan saat ini dan tidak akan memberikan output lebih lanjut untuk giliran ini.
`diagnostic_info`	`SessionOutput.DiagnosticInfo` Opsional. Informasi diagnostik berisi detail eksekusi selama pemrosesan input. Hanya diisi di SessionOutput terakhir (dengan `turn_completed=true`) untuk setiap giliran.
Kolom union `output_type`. Jenis output. `output_type` hanya ada berupa salah satu diantara berikut:
`text`	`string` Teks output dari agen CES.
`audio`	`bytes` Menghasilkan audio dari agen CES.
`tool_calls`	`ToolCalls` Permintaan agar klien menjalankan alat.
`citations`	`Citations` Kutipan yang memberikan informasi sumber untuk teks yang dihasilkan agen.
`google_search_suggestions`	`GoogleSearchSuggestions` Saran yang ditampilkan dari Google Penelusuran sebagai hasil dari pemanggilan `GoogleSearchTool`.
`end_session`	`EndSession` Menunjukkan bahwa sesi telah berakhir.
`payload`	`Struct` Payload kustom dengan output terstruktur dari agen CES.
`image`	`Image` Gambar output dari agen CES.
`progress`	`string` Pembaruan progres sementara dari agen CES.

DiagnosticInfo

Berisi detail eksekusi selama pemrosesan.

Kolom

messages[]

Message

Daftar pesan yang terjadi selama pemrosesan.

root_span

Span

Trace seluruh pemrosesan permintaan, yang ditampilkan sebagai rentang root. Rentang ini dapat berisi rentang turunan bertingkat untuk operasi tertentu.

Span

Rentang adalah unit tugas atau satu operasi selama pemrosesan permintaan.

Kolom
`name`	`string` Hanya output. Nama rentang.
`start_time`	`Timestamp` Hanya output. Waktu mulai rentang.
`end_time`	`Timestamp` Hanya output. Waktu berakhir rentang.
`duration`	`Duration` Hanya output. Durasi rentang.
`attributes`	`Struct` Hanya output. Atribut nilai kunci yang terkait dengan rentang.
`child_spans[]`	`Span` Hanya output. Rentang turunan yang bertingkat di bawah rentang ini.

SynthesizeSpeechConfig

Konfigurasi cara mensintesis respons agen.

Kolom
`voice`	`string` Opsional. Nama suara. Jika tidak disetel, layanan akan memilih suara berdasarkan parameter lain seperti language_code. Untuk mengetahui daftar suara yang tersedia, lihat Suara dan bahasa yang didukung dari Cloud Text-to-Speech.
`speaking_rate`	`double` Opsional. Kecepatan bicara dalam rentang [0,25, 2,0]. 1,0 adalah kecepatan native normal yang didukung oleh suara tertentu. 2,0 adalah dua kali lebih cepat, dan 0,5 adalah setengah kali lebih cepat. Nilai di luar rentang [0,25, 2,0] akan menampilkan error.
`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.

SystemTool

Alat sistem yang telah ditentukan sebelumnya.

Kolom

name

string

Wajib. Nama alat sistem.

description

string

Hanya output. Deskripsi alat sistem.

TestPersonaVoiceRequest

Pesan permintaan untuk EvaluationService.TestPersonaVoice.

Kolom

app

string

Wajib diisi. Nama resource aplikasi untuk menguji suara persona. Format: projects/{project}/locations/{location}/apps/{app}

persona_id

string

Wajib. ID persona untuk menguji suara. Juga menerima "default".

text

string

Wajib. Teks untuk menguji suara.

TestPersonaVoiceResponse

Pesan respons untuk EvaluationService.TestPersonaVoice.

Kolom

audio

bytes

Byte data audio dari suara yang disintesis.

TimeZoneSettings

Setelan TimeZone aplikasi.

Kolom

time_zone

string

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

TlsConfig

Konfigurasi TLS.

Kolom

ca_certs[]

TlsConfig.CaCert

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

CaCert

Sertifikat CA.

Kolom

display_name

string

Wajib. Nama sertifikat CA kustom yang diizinkan. Hal ini dapat digunakan untuk membedakan sertifikat CA kustom.

cert

bytes

Wajib. Sertifikat CA kustom yang diizinkan (dalam format DER) untuk verifikasi HTTPS. Opsi ini menggantikan 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'")

Alat

Alat mewakili tindakan yang dapat dilakukan agen CES untuk mencapai tujuan tertentu.

Kolom
`name`	`string` ID. Nama resource alat. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` untuk alat mandiri. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` untuk alat yang diambil dari toolset. Alat ini bersifat dinamis dan hanya menghasilkan output; alat ini tidak dapat dirujuk secara langsung jika alat diperlukan.
`display_name`	`string` Hanya output. Nama tampilan alat, yang berasal dari jenis alat. Misalnya, nama tampilan [ClientFunction][Tool.ClientFunction] berasal dari properti `name`-nya.
`execution_type`	`ExecutionType` Opsional. Jenis eksekusi alat.
`timeout`	`Duration` Opsional. Waktu tunggu untuk eksekusi alat. Jika tidak disetel, waktu tunggu default adalah 30 detik untuk alat `SYNCHRONOUS` dan 60 detik untuk alat `ASYNCHRONOUS`.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat alat dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat alat terakhir diperbarui.
`etag`	`string` ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
`generated_summary`	`string` Hanya output. Jika alat dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan tersebut.
`tool_fake_config`	`ToolFakeConfig` Opsional. Konfigurasi untuk perilaku alat dalam mode tiruan.
`read_only`	`bool` 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:
`client_function`	`ClientFunction` Opsional. Fungsi klien.
`open_api_tool`	`OpenApiTool` Opsional. Alat API terbuka.
`google_search_tool`	`GoogleSearchTool` Opsional. Alat penelusuran google.
`connector_tool`	`ConnectorTool` Opsional. Alat Integration Connector.
`data_store_tool`	`DataStoreTool` Opsional. Alat penyimpanan data.
`python_function`	`PythonFunction` Opsional. Alat fungsi python.
`mcp_tool`	`McpTool` Opsional. Alat MCP. Alat MCP tidak dapat dibuat atau diperbarui secara langsung dan dikelola oleh toolset MCP.
`file_search_tool`	`FileSearchTool` Opsional. Alat penelusuran file.
`system_tool`	`SystemTool` Opsional. Alat sistem.
`agent_tool`	`AgentTool` Opsional. Alat agen.
`widget_tool`	`WidgetTool` Opsional. Alat widget.
`remote_agent_tool`	`RemoteAgentTool` Opsional. Alat agen jarak jauh.

ToolCall

Meminta klien atau agen untuk menjalankan alat yang ditentukan.

Kolom
`id`	`string` Opsional. ID unik panggilan alat. Jika diisi, klien harus menampilkan hasil eksekusi dengan ID yang cocok di `ToolResponse`.
`display_name`	`string` Hanya output. Nama tampilan alat.
`args`	`Struct` Opsional. Parameter dan nilai input untuk alat dalam format objek JSON.
`parent_tool_call_id`	`string` Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
`agent_name`	`string` Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Contract Architect". Kosong saat agen root menerbitkannya.
Kolom union `tool_identifier`. ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool`	`string` Opsional. Nama alat yang akan dieksekusi. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Opsional. Alat toolset yang akan dijalankan.

ToolCalls

Permintaan agar klien menjalankan alat dan menampilkan hasil eksekusi sebelum melanjutkan sesi.

Kolom

tool_calls[]

ToolCall

Opsional. Daftar panggilan alat yang akan dieksekusi.

ToolFakeConfig

Konfigurasi untuk perilaku alat dalam mode tiruan.

Kolom

enable_fake_mode

bool

Opsional. Apakah alat menggunakan mode palsu.

Kolom union tool_response. Respons bersifat statis atau disediakan oleh fungsi python. tool_response hanya ada berupa salah satu diantara berikut:

code_block

CodeBlock

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

ToolResponse

Hasil eksekusi alat tertentu dari klien atau agen.

Kolom
`id`	`string` Opsional. ID yang cocok dari `tool call` yang menjadi tujuan respons.
`display_name`	`string` Hanya output. Nama tampilan alat.
`response`	`Struct` 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.
`parent_tool_call_id`	`string` Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
`agent_name`	`string` Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Contract Architect". Kosong saat agen root menerbitkannya.
Kolom union `tool_identifier`. ID alat yang dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. `tool_identifier` hanya ada berupa salah satu diantara berikut:
`tool`	`string` Opsional. Nama alat yang akan dieksekusi. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
`toolset_tool`	`ToolsetTool` Opsional. Alat toolset yang dieksekusi.

ToolResponses

Hasil eksekusi untuk panggilan alat yang diminta dari klien.

Kolom

tool_responses[]

ToolResponse

Opsional. Daftar hasil eksekusi alat.

Toolset

Toolset mewakili sekelompok alat yang dikelola secara dinamis yang dapat digunakan oleh agen.

Kolom
`name`	`string` ID. ID unik toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
`display_name`	`string` Opsional. Nama tampilan toolset. Harus unik dalam aplikasi yang sama.
`description`	`string` Opsional. Deskripsi toolset.
`timeout`	`Duration` Opsional. Waktu tunggu untuk eksekusi toolset. Jika tidak disetel, waktu tunggu default adalah 30 detik untuk toolset `SYNCHRONOUS` dan 60 detik untuk toolset `ASYNCHRONOUS`.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat toolset dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat toolset terakhir diperbarui.
`etag`	`string` ETag digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
`execution_type`	`ExecutionType` Opsional. Jenis eksekusi alat dalam toolset.
`tool_fake_config`	`ToolFakeConfig` Opsional. Konfigurasi untuk perilaku alat dalam mode palsu.
Kolom union `toolset_type`. Jenis toolset. `toolset_type` hanya ada berupa salah satu diantara berikut:
`mcp_toolset`	`McpToolset` Opsional. Toolset yang berisi daftar alat yang ditawarkan oleh server MCP.
`open_api_toolset`	`OpenApiToolset` Opsional. Toolset yang berisi daftar alat yang ditentukan oleh skema OpenAPI.
`connector_toolset`	`ConnectorToolset` Opsional. Kumpulan alat yang membuat alat dari Koneksi Integration Connectors.

ToolsetTool

Alat yang dibuat dari toolset.

Kolom

toolset

string

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

tool_id

string

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

TransferRule

Aturan untuk mentransfer ke agen tertentu.

Kolom
`child_agent`	`string` Wajib. Nama resource agen turunan tempat aturan diterapkan. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
`direction`	`TransferRule.Direction` Wajib. Arah transfer.
Kolom union `rule_type`. Jenis aturan. `rule_type` hanya ada berupa salah satu diantara berikut:
`deterministic_transfer`	`TransferRule.DeterministicTransfer` Opsional. Aturan yang segera ditransfer ke agen target saat kondisi terpenuhi.
`disable_planner_transfer`	`TransferRule.DisablePlannerTransfer` Opsional. Aturan yang mencegah perencana berpindah ke agen target.

DeterministicTransfer

Aturan transfer deterministik. Saat kondisi bernilai benar, transfer akan terjadi.

Kolom

Kolom union condition_type. Kondisi yang akan dievaluasi. condition_type hanya ada berupa salah satu diantara berikut:

expression_condition

ExpressionCondition

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

python_code_condition

PythonCodeCondition

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

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 anak ke agen induk.

DisablePlannerTransfer

Aturan yang mencegah perencana mentransfer ke agen target.

Kolom

expression_condition

ExpressionCondition

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

TriggerAction

Tindakan yang dilakukan saat prasyarat tertentu terpenuhi.

Kolom
Kolom union `action`. Tindakan yang harus dilakukan. `action` hanya ada berupa salah satu diantara berikut:
`respond_immediately`	`TriggerAction.RespondImmediately` Opsional. Segera merespons dengan respons yang telah dikonfigurasi sebelumnya.
`transfer_agent`	`TriggerAction.TransferAgent` Opsional. Mentransfer percakapan ke agen lain.
`generative_answer`	`TriggerAction.GenerativeAnswer` Opsional. Menanggapi dengan jawaban generatif.

GenerativeAnswer

Agen akan langsung merespons dengan jawaban generatif.

Kolom

prompt

string

Wajib. Perintah yang akan digunakan untuk jawaban generatif.

RespondImmediately

Agen akan segera merespons dengan respons yang telah dikonfigurasi sebelumnya.

Kolom

responses[]

TriggerAction.Response

Wajib. Respons standar yang dapat dipilih agen. Respons dipilih secara acak.

Respons

Mewakili respons dari agen.

Kolom

text

string

Wajib. Teks yang akan digunakan agen untuk merespons.

disabled

Pesan permintaan untuk EvaluationService.UploadEvaluationAudio.

Kolom

name

string

Wajib. Nama resource Evaluasi yang akan diupload audio evaluasinya. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

audio_content

bytes

Wajib. Byte audio mentah. Format audio harus LINEAR16 satu saluran dengan frekuensi sampel 16 kHz (InputAudioConfig default).

previous_audio_gcs_uri

string

Opsional. URI Google Cloud Storage dari file audio yang diupload sebelumnya yang akan dihapus. Format: gs://<bucket-name>/<object-name>

UploadEvaluationAudioResponse

Pesan respons untuk EvaluationService.UploadEvaluationAudio.

Kolom

audio_gcs_uri

string

URI Google Cloud Storage tempat file audio yang diupload disimpan. Format: gs://<bucket-name>/<object-name>

transcript

string

Transkrip audio, yang dihasilkan oleh Cloud Speech-to-Text.

duration