Alat: get_guardrail
Mendapatkan detail pembatasan yang ditentukan.
Contoh berikut menunjukkan cara menggunakan curl untuk memanggil alat MCP get_guardrail.
| Permintaan Curl |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_guardrail", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Skema Input
Pesan permintaan untuk AgentService.GetGuardrail.
GetGuardrailRequest
| Representasi JSON |
|---|
{ "name": string } |
| Kolom | |
|---|---|
name |
Wajib. Nama resource pembatasan yang akan diambil. |
Skema Output
Pembatas berisi daftar pemeriksaan dan keseimbangan untuk menjaga keamanan agen.
Pagar pembatas
| Representasi JSON |
|---|
{ "name": string, "displayName": string, "description": string, "enabled": boolean, "action": { object ( |
| Kolom | |
|---|---|
name |
ID. ID unik pembatas. Format: |
displayName |
Wajib. Nama tampilan pembatas. |
description |
Opsional. Deskripsi pembatasan. |
enabled |
Opsional. Apakah pembatasan diaktifkan atau tidak. |
action |
Opsional. Tindakan yang harus dilakukan saat pembatas dipicu. |
createTime |
Hanya output. Stempel waktu saat pembatasan dibuat. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
updateTime |
Hanya output. Stempel waktu saat batas aman terakhir diperbarui. Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
etag |
ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak. |
Kolom union guardrail_type. Jenis pembatas. guardrail_type hanya ada berupa salah satu diantara berikut: |
|
contentFilter |
Opsional. Pembatasan yang melarang penggunaan konten tertentu dalam percakapan. |
llmPromptSecurity |
Opsional. Pembatas yang memblokir percakapan jika perintah dianggap tidak aman berdasarkan klasifikasi LLM. |
llmPolicy |
Opsional. Pembatas yang memblokir percakapan jika respons LLM dianggap melanggar kebijakan berdasarkan klasifikasi LLM. |
modelSafety |
Opsional. Membatasi percakapan jika respons LLM dianggap tidak aman berdasarkan setelan keamanan model. |
codeCallback |
Opsional. Pembatas yang berpotensi memblokir percakapan berdasarkan hasil eksekusi callback. |
ContentFilter
| Representasi JSON |
|---|
{
"bannedContents": [
string
],
"bannedContentsInUserInput": [
string
],
"bannedContentsInAgentResponse": [
string
],
"matchType": enum ( |
| Kolom | |
|---|---|
bannedContents[] |
Opsional. Daftar frasa yang dilarang. Berlaku untuk input pengguna dan respons agen. |
bannedContentsInUserInput[] |
Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk input pengguna. |
bannedContentsInAgentResponse[] |
Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk respons agen. |
matchType |
Wajib. Jenis pencocokan untuk filter konten. |
disregardDiacritics |
Opsional. Jika benar (true), diakritik diabaikan selama pencocokan. |
LlmPromptSecurity
| Representasi JSON |
|---|
{ "failOpen": boolean, // Union field |
| Kolom | |
|---|---|
failOpen |
Opsional. Menentukan perilaku saat pembatasan menemukan error LLM. - Jika benar (true): batas aman dilewati. - Jika salah (default): pembatasan akan dipicu/diblokir. Catatan: Jika kebijakan kustom diberikan, kolom ini akan diabaikan dan digantikan oleh konfigurasi 'fail_open' kebijakan. |
Kolom union security_config. Menentukan mode konfigurasi keamanan. Pengguna harus memilih salah satu konfigurasi berikut. security_config hanya ada berupa salah satu diantara berikut: |
|
defaultSettings |
Opsional. Menggunakan setelan keamanan default yang telah ditentukan sebelumnya oleh sistem. Untuk memilih mode ini, sertakan pesan 'default_settings' kosong dalam permintaan. Kolom 'default_prompt_template' di dalamnya akan diisi oleh server dalam respons. |
customPolicy |
Opsional. Gunakan LlmPolicy yang ditentukan pengguna untuk mengonfigurasi pembatasan keamanan. |
DefaultSecuritySettings
| Representasi JSON |
|---|
{ "defaultPromptTemplate": string } |
| Kolom | |
|---|---|
defaultPromptTemplate |
Hanya output. Template perintah default yang digunakan oleh sistem. Kolom ini digunakan untuk tujuan tampilan guna menunjukkan kepada pengguna perintah apa yang digunakan sistem secara default. Ini adalah OUTPUT_ONLY. |
LlmPolicy
| Representasi JSON |
|---|
{ "maxConversationMessages": integer, "modelSettings": { object ( |
| Kolom | |
|---|---|
maxConversationMessages |
Opsional. Saat memeriksa kebijakan ini, pertimbangkan 'n' pesan terakhir dalam percakapan. Jika tidak ditetapkan, nilai default 10 akan digunakan. |
modelSettings |
Opsional. Setelan model. |
prompt |
Wajib. Perintah kebijakan. |
policyScope |
Wajib. Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan. Jika disetel ke |
failOpen |
Opsional. Jika terjadi error selama pemeriksaan kebijakan, buka dan jangan memicu pembatasan. |
allowShortUtterance |
Opsional. Secara default, pemeriksaan kebijakan LLM dilewati untuk ucapan singkat. Mengaktifkan setelan ini akan menerapkan pemeriksaan kebijakan ke semua ucapan, termasuk yang biasanya akan dilewati. |
ModelSettings
| Representasi JSON |
|---|
{ "model": string, // Union field |
| Kolom | |
|---|---|
model |
Opsional. Model LLM yang harus digunakan agen. Jika tidak disetel, agen akan mewarisi model dari agen induknya. |
Kolom union
|
|
temperature |
Opsional. Jika disetel, suhu ini akan digunakan untuk model LLM. Temperatur mengontrol keacakan respons model. Temperatur yang lebih rendah menghasilkan respons yang lebih dapat diprediksi. Suhu yang lebih tinggi menghasilkan respons yang lebih kreatif. |
ModelSafety
| Representasi JSON |
|---|
{
"safetySettings": [
{
object ( |
| Kolom | |
|---|---|
safetySettings[] |
Wajib. Daftar setelan keamanan. |
SafetySetting
| Representasi JSON |
|---|
{ "category": enum ( |
| Kolom | |
|---|---|
category |
Wajib. Kategori bahaya. |
threshold |
Wajib. Ambang batas pemblokiran bahaya. |
CodeCallback
| Representasi JSON |
|---|
{ "beforeAgentCallback": { object ( |
| Kolom | |
|---|---|
beforeAgentCallback |
Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut. |
afterAgentCallback |
Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut. |
beforeModelCallback |
Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut. |
afterModelCallback |
Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'TRIGGER' dapat menghentikan pemrosesan lebih lanjut. |
Callback
| Representasi JSON |
|---|
{ "description": string, "disabled": boolean, "proactiveExecutionEnabled": boolean, // Union field |
| Kolom | |
|---|---|
description |
Opsional. Deskripsi callback yang dapat dibaca manusia. |
disabled |
Opsional. Apakah callback dinonaktifkan. Panggilan balik yang dinonaktifkan akan diabaikan oleh agen. |
proactiveExecutionEnabled |
Opsional. Jika diaktifkan, callback juga akan dieksekusi pada output model perantara. Setelan ini hanya memengaruhi callback setelah model. AKTIFKAN DENGAN HATI-HATI. Biasanya, after_model_callback hanya perlu dieksekusi setelah menerima semua respons model. Mengaktifkan eksekusi proaktif dapat berimplikasi negatif pada biaya dan latensi eksekusi, dan hanya boleh diaktifkan dalam situasi yang jarang terjadi. |
Kolom union callback. Callback yang akan dieksekusi. callback hanya ada berupa salah satu diantara berikut: |
|
pythonCode |
Wajib. Kode python yang akan dieksekusi untuk callback. |
TriggerAction
| Representasi JSON |
|---|
{ // Union field |
| Kolom | |
|---|---|
Kolom union action. Tindakan yang harus dilakukan. action hanya ada berupa salah satu diantara berikut: |
|
respondImmediately |
Opsional. Segera merespons dengan respons yang telah dikonfigurasi sebelumnya. |
transferAgent |
Opsional. Mentransfer percakapan ke agen lain. |
generativeAnswer |
Opsional. Memberikan respons dengan jawaban generatif. |
RespondImmediately
| Representasi JSON |
|---|
{
"responses": [
{
object ( |
| Kolom | |
|---|---|
responses[] |
Wajib. Template pesan yang dapat dipilih agen. Respons dipilih secara acak. |
Respons
| Representasi JSON |
|---|
{ "text": string, "disabled": boolean } |
| Kolom | |
|---|---|
text |
Wajib. Teks yang akan digunakan agen untuk merespons. |
disabled |
Opsional. Apakah respons dinonaktifkan. Respons yang dinonaktifkan tidak digunakan oleh agen. |
TransferAgent
| Representasi JSON |
|---|
{ "agent": string } |
| Kolom | |
|---|---|
agent |
Wajib. Nama agen yang akan menerima transfer percakapan. Agen harus berada di aplikasi yang sama dengan agen saat ini. Format: |
GenerativeAnswer
| Representasi JSON |
|---|
{ "prompt": string } |
| Kolom | |
|---|---|
prompt |
Wajib. Perintah yang akan digunakan untuk jawaban generatif. |
Stempel waktu
| Representasi JSON |
|---|
{ "seconds": string, "nanos": integer } |
| Kolom | |
|---|---|
seconds |
Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z). |
nanos |
Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif. |
Anotasi Alat
Petunjuk Destruktif: ❌ | Petunjuk Idempoten: ✅ | Petunjuk Hanya Baca: ✅ | Petunjuk Dunia Terbuka: ❌