Gemini Enterprise for Customer Experience API

Service: ces.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://ces.googleapis.com

REST Resource: v1beta.projects.locations

Methods
get GET /v1beta/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1beta/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta.projects.locations.apps

Methods
create POST /v1beta/{parent=projects/*/locations/*}/apps
Creates a new app in the given project and location.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*}
Deletes the specified app.
executeTool POST /v1beta/{parent=projects/*/locations/*/apps/*}:executeTool
Executes the given tool with the given arguments.
exportApp POST /v1beta/{name=projects/*/locations/*/apps/*}:exportApp
Exports the specified app.
get GET /v1beta/{name=projects/*/locations/*/apps/*}
Gets details of the specified app.
importApp POST /v1beta/{parent=projects/*/locations/*}/apps:importApp
Imports the specified app.
importEvaluations POST /v1beta/{parent=projects/*/locations/*/apps/*}:importEvaluations
Imports evaluations into the app.
list GET /v1beta/{parent=projects/*/locations/*}/apps
Lists apps in the given project and location.
patch PATCH /v1beta/{app.name=projects/*/locations/*/apps/*}
Updates the specified app.
retrieveToolSchema POST /v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
Retrieve the schema of the given tool.
runEvaluation POST /v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation
Runs an evaluation of the app.
testPersonaVoice POST /v1beta/{app=projects/*/locations/*/apps/*}:testPersonaVoice
Tests the voice of a persona.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Creates a new agent in the given app.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Deletes the specified agent.
get GET /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Gets details of the specified agent.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Lists agents in the given app.
patch PATCH /v1beta/{agent.name=projects/*/locations/*/apps/*/agents/*}
Updates the specified agent.

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

Methods
get GET /v1beta/{name=projects/*/locations/*/apps/*/changelogs/*}
Gets the specified changelog.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/changelogs
Lists the changelogs of the specified app.

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

Methods
batchDelete POST /v1beta/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
Batch deletes the specified conversations.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Deletes the specified conversation.
generateEvaluation POST /v1beta/{conversation=projects/*/locations/*/apps/*/conversations/*}:generateEvaluation
Creates a golden evaluation from a conversation.
get GET /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Gets details of the specified conversation.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/conversations
Lists conversations in the given app.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Creates a new deployment in the given app.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Deletes the specified deployment.
get GET /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Gets details of the specified deployment.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Lists deployments in the given app.
patch PATCH /v1beta/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
Updates the specified deployment.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Creates an evaluation dataset.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Deletes an evaluation dataset.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Gets details of the specified evaluation dataset.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Lists all evaluation datasets in the given app.
patch PATCH /v1beta/{evaluationDataset.name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Updates an evaluation dataset.

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

Methods
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Deletes an evaluation run.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Gets details of the specified evaluation run.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns
Lists all evaluation runs in the given app.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Creates an evaluation.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Deletes an evaluation.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Gets details of the specified evaluation.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Lists all evaluations in the given app.
patch PATCH /v1beta/{evaluation.name=projects/*/locations/*/apps/*/evaluations/*}
Updates an evaluation.

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

Methods
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Deletes an evaluation result.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Gets details of the specified evaluation result.
list GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results
Lists all evaluation results for a given evaluation.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Creates a new example in the given app.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Deletes the specified example.
get GET /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Gets details of the specified example.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Lists examples in the given app.
patch PATCH /v1beta/{example.name=projects/*/locations/*/apps/*/examples/*}
Updates the specified example.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Creates a new guardrail in the given app.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Deletes the specified guardrail.
get GET /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Gets details of the specified guardrail.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Lists guardrails in the given app.
patch PATCH /v1beta/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
Updates the specified guardrail.

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

Methods
runSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
Initiates a single turn interaction with the CES agent within a session.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Creates a new tool in the given app.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Deletes the specified tool.
get GET /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Gets details of the specified tool.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Lists tools in the given app.
patch PATCH /v1beta/{tool.name=projects/*/locations/*/apps/*/tools/*}
Updates the specified tool.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Creates a new toolset in the given app.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Deletes the specified toolset.
get GET /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Gets details of the specified toolset.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Lists toolsets in the given app.
patch PATCH /v1beta/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
Updates the specified toolset.
retrieveTools POST /v1beta/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
Retrieve the list of tools included in the specified toolset.

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

Methods
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Creates a new app version in the given app.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Deletes the specified app version.
get GET /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Gets details of the specified app version.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Lists all app versions in the given app.
restore POST /v1beta/{name=projects/*/locations/*/apps/*/versions/*}:restore
Restores the specified app version.

REST Resource: v1beta.projects.locations.operations

Methods
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.