MCP Tools Reference: ces.googleapis.com

Alat: create_app

Membuat aplikasi baru di project dan lokasi tertentu.

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

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

Skema Input

Pesan permintaan untuk AgentService.CreateApp.

CreateAppRequest

Representasi JSON 
{
  "parent": string,
  "appId": string,
  "app": {
    object (App)
  }
}
Kolom
parent

string

Wajib. Nama resource lokasi untuk membuat aplikasi.
appId

string

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

object (App)

Wajib. Aplikasi yang akan dibuat.

Aplikasi

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

string

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

string

Wajib. Nama tampilan aplikasi.
description

string

Opsional. Deskripsi aplikasi yang dapat dibaca manusia.
pinned

boolean

Opsional. Apakah aplikasi disematkan dalam daftar aplikasi.
rootAgent

string

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

object (LanguageSettings)

Opsional. Setelan bahasa aplikasi.
timeZoneSettings

object (TimeZoneSettings)

Opsional. Setelan TimeZone aplikasi.
audioProcessingConfig

object (AudioProcessingConfig)

Opsional. Konfigurasi pemrosesan audio aplikasi.
loggingSettings

object (LoggingSettings)

Opsional. Setelan pencatatan log aplikasi.
errorHandlingSettings

object (ErrorHandlingSettings)

Opsional. Menangani error setelan aplikasi.
modelSettings

object (ModelSettings)

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

enum (ToolExecutionMode)

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

object (EvaluationMetricsThresholds)

Opsional. Batas evaluasi untuk aplikasi.
variableDeclarations[]

object (VariableDeclaration)

Opsional. Deklarasi variabel.
predefinedVariableDeclarations[]

object (VariableDeclaration)

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

string

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

string

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

object (DataStoreSettings)

Opsional. Setelan penyimpanan data untuk aplikasi.
defaultChannelProfile

object (ChannelProfile)

Opsional. Profil saluran default yang digunakan oleh aplikasi.
metadata

map (key: string, value: string)

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

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

string (Timestamp format)

Hanya output. Stempel waktu saat aplikasi dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat aplikasi terakhir diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
etag

string

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

integer

Hanya output. Jumlah deployment di aplikasi.
clientCertificateSettings

object (ClientCertificateSettings)

Opsional. Setelan sertifikat klien default untuk aplikasi.
vpcScSettings

object (VpcScSettings)

Opsional. Setelan VPC-SC untuk aplikasi.
locked

boolean

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

string

Hanya output. Kesalahan konfigurasi atau peringatan di aplikasi.
dashboardSettings

object (DashboardSettings)

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

LanguageSettings

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

string

Opsional. Kode bahasa default aplikasi.
supportedLanguageCodes[]

string

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

boolean

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

string

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

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

TimeZoneSettings

Representasi JSON 
{
  "timeZone": string
}
Kolom
timeZone

string

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

AudioProcessingConfig

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

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

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

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

Catatan: Kode bahasa tidak peka huruf besar/kecil.

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

object (BargeInConfig)

Opsional. Mengonfigurasi perilaku agen untuk aktivitas interupsi pengguna.
inactivityTimeout

string (Duration format)

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

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

object (AmbientSoundConfig)

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

SynthesizeSpeechConfigsEntry

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

string
value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

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

string

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

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

string

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

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

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

number

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

string

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

string

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

string

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

Cloud Storage URI untuk audio izin bagi kloning suara.

BargeInConfig

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

boolean

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

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

boolean

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

Durasi

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

string (int64 format)

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

integer

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

AmbientSoundConfig

Representasi JSON 
{
  "volumeGainDb": number,

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

number

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

enum (PrebuiltAmbientNoise)

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

string

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

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

string

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

LoggingSettings

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

object (RedactionConfig)

Opsional. Konfigurasi cara data sensitif harus disamarkan.
audioRecordingConfig

object (AudioRecordingConfig)

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

object (AudioRecordingConfig)

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

object (BigQueryExportSettings)

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

object (BigQueryExportSettings)

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

object (CloudLoggingSettings)

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

object (ConversationLoggingSettings)

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

object (AudioRecordingConfig)

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

object (MetricAnalysisSettings)

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

RedactionConfig

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

boolean

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

string

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

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

string

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

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

AudioRecordingConfig

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

string

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

Pilih lokasi bucket yang memenuhi persyaratan residensi data Anda.

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

string

Opsional. Awalan jalur Cloud Storage untuk rekaman audio.

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

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

BigQueryExportSettings

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

boolean

Opsional. Menunjukkan apakah BigQuery Export diaktifkan.
project

string

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

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

string

Opsional. ID set data BigQuery untuk mengekspor data.

CloudLoggingSettings

Representasi JSON 
{
  "enableCloudLogging": boolean
}
Kolom
enableCloudLogging

boolean

Opsional. Apakah akan mengaktifkan Cloud Logging untuk sesi.

ConversationLoggingSettings

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

boolean

Opsional. Apakah akan menonaktifkan logging percakapan untuk sesi.
retentionWindow

string (Duration format)

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

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

MetricAnalysisSettings

Representasi JSON 
{
  "llmMetricsOptedOut": boolean
}
Kolom
llmMetricsOptedOut

boolean

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

ErrorHandlingSettings

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

enum (ErrorHandlingStrategy)

Opsional. Strategi yang akan digunakan untuk penanganan error.
fallbackResponseConfig

object (FallbackResponseConfig)

Opsional. Konfigurasi untuk menangani respons penggantian.
endSessionConfig

object (EndSessionConfig)

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

FallbackResponseConfig

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

map (key: string, value: string)

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

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

integer

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

CustomFallbackMessagesEntry

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

string
value

string

EndSessionConfig

Representasi JSON 
{

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

Kolom union _escalate_session.

_escalate_session hanya dapat berupa salah satu dari hal berikut:
escalateSession

boolean

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

ModelSettings

Representasi JSON 
{
  "model": string,

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

string

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

Kolom union _temperature.

_temperature hanya dapat berupa salah satu dari hal berikut:
temperature

number

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

EvaluationMetricsThresholds

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

object (GoldenEvaluationMetricsThresholds)

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

enum (HallucinationMetricBehavior)

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

enum (HallucinationMetricBehavior)

Opsional. Perilaku metrik halusinasi untuk evaluasi golden dataset.
scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

Opsional. Perilaku metrik halusinasi untuk evaluasi skenario.

GoldenEvaluationMetricsThresholds

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

object (TurnLevelMetricsThresholds)

Opsional. Nilai minimum metrik tingkat belokan.
expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

Opsional. Nilai minimum metrik tingkat ekspektasi.
toolMatchingSettings

object (ToolMatchingSettings)

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

TurnLevelMetricsThresholds

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

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

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

enum (SemanticSimilarityChannel)

Opsional. Saluran kemiripan semantik yang akan digunakan untuk evaluasi.

Kolom union _semantic_similarity_success_threshold.

_semantic_similarity_success_threshold hanya dapat berupa salah satu dari hal berikut:
semanticSimilaritySuccessThreshold

integer

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

Kolom union _overall_tool_invocation_correctness_threshold.

_overall_tool_invocation_correctness_threshold hanya dapat berupa salah satu dari hal berikut:
overallToolInvocationCorrectnessThreshold

number

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

ExpectationLevelMetricsThresholds

Representasi JSON 
{

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

Kolom union _tool_invocation_parameter_correctness_threshold.

_tool_invocation_parameter_correctness_threshold hanya dapat berupa salah satu dari hal berikut:
toolInvocationParameterCorrectnessThreshold

number

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

ToolMatchingSettings

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

enum (ExtraToolCallBehavior)

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

VariableDeclaration

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

string

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

string

Wajib. Deskripsi variabel.
schema

object (Schema)

Wajib. Skema variabel.

Skema

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

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

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

enum (Type)

Wajib. Jenis data.
properties

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

Opsional. Properti Type.OBJECT.

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

string

Opsional. Properti wajib Type.OBJECT.
description

string

Opsional. Deskripsi data.
items

object (Schema)

Opsional. Skema elemen Type.ARRAY.
nullable

boolean

Opsional. Menunjukkan apakah nilai boleh berupa null.
uniqueItems

boolean

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

object (Schema)

Opsional. Skema elemen awal Type.ARRAY.
additionalProperties

object (Schema)

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

object (Schema)

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

string

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

value (Value format)

Opsional. Nilai default data.
ref

string

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

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

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

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

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

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

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

string

Opsional. Judul skema.
minItems

string (int64 format)

Opsional. Jumlah minimum elemen untuk Type.ARRAY.
maxItems

string (int64 format)

Opsional. Jumlah maksimum elemen untuk Type.ARRAY.

Kolom union _minimum.

_minimum hanya dapat berupa salah satu dari hal berikut:
minimum

number

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

Kolom union _maximum.

_maximum hanya dapat berupa salah satu dari hal berikut:
maximum

number

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

PropertiesEntry

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

string
value

object (Schema)

Nilai

Representasi JSON 
{

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

null

Mewakili JSON null.
numberValue

number

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

string

Mewakili string JSON.
boolValue

boolean

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

object (Struct format)

Mewakili objek JSON.
listValue

array (ListValue format)

Mewakili array JSON.

Struct

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

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

Peta tidak berurutan dari nilai yang diketik secara dinamis.

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

FieldsEntry

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

string
value

value (Value format)

ListValue

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

value (Value format)

Kolom berulang dari nilai yang diketik secara dinamis.

DefsEntry

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

string
value

object (Schema)

DataStoreSettings

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

object (Engine)

Hanya output. Mesin untuk aplikasi.

Mesin

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

string

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

enum (Type)

Hanya output. Jenis mesin.

ChannelProfile

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

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

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

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

string

Opsional. ID unik profil channel.
channelType

enum (ChannelType)

Opsional. Jenis profil channel.
personaProperty

object (PersonaProperty)

Opsional. Properti persona profil channel.
webWidgetConfig

object (WebWidgetConfig)

Opsional. Konfigurasi untuk widget web.
whatsappConfig

object (WhatsAppConfig)

Opsional. Konfigurasi khusus untuk deployment WhatsApp.
instagramConfig

object (InstagramConfig)

Opsional. Konfigurasi khusus untuk deployment Instagram.

Kolom union _disable_dtmf.

_disable_dtmf hanya dapat berupa salah satu dari hal berikut:
disableDtmf

boolean

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

Kolom union _disable_barge_in_control.

_disable_barge_in_control hanya dapat berupa salah satu dari hal berikut:
disableBargeInControl

boolean

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

Kolom union _noise_suppression_level.

_noise_suppression_level hanya dapat berupa salah satu dari hal berikut:
noiseSuppressionLevel

string

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

PersonaProperty

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

enum (Persona)

Opsional. Persona channel.

WebWidgetConfig

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

enum (Modality)

Opsional. Modalitas widget web.
theme

enum (Theme)

Opsional. Tema widget web.
webWidgetTitle

string

Opsional. Judul widget web.
securitySettings

object (SecuritySettings)

Opsional. Setelan keamanan widget web.

SecuritySettings

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

boolean

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

boolean

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

string

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

boolean

Opsional. Menunjukkan apakah verifikasi reCAPTCHA untuk widget web diaktifkan.

WhatsAppConfig

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

string

Wajib. ID Akun WhatsApp Business.
phoneNumberId

string

Wajib. ID nomor telepon Meta.
phoneNumber

string

Opsional. Nomor telepon dalam format E.164.
displayName

string

Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnailUrl

string

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

string

Hanya output. Deskripsi halaman atau profil bisnis Meta.

InstagramConfig

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

string

Wajib. ID Akun Instagram.
displayName

string

Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnailUrl

string

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

string

Hanya output. Deskripsi halaman atau profil bisnis Meta.

MetadataEntry

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

string
value

string

Stempel waktu

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

string (int64 format)

Mewakili detik waktu UTC sejak epoch Unix 1970-01-01T00:00:00Z. Harus antara -62135596800 dan 253402300799 inklusif (yang sesuai dengan 0001-01-01T00:00:00Z hingga 9999-12-31T23:59:59Z).
nanos

integer

Pecahan detik non-negatif pada resolusi nanodetik. Kolom ini adalah bagian nanodetik dari durasi, bukan alternatif untuk detik. Nilai detik negatif dengan pecahan harus tetap memiliki nilai nanos non-negatif yang dihitung maju dalam waktu. Harus antara 0 dan 999.999.999 inklusif.

ClientCertificateSettings

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

string

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

string

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

string

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

VpcScSettings

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

string

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

DashboardSettings

Representasi JSON 
{
  "defaultDashboard": string
}
Kolom
defaultDashboard

string

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

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

PrebuiltAmbientNoise

Suara bising di sekitar yang sudah dibuat.

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

ErrorHandlingStrategy

Menentukan strategi untuk menangani error.

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

ToolExecutionMode

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

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

SemanticSimilarityChannel

Saluran kemiripan semantik yang akan digunakan.

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

ExtraToolCallBehavior

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

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

HallucinationMetricBehavior

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

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

Jenis

Jenis data OpenAPI.

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

NullValue

Mewakili JSON null.

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

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

Enum
NULL_VALUE Nilai null.

Jenis

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

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

ChannelType

Jenis profil channel.

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

Persona

Persona channel.

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

Modalitas

Modalitas widget web.

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

Tema

Tema widget web.

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

Skema Output

Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.

Operasi

Representasi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
Kolom
name

string

Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.
metadata

object

Metadata khusus layanan yang terkait dengan operasi. Biasanya berisi informasi kemajuan dan metadata umum, seperti membuat waktu. Beberapa layanan mungkin tidak menyediakan metadata semacam itu. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan tipe metadata, jika ada.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.
done

boolean

Jika nilainya adalah false, artinya operasi masih berlangsung. Jika true, artinya operasi sudah selesai, dan error atau response tersedia.
Kolom union result. Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari berikut:
error

object (Status)

Hasil error operasi jika terjadi kegagalan atau pembatalan.
response

object

Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Semua

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

string

Mengidentifikasi jenis pesan Protobuf yang diserialkan dengan referensi URI yang terdiri dari awalan yang diakhiri dengan garis miring dan nama jenis yang sepenuhnya memenuhi syarat.

Contoh: type.googleapis.com/google.protobuf.StringValue

String ini harus berisi setidaknya satu karakter /, dan konten setelah / terakhir harus berupa nama yang sepenuhnya memenuhi syarat dari jenis dalam bentuk kanonis, tanpa titik di depannya. Jangan tulis skema pada referensi URI ini agar klien tidak mencoba menghubungi mereka.

Awalan bersifat arbitrer dan implementasi Protobuf diharapkan cukup menghapus semua yang ada hingga dan termasuk / terakhir untuk mengidentifikasi jenisnya. type.googleapis.com/ adalah awalan default umum yang diperlukan oleh beberapa penerapan lama. Awalan ini tidak menunjukkan asal jenis, dan URI yang memuatnya tidak diharapkan merespons permintaan apa pun.

Semua string URL jenis harus berupa referensi URI yang valid dengan batasan tambahan (untuk format teks) bahwa konten referensi hanya boleh terdiri dari karakter alfanumerik, escape yang dienkode persen, dan karakter dalam set berikut (tidak termasuk tanda petik terbalik luar): /-.~_!$&()*+,;=. Meskipun kami mengizinkan encoding persen, implementasi tidak boleh meng-unescape-nya untuk mencegah kebingungan dengan parser yang ada. Misalnya, type.googleapis.com%2FFoo harus ditolak.

Dalam desain asli Any, kemungkinan meluncurkan layanan penyelesaian jenis di URL jenis ini dipertimbangkan, tetapi Protobuf tidak pernah menerapkannya dan menganggap menghubungi URL ini bermasalah dan berpotensi menimbulkan masalah keamanan. Jangan mencoba menghubungi URL jenis kontak.
value

string (bytes format)

Berisi serialisasi Protobuf dari jenis yang dijelaskan oleh type_url.

String berenkode base64.

Status

Representasi JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Kolom
code

integer

Kode status, harus berupa nilai enum dari google.rpc.Code.
message

string

Pesan error yang ditampilkan ke developer dan seharusnya dalam bahasa Inggris. Setiap pesan error yang ditampilkan kepada pengguna harus dilokalkan dan dikirim di kolom google.rpc.Status.details, atau dilokalkan oleh klien.
details[]

object

Daftar pesan yang membawa detail error. Ada seperangkat jenis pesan umum untuk digunakan API.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Anotasi Alat

Anotasi alat dikirim ke klien MCP untuk menjelaskan risiko dasar alat tertentu. Sebagian besar klien memperlakukan petunjuk ini sebagai tidak tepercaya, tetapi petunjuk ini dapat digunakan untuk memutuskan kapan perintah konfirmasi dapat dikirim ke pengguna.

Selain string judul, petunjuk boolean berikut ditentukan sebagai berikut:

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

Petunjuk Destruktif: ✅ | Petunjuk Idempoten: ❌ | Petunjuk Hanya Baca: ❌ | Petunjuk Dunia Terbuka: ❌