Gemini Enterprise for Customer Experience API

Layanan: ces.googleapis.com

Untuk memanggil layanan ini, sebaiknya gunakan library klien yang disediakan Google. Jika aplikasi Anda perlu menggunakan library Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat membuat permintaan API.

Dokumen discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca komputer untuk mendeskripsikan dan menggunakan REST API. Dokumen ini digunakan untuk membuat library klien, plugin IDE, dan alat lainnya yang berinteraksi dengan Google API. Satu layanan dapat menyediakan beberapa dokumen discovery. Layanan ini menyediakan dokumen penemuan berikut:

Endpoint layanan

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan dapat memiliki beberapa endpoint layanan. Layanan ini memiliki endpoint layanan berikut dan semua URI di bawah didasarkan pada endpoint layanan ini:

  • https://ces.googleapis.com

REST Resource: v1beta.projects.locations

Metode
get GET /v1beta/{name=projects/*/locations/*}
Mendapatkan informasi tentang suatu lokasi.
getSecuritySettings GET /v1beta/{name=projects/*/locations/*/securitySettings}
Mengambil setelan keamanan untuk project dan lokasi.
list GET /v1beta/{name=projects/*}/locations
Mencantumkan informasi tentang lokasi yang didukung untuk layanan ini.
updateSecuritySettings PATCH /v1beta/{securitySettings.name=projects/*/locations/*/securitySettings}
Memperbarui setelan keamanan untuk project dan lokasi.

REST Resource: v1beta.projects.locations.apps

Metode
create POST /v1beta/{parent=projects/*/locations/*}/apps
Membuat aplikasi baru di project dan lokasi tertentu.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*}
Menghapus aplikasi yang ditentukan.
executeTool POST /v1beta/{parent=projects/*/locations/*/apps/*}:executeTool
Menjalankan alat yang diberikan dengan argumen yang diberikan.
exportApp POST /v1beta/{name=projects/*/locations/*/apps/*}:exportApp
Mengekspor aplikasi yang ditentukan.
generateAppResource POST /v1beta/{parent=projects/*/locations/*/apps/*}:generateAppResource
Membuat materi ajar tertentu (misalnya
get GET /v1beta/{name=projects/*/locations/*/apps/*}
Mendapatkan detail aplikasi yang ditentukan.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
Mendapatkan kartu agen yang diperluas untuk agen yang diautentikasi.
importApp POST /v1beta/{parent=projects/*/locations/*}/apps:importApp
Mengimpor aplikasi yang ditentukan.
importEvaluations POST /v1beta/{parent=projects/*/locations/*/apps/*}:importEvaluations
Mengimpor evaluasi ke dalam aplikasi.
list GET /v1beta/{parent=projects/*/locations/*}/apps
Mencantumkan aplikasi dalam project dan lokasi tertentu.
patch PATCH /v1beta/{app.name=projects/*/locations/*/apps/*}
Memperbarui aplikasi yang ditentukan.
retrieveToolSchema POST /v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
Mengambil skema alat yang ditentukan.
runEvaluation POST /v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation
Menjalankan evaluasi aplikasi.
testPersonaVoice POST /v1beta/{app=projects/*/locations/*/apps/*}:testPersonaVoice
Menguji suara persona.

REST Resource: v1beta.projects.locations.apps.agents

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Membuat agen baru di aplikasi yang diberikan.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Menghapus agen yang ditentukan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Mendapatkan detail agen yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Mencantumkan agen di aplikasi tertentu.
patch PATCH /v1beta/{agent.name=projects/*/locations/*/apps/*/agents/*}
Memperbarui agen yang ditentukan.

REST Resource: v1beta.projects.locations.apps.changelogs

Metode
get GET /v1beta/{name=projects/*/locations/*/apps/*/changelogs/*}
Mendapatkan log perubahan yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/changelogs
Mencantumkan log perubahan aplikasi yang ditentukan.

REST Resource: v1beta.projects.locations.apps.conversations

Metode
batchDelete POST /v1beta/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
Menghapus percakapan tertentu secara batch.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Menghapus percakapan yang ditentukan.
generateEvaluation POST /v1beta/{conversation=projects/*/locations/*/apps/*/conversations/*}:generateEvaluation
Membuat evaluasi standar dari percakapan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Mendapatkan detail percakapan yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/conversations
Mencantumkan percakapan di aplikasi tertentu.

REST Resource: v1beta.projects.locations.apps.deployments

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Membuat deployment baru di aplikasi yang diberikan.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Menghapus deployment yang ditentukan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Mendapatkan detail deployment yang ditentukan.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard
Mendapatkan kartu agen yang diperluas untuk agen yang diautentikasi.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Mencantumkan deployment di aplikasi tertentu.
patch PATCH /v1beta/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
Memperbarui deployment yang ditentukan.

REST Resource: v1beta.projects.locations.apps.deployments.message

Metode
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
Mengirim pesan ke agen.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream
Mengirim pesan streaming ke agen, sehingga memungkinkan interaksi dan pembaruan status secara real-time.

REST Resource: v1beta.projects.locations.apps.evaluationDatasets

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Membuat set data evaluasi.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Menghapus set data evaluasi.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Mendapatkan detail set data evaluasi yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Mencantumkan semua set data evaluasi di aplikasi tertentu.
patch PATCH /v1beta/{evaluationDataset.name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Memperbarui set data evaluasi.

REST Resource: v1beta.projects.locations.apps.evaluationExpectations

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Membuat ekspektasi evaluasi.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Menghapus ekspektasi evaluasi.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Mendapatkan detail ekspektasi evaluasi yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Mencantumkan semua ekspektasi evaluasi di aplikasi tertentu.
patch PATCH /v1beta/{evaluationExpectation.name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Memperbarui ekspektasi evaluasi.

REST Resource: v1beta.projects.locations.apps.evaluationRuns

Metode
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Menghapus proses evaluasi.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns:export
Mengekspor eksekusi evaluasi.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Mendapatkan detail proses evaluasi yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns
Mencantumkan semua proses evaluasi di aplikasi tertentu.

REST Resource: v1beta.projects.locations.apps.evaluations

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Membuat evaluasi.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Menghapus evaluasi.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations:export
Mengekspor evaluasi.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Mendapatkan detail evaluasi yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Mencantumkan semua evaluasi di aplikasi tertentu.
patch PATCH /v1beta/{evaluation.name=projects/*/locations/*/apps/*/evaluations/*}
Memperbarui evaluasi.
uploadEvaluationAudio POST /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}:uploadEvaluationAudio
Mengupload audio untuk digunakan dalam Evaluasi Golden.

REST Resource: v1beta.projects.locations.apps.evaluations.results

Metode
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Menghapus hasil evaluasi.
export POST /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results:export
Mengekspor hasil evaluasi.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Mendapatkan detail hasil evaluasi yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results
Mencantumkan semua hasil evaluasi untuk evaluasi tertentu.
runEvaluationResultMetrics POST /v1beta/{evaluationResultId=projects/*/locations/*/apps/*/evaluations/*/results/*}:runEvaluationResultMetrics
Menjalankan metrik pada hasil evaluasi yang ada.

REST Resource: v1beta.projects.locations.apps.examples

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Membuat contoh baru di aplikasi yang diberikan.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Menghapus contoh yang ditentukan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Mendapatkan detail contoh yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Mencantumkan contoh di aplikasi tertentu.
patch PATCH /v1beta/{example.name=projects/*/locations/*/apps/*/examples/*}
Memperbarui contoh yang ditentukan.

REST Resource: v1beta.projects.locations.apps.guardrails

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Membuat pembatasan baru di aplikasi yang diberikan.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Menghapus pembatasan yang ditentukan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Mendapatkan detail pembatasan yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Mencantumkan batas aman dalam aplikasi tertentu.
patch PATCH /v1beta/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
Memperbarui batas aman yang ditentukan.

REST Resource: v1beta.projects.locations.apps.message

Metode
send POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:send
Mengirim pesan ke agen.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:stream
Mengirim pesan streaming ke agen, sehingga memungkinkan interaksi dan pembaruan status secara real-time.

REST Resource: v1beta.projects.locations.apps.scheduledEvaluationRuns

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Membuat eksekusi evaluasi terjadwal.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Menghapus proses evaluasi terjadwal.
get GET /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Mendapatkan detail operasi evaluasi terjadwal yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Mencantumkan semua proses evaluasi terjadwal di aplikasi tertentu.
patch PATCH /v1beta/{scheduledEvaluationRun.name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Memperbarui proses evaluasi terjadwal.

REST Resource: v1beta.projects.locations.apps.sessions

Metode
generateChatToken POST /v1beta/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken
Membuat token cakupan sesi untuk widget chat agar dapat diautentikasi dengan Session API.
runSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
Memulai interaksi satu giliran dengan agen CES dalam sesi.
streamRunSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
Memulai interaksi satu giliran dengan agen CES.

REST Resource: v1beta.projects.locations.apps.tools

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Membuat alat baru di aplikasi tertentu.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Menghapus alat yang ditentukan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Mendapatkan detail alat yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Mencantumkan alat di aplikasi tertentu.
patch PATCH /v1beta/{tool.name=projects/*/locations/*/apps/*/tools/*}
Memperbarui alat yang ditentukan.

REST Resource: v1beta.projects.locations.apps.toolsets

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Membuat toolset baru di aplikasi yang diberikan.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Menghapus toolset yang ditentukan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Mendapatkan detail toolset yang ditentukan.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Mencantumkan kumpulan alat di aplikasi tertentu.
patch PATCH /v1beta/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
Memperbarui toolset yang ditentukan.
retrieveTools POST /v1beta/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
Mengambil daftar alat yang disertakan dalam toolset yang ditentukan.

REST Resource: v1beta.projects.locations.apps.versions

Metode
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Membuat versi aplikasi baru di aplikasi yang diberikan.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Menghapus versi aplikasi yang ditentukan.
get GET /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Mendapatkan detail versi aplikasi yang ditentukan.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard
Mendapatkan kartu agen yang diperluas untuk agen yang diautentikasi.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Mencantumkan semua versi aplikasi di aplikasi tertentu.
restore POST /v1beta/{name=projects/*/locations/*/apps/*/versions/*}:restore
Memulihkan versi aplikasi yang ditentukan.

REST Resource: v1beta.projects.locations.apps.versions.message

Metode
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
Mengirim pesan ke agen.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream
Mengirim pesan streaming ke agen, sehingga memungkinkan interaksi dan pembaruan status secara real-time.

REST Resource: v1beta.projects.locations.operations

Metode
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
Memulai pembatalan asinkron pada operasi yang berjalan lama.
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Menghapus operasi yang berjalan lama.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Mendapatkan status terbaru dari operasi yang berjalan lama.
list GET /v1beta/{name=projects/*/locations/*}/operations
Menampilkan operasi yang sesuai dengan filter yang ditentukan dalam permintaan.