Gemini Enterprise for Customer Experience API

Servicio: ces.googleapis.com

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la información que se indica más abajo cuando realices las solicitudes a la API.

Documento de descubrimiento

Un documento de descubrimiento es una especificación legible por máquinas para describir y consumir las APIs de REST. Se usa para compilar bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona el documento de descubrimiento siguiente:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://ces.googleapis.com

Recurso de REST: v1beta.projects.locations

Métodos
get GET /v1beta/{name=projects/*/locations/*}
Obtiene información sobre una ubicación.
getSecuritySettings GET /v1beta/{name=projects/*/locations/*/securitySettings}
Recupera la configuración de seguridad del proyecto y la ubicación.
list GET /v1beta/{name=projects/*}/locations
Enumera la información sobre las ubicaciones compatibles con este servicio.
updateSecuritySettings PATCH /v1beta/{securitySettings.name=projects/*/locations/*/securitySettings}
Actualiza la configuración de seguridad del proyecto y la ubicación.

Recurso de REST: v1beta.projects.locations.apps

Métodos
chatAiAssistant POST /v1beta/{app=projects/*/locations/*/apps/*}:chatAiAssistant
Ejecuta Arc, el asistente de IA, para la sesión de asistente especificada.
create POST /v1beta/{parent=projects/*/locations/*}/apps
Crea una app nueva en el proyecto y la ubicación determinados.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*}
Borra la app especificada.
executeTool POST /v1beta/{parent=projects/*/locations/*/apps/*}:executeTool
Ejecuta la herramienta proporcionada con los argumentos proporcionados.
exportApp POST /v1beta/{name=projects/*/locations/*/apps/*}:exportApp
Exporta la app especificada.
generateAppResource POST /v1beta/{parent=projects/*/locations/*/apps/*}:generateAppResource
Genera recursos específicos (p.ej.,
generateOnboardingSuggestions POST /v1beta/{name=projects/*/locations/*/apps/*}:generateOnboardingSuggestions
Genera sugerencias de capacitación personalizadas para el estado cero de Arc: clasifica al usuario que realiza la solicitud (nuevo, explorando o recurrente) a partir de su historial de sesiones de asistente en la app y devuelve chips de sugerencias (reanudar una sesión, continuar con el trabajo o comenzar algo nuevo) para renderizar antes de que se envíe cualquier mensaje.
get GET /v1beta/{name=projects/*/locations/*/apps/*}
Obtiene detalles de la app especificada.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*}/extendedAgentCard
Obtiene la tarjeta de agente extendida para el agente autenticado.
importApp POST /v1beta/{parent=projects/*/locations/*}/apps:importApp
Importa la app especificada.
importEvaluations POST /v1beta/{parent=projects/*/locations/*/apps/*}:importEvaluations
Importa evaluaciones a la app.
list GET /v1beta/{parent=projects/*/locations/*}/apps
Enumera las apps en la ubicación y el proyecto determinados.
patch PATCH /v1beta/{app.name=projects/*/locations/*/apps/*}
Actualiza la app especificada.
retrieveToolSchema POST /v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema
Recupera el esquema de la herramienta determinada.
runAssistant POST /v1beta/{app=projects/*/locations/*/apps/*}:runAssistant
Ejecuta el agente de asistencia para la sesión de asistencia especificada.
runEvaluation POST /v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation
Ejecuta una evaluación de la app.
testPersonaVoice POST /v1beta/{app=projects/*/locations/*/apps/*}:testPersonaVoice
Prueba la voz de un personaje.

Recurso de REST: v1beta.projects.locations.apps.agents

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Crea un agente nuevo en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Borra el agente especificado.
get GET /v1beta/{name=projects/*/locations/*/apps/*/agents/*}
Obtiene los detalles del agente especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/agents
Enumera los agentes de la app determinada.
patch PATCH /v1beta/{agent.name=projects/*/locations/*/apps/*/agents/*}
Actualiza el agente especificado.

Recurso de REST: v1beta.projects.locations.apps.assistantSessions

Métodos
cancelAssistantTurn POST /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn
Cancela el turno en curso de la sesión del asistente, si lo hay: la detención explícita del usuario para un turno que se ejecuta de forma independiente de cualquier transmisión.
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/assistantSessions
Crea una nueva sesión de asistente en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}
Borra la sesión de asistente especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}
Obtiene los detalles de la sesión de asistente especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/assistantSessions
Enumera todas las sesiones de asistente en la app determinada.
streamChatAiAssistant POST /v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:streamChatAiAssistant
Ejecuta Arc, el asistente de IA, para la sesión de asistente especificada en un formato de transmisión.

Recurso de REST: v1beta.projects.locations.apps.changelogs

Métodos
get GET /v1beta/{name=projects/*/locations/*/apps/*/changelogs/*}
Obtiene el registro de cambios especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/changelogs
Enumera los registros de cambios de la app especificada.

Recurso de REST: v1beta.projects.locations.apps.conversations

Métodos
batchDelete POST /v1beta/{parent=projects/*/locations/*/apps/*}/conversations:batchDelete
Borra por lotes las conversaciones especificadas.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Borra la conversación especificada.
generateEvaluation POST /v1beta/{conversation=projects/*/locations/*/apps/*/conversations/*}:generateEvaluation
Crea una evaluación de referencia a partir de una conversación.
get GET /v1beta/{name=projects/*/locations/*/apps/*/conversations/*}
Obtiene los detalles de la conversación especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/conversations
Enumera las conversaciones de la app determinada.

Recurso de REST: v1beta.projects.locations.apps.deployments

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Crea una implementación nueva en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Borra la implementación especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/deployments/*}
Obtiene los detalles de la implementación especificada.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/extendedAgentCard
Obtiene la tarjeta de agente extendida para el agente autenticado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/deployments
Enumera las implementaciones de la app determinada.
patch PATCH /v1beta/{deployment.name=projects/*/locations/*/apps/*/deployments/*}
Actualiza la implementación especificada.

Recurso de REST: v1beta.projects.locations.apps.deployments.message

Métodos
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:send
Envía un mensaje a un agente.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/deployments/*}/message:stream
Envía un mensaje de transmisión a un agente, lo que permite la interacción en tiempo real y las actualizaciones de estado.

Recurso de REST: v1beta.projects.locations.apps.evaluationDatasets

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Crea un conjunto de datos de evaluación.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Borra un conjunto de datos de evaluación.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Obtiene los detalles del conjunto de datos de evaluación especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationDatasets
Enumera todos los conjuntos de datos de evaluación de la app determinada.
patch PATCH /v1beta/{evaluationDataset.name=projects/*/locations/*/apps/*/evaluationDatasets/*}
Actualiza un conjunto de datos de evaluación.

Recurso de REST: v1beta.projects.locations.apps.evaluationExpectations

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Crea una expectativa de evaluación.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Borra una expectativa de evaluación.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Obtiene los detalles de la expectativa de evaluación especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationExpectations
Enumera todas las expectativas de evaluación de la app determinada.
patch PATCH /v1beta/{evaluationExpectation.name=projects/*/locations/*/apps/*/evaluationExpectations/*}
Actualiza una expectativa de evaluación.

Recurso de REST: v1beta.projects.locations.apps.evaluationRuns

Métodos
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Borra una ejecución de evaluación.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns:export
Exporta ejecuciones de evaluaciones.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluationRuns/*}
Obtiene los detalles de la ejecución de evaluación especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluationRuns
Enumera todas las ejecuciones de evaluación de la app determinada.

Recurso de REST: v1beta.projects.locations.apps.evaluations

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Crea una evaluación.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Borra una evaluación.
export POST /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations:export
Exporta evaluaciones.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}
Obtiene los detalles de la evaluación especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/evaluations
Enumera todas las evaluaciones de la app determinada.
patch PATCH /v1beta/{evaluation.name=projects/*/locations/*/apps/*/evaluations/*}
Actualiza una evaluación.
uploadEvaluationAudio POST /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*}:uploadEvaluationAudio
Sube audio para usarlo en evaluaciones de referencia.

Recurso de REST: v1beta.projects.locations.apps.evaluations.results

Métodos
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Borra un resultado de evaluación.
export POST /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results:export
Exporta los resultados de las evaluaciones.
get GET /v1beta/{name=projects/*/locations/*/apps/*/evaluations/*/results/*}
Obtiene los detalles del resultado de la evaluación especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*/evaluations/*}/results
Enumera todos los resultados de una evaluación determinada.
runEvaluationResultMetrics POST /v1beta/{evaluationResultId=projects/*/locations/*/apps/*/evaluations/*/results/*}:runEvaluationResultMetrics
Ejecuta métricas en un resultado de evaluación existente.

Recurso de REST: v1beta.projects.locations.apps.examples

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Crea un ejemplo nuevo en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Borra el ejemplo especificado.
get GET /v1beta/{name=projects/*/locations/*/apps/*/examples/*}
Obtiene detalles del ejemplo especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/examples
Enumera los ejemplos de la app determinada.
patch PATCH /v1beta/{example.name=projects/*/locations/*/apps/*/examples/*}
Actualiza el ejemplo especificado.

Recurso de REST: v1beta.projects.locations.apps.guardrails

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Crea una nueva barandilla en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Borra la protección especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/guardrails/*}
Obtiene los detalles de la protección especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/guardrails
Enumera las protecciones de la app determinada.
patch PATCH /v1beta/{guardrail.name=projects/*/locations/*/apps/*/guardrails/*}
Actualiza la barandilla especificada.

Recurso de REST: v1beta.projects.locations.apps.message

Métodos
send POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:send
Envía un mensaje a un agente.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*}/message:stream
Envía un mensaje de transmisión a un agente, lo que permite la interacción en tiempo real y las actualizaciones de estado.

Recurso de REST: v1beta.projects.locations.apps.scheduledEvaluationRuns

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Crea una ejecución de evaluación programada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Borra una ejecución de evaluación programada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Obtiene los detalles de la ejecución de evaluación programada especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/scheduledEvaluationRuns
Enumera todas las ejecuciones de evaluación programadas en la app determinada.
patch PATCH /v1beta/{scheduledEvaluationRun.name=projects/*/locations/*/apps/*/scheduledEvaluationRuns/*}
Actualiza una ejecución de evaluación programada.

Recurso de REST: v1beta.projects.locations.apps.sessions

Métodos
generateChatToken POST /v1beta/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken
Genera un token con alcance de sesión para que el widget de chat se autentique con las APIs de sesión.
runSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession
Inicia una interacción de un solo turno con el agente de CES dentro de una sesión.
streamRunSession POST /v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession
Inicia una interacción de un solo turno con el agente de CES.

Recurso de REST: v1beta.projects.locations.apps.tools

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Crea una herramienta nueva en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Borra la herramienta especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/tools/*}
Obtiene detalles de la herramienta especificada.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/tools
Enumera las herramientas de la app determinada.
patch PATCH /v1beta/{tool.name=projects/*/locations/*/apps/*/tools/*}
Actualiza la herramienta especificada.

Recurso de REST: v1beta.projects.locations.apps.toolsets

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Crea un nuevo conjunto de herramientas en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Borra el conjunto de herramientas especificado.
get GET /v1beta/{name=projects/*/locations/*/apps/*/toolsets/*}
Obtiene los detalles del conjunto de herramientas especificado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/toolsets
Enumera los conjuntos de herramientas de la app determinada.
patch PATCH /v1beta/{toolset.name=projects/*/locations/*/apps/*/toolsets/*}
Actualiza el conjunto de herramientas especificado.
retrieveTools POST /v1beta/{toolset=projects/*/locations/*/apps/*/toolsets/*}:retrieveTools
Recupera la lista de herramientas incluidas en el conjunto de herramientas especificado.

Recurso de REST: v1beta.projects.locations.apps.versions

Métodos
create POST /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Crea una nueva versión de la app en la app determinada.
delete DELETE /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Borra la versión de la app especificada.
get GET /v1beta/{name=projects/*/locations/*/apps/*/versions/*}
Obtiene detalles de la versión de la app especificada.
getExtendedAgentCard GET /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/extendedAgentCard
Obtiene la tarjeta de agente extendida para el agente autenticado.
list GET /v1beta/{parent=projects/*/locations/*/apps/*}/versions
Enumera todas las versiones de la app determinada.
patch PATCH /v1beta/{appVersion.name=projects/*/locations/*/apps/*/versions/*}
Actualiza la versión de la app especificada.
restore POST /v1beta/{name=projects/*/locations/*/apps/*/versions/*}:restore
Restablece la versión de la app especificada.

Recurso de REST: v1beta.projects.locations.apps.versions.message

Métodos
send POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:send
Envía un mensaje a un agente.
stream POST /v1beta/{tenant=projects/*/locations/*/apps/*/versions/*}/message:stream
Envía un mensaje de transmisión a un agente, lo que permite la interacción en tiempo real y las actualizaciones de estado.

Recurso de REST: v1beta.projects.locations.operations

Métodos
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
Inicia la cancelación asíncrona de una operación de larga duración.
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Borra una operación de larga duración.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Obtiene el último estado de una operación de larga duración.
list GET /v1beta/{name=projects/*/locations/*}/operations
Enumera las operaciones que coinciden con el filtro especificado en la solicitud.