Gemini Enterprise for Customer Experience API

Dienst: ces.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, sollten Sie die folgenden Informationen verwenden, wenn Sie die API-Anfragen senden.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Der Dienst bietet das folgende Discovery-Dokument:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://ces.googleapis.com

REST-Ressource: v1beta.projects.locations

Methoden
get GET /v1beta/{name=projects/*/locations/*}
Ruft Informationen zu einer Zone ab.
getSecuritySettings GET /v1beta/{name=projects/*/locations/*/securitySettings}
Ruft die Sicherheitseinstellungen für das Projekt und den Standort ab.
list GET /v1beta/{name=projects/*}/locations
Listet Informationen zu den unterstützten Zonen für diesen Dienst auf.
updateSecuritySettings PATCH /v1beta/{securitySettings.name=projects/*/locations/*/securitySettings}
Aktualisiert die Sicherheitseinstellungen für das Projekt und den Standort.

REST-Ressource: v1beta.projects.locations.apps

Methoden
create POST /v1beta/{parent=projects/*/locations/*}/apps
Erstellt eine neue App im angegebenen Projekt und am angegebenen Standort.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*}
Löscht die angegebene App.
executeTool POST /v1beta/{parent=projects/*/locations/*/apps/*}:executeTool
Führt das angegebene Tool mit den angegebenen Argumenten aus.
exportApp POST /v1beta/{name=projects/*/locations/*/apps/*}:exportApp
Exportiert die angegebene App.
generateAppResource POST /v1beta/{parent=projects/*/locations/*/apps/*}:generateAppResource
Generiert bestimmte Ressourcen (z.B.
get GET /v1beta/{name=projects/*/locations/*/apps/*}
Ruft Details zur angegebenen App ab.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
Ruft die erweiterte Agentenkarte für den authentifizierten Agenten ab.
importApp POST /v1beta/{parent=projects/*/locations/*}/apps:importApp
Importiert die angegebene App.
importEvaluations POST /v1beta/{parent=projects/*/locations/*/apps/*}:importEvaluations
Importiert Bewertungen in die App.
list GET /v1beta/{parent=projects/*/locations/*}/apps
Listet Apps im angegebenen Projekt und am angegebenen Standort auf.
patch PATCH /v1beta/{app.name=projects/*/locations/*/apps/*}
Aktualisiert die angegebene App.
retrieveToolSchema POST /v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
Ruft das Schema des angegebenen Tools ab.
runEvaluation POST /v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation
Führt eine Bewertung der App aus.
testPersonaVoice POST /v1beta/{app=projects/*/locations/*/apps/*}:testPersonaVoice
Testet die Stimme einer Persona.

REST-Ressource: v1beta.projects.locations.apps.agents

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Erstellt einen neuen Agenten in der angegebenen App.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Löscht den angegebenen Agent.
get GET /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Ruft Details zum angegebenen Agent ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Listet Agenten in der angegebenen App auf.
patch PATCH /v1beta/{agent.name=projects/*/locations/*/apps/*/agents/*}
Aktualisiert den angegebenen Agent.

REST-Ressource: v1beta.projects.locations.apps.changelogs

Methoden
get GET /v1beta/{name=projects/*/locations/*/apps/*/changelogs/*}
Ruft das angegebene Changelog ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/changelogs
Listet die Änderungsprotokolle der angegebenen App auf.

REST-Ressource: v1beta.projects.locations.apps.conversations

Methoden
batchDelete POST /v1beta/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
Löscht die angegebenen Unterhaltungen im Batch.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Löscht die angegebene Unterhaltung.
generateEvaluation POST /v1beta/{conversation=projects/*/locations/*/apps/*/conversations/*}:generateEvaluation
Erstellt eine Golden-Bewertung aus einer Unterhaltung.
get GET /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Ruft Details zur angegebenen Unterhaltung ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/conversations
Listet Unterhaltungen in der angegebenen App auf.

REST-Ressource: v1beta.projects.locations.apps.deployments

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Erstellt ein neues Deployment in der angegebenen App.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Löscht das angegebene Deployment.
get GET /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Ruft Details zur angegebenen Bereitstellung ab.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard
Ruft die erweiterte Agentenkarte für den authentifizierten Agenten ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Listet Deployments in der angegebenen App auf.
patch PATCH /v1beta/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
Aktualisiert die angegebene Bereitstellung.

REST-Ressource: v1beta.projects.locations.apps.deployments.message

Methoden
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
Sendet eine Nachricht an einen Agent.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream
Sendet eine Streaming-Nachricht an einen Kundenservicemitarbeiter, um Echtzeitinteraktionen und Statusaktualisierungen zu ermöglichen.

REST-Ressource: v1beta.projects.locations.apps.evaluationDatasets

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Erstellt ein Bewertungs-Dataset.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Löscht ein Bewertungs-Dataset.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Ruft Details zum angegebenen Bewertungs-Dataset ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Listet alle Bewertungs-Datasets in der angegebenen App auf.
patch PATCH /v1beta/{evaluationDataset.name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Aktualisiert ein Bewertungs-Dataset.

REST-Ressource: v1beta.projects.locations.apps.evaluationExpectations

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Erstellt eine Erwartung für die Bewertung.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Löscht eine Erwartung für die Bewertung.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Ruft Details zur angegebenen Erwartung für die Bewertung ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Listet alle Erwartungen für die Überprüfung in der angegebenen App auf.
patch PATCH /v1beta/{evaluationExpectation.name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Aktualisiert eine Erwartung für die Bewertung.

REST-Ressource: v1beta.projects.locations.apps.evaluationRuns

Methoden
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Löscht einen Bewertungsdurchlauf.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns:export
Exportiert Bewertungsausführungen.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Ruft Details zum angegebenen Auswertungsdurchlauf ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns
Listet alle Testläufe in der angegebenen App auf.

REST-Ressource: v1beta.projects.locations.apps.evaluations

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Erstellt eine Bewertung.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Löscht eine Bewertung.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations:export
Exportiert Bewertungen.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Ruft Details zur angegebenen Auswertung ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Listet alle Bewertungen in der angegebenen App auf.
patch PATCH /v1beta/{evaluation.name=projects/*/locations/*/apps/*/evaluations/*}
Aktualisiert eine Bewertung.
uploadEvaluationAudio POST /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}:uploadEvaluationAudio
Lädt Audioinhalte zur Verwendung in Golden Evaluations hoch.

REST-Ressource: v1beta.projects.locations.apps.evaluations.results

Methoden
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Löscht ein Bewertungsergebnis.
export POST /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results:export
Exportiert die Ergebnisse der Auswertung.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Ruft Details zum angegebenen Bewertungsergebnis ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results
Listet alle Bewertungsergebnisse für eine bestimmte Bewertung auf.
runEvaluationResultMetrics POST /v1beta/{evaluationResultId=projects/*/locations/*/apps/*/evaluations/*/results/*}:runEvaluationResultMetrics
Führt Messwerte für ein vorhandenes Bewertungsergebnis aus.

REST-Ressource: v1beta.projects.locations.apps.examples

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Erstellt ein neues Beispiel in der angegebenen App.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Löscht das angegebene Beispiel.
get GET /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Ruft Details zum angegebenen Beispiel ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Listet Beispiele in der angegebenen App auf.
patch PATCH /v1beta/{example.name=projects/*/locations/*/apps/*/examples/*}
Aktualisiert das angegebene Beispiel.

REST-Ressource: v1beta.projects.locations.apps.guardrails

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Erstellt eine neue Leitlinie in der angegebenen App.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Löscht die angegebene Guardrail.
get GET /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Ruft Details zur angegebenen Richtlinie ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Listet die Schutzmaßnahmen in der angegebenen App auf.
patch PATCH /v1beta/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
Aktualisiert die angegebene Richtlinie.

REST-Ressource: v1beta.projects.locations.apps.message

Methoden
send POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:send
Sendet eine Nachricht an einen Agent.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:stream
Sendet eine Streaming-Nachricht an einen Kundenservicemitarbeiter, um Echtzeitinteraktionen und Statusaktualisierungen zu ermöglichen.

REST-Ressource: v1beta.projects.locations.apps.scheduledEvaluationRuns

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Erstellt einen geplanten Bewertungsdurchlauf.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Löscht eine geplante Bewertungsausführung.
get GET /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Ruft Details zum angegebenen geplanten Ausführen der Auswertung ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Listet alle geplanten Ausführungen von Bewertungen in der angegebenen App auf.
patch PATCH /v1beta/{scheduledEvaluationRun.name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Aktualisiert eine geplante Bewertungsausführung.

REST-Ressource: v1beta.projects.locations.apps.sessions

Methoden
generateChatToken POST /v1beta/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken
Generiert ein sitzungsbezogenes Token für das Chat-Widget zur Authentifizierung bei Session APIs.
runSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
Startet eine Interaktion mit dem CES-Agenten in einer Sitzung.
streamRunSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
Leitet eine einmalige Interaktion mit dem CES-Agenten ein.

REST-Ressource: v1beta.projects.locations.apps.tools

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Erstellt ein neues Tool in der angegebenen App.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Löscht das angegebene Tool.
get GET /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Ruft Details zum angegebenen Tool ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Listet Tools in der angegebenen App auf.
patch PATCH /v1beta/{tool.name=projects/*/locations/*/apps/*/tools/*}
Aktualisiert das angegebene Tool.

REST-Ressource: v1beta.projects.locations.apps.toolsets

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Erstellt ein neues Toolset in der angegebenen App.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Löscht das angegebene Toolset.
get GET /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Ruft Details zum angegebenen Toolset ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Listet Toolsets in der angegebenen App auf.
patch PATCH /v1beta/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
Aktualisiert das angegebene Toolset.
retrieveTools POST /v1beta/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
Ruft die Liste der Tools ab, die im angegebenen Toolset enthalten sind.

REST-Ressource: v1beta.projects.locations.apps.versions

Methoden
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Erstellt eine neue App-Version in der angegebenen App.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Löscht die angegebene App-Version.
get GET /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Ruft Details zur angegebenen App-Version ab.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard
Ruft die erweiterte Agentenkarte für den authentifizierten Agenten ab.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Listet alle App-Versionen in der angegebenen App auf.
patch PATCH /v1beta/{appVersion.name=projects/*/locations/*/apps/*/versions/*}
Aktualisiert die angegebene App-Version.
restore POST /v1beta/{name=projects/*/locations/*/apps/*/versions/*}:restore
Stellt die angegebene App-Version wieder her.

REST-Ressource: v1beta.projects.locations.apps.versions.message

Methoden
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
Sendet eine Nachricht an einen Agent.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream
Sendet eine Streaming-Nachricht an einen Kundenservicemitarbeiter, um Echtzeitinteraktionen und Statusaktualisierungen zu ermöglichen.

REST-Ressource: v1beta.projects.locations.operations

Methoden
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
Startet den asynchronen Abbruch eines Vorgangs mit langer Ausführungszeit.
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Löscht einen Vorgang mit langer Ausführungszeit.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Ruft den letzten Status eines Vorgangs mit langer Ausführungszeit ab.
list GET /v1beta/{name=projects/*/locations/*}/operations
Listet Vorgänge auf, die zu dem angegebenen Filter in der Anfrage passen.