Configura el registro de auditoría de uso para Gemini Enterprise

En esta guía, se explica cómo los administradores pueden activar y supervisar el registro de auditoría de uso de Gemini Enterprise a través de la API. Los registros de auditoría de uso permiten a las organizaciones hacer un seguimiento de las operaciones del usuario, los metadatos y el contenido principal con fines de auditoría y observabilidad.

Puedes administrar la auditoría de uso de Gemini Enterprise con la configuración de ObservabilityConfig en la app de Gemini Enterprise. Si activas la observabilidad, se capturan los datos de las solicitudes y respuestas, incluidos los metadatos de las instrucciones y la fundamentación, y se almacenan en Cloud Logging.

Antes de comenzar

Antes de configurar los registros de auditoría, asegúrate de tener los siguientes roles de IAM:

Activa el registro de auditoría de uso para las apps

En las siguientes secciones, se describe cómo activar el registro de auditoría de uso cuando creas una app nueva o para una app existente.

Activa el registro de auditoría de uso cuando crees una app

Puedes activar el registro de auditoría de uso cuando crees una app nueva. Para ello, incluye la configuración de observabilityConfig en el comando de creación de la app. Para crear una app nueva con el registro de auditoría de uso activado, ejecuta el siguiente comando:

REST

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "name": "projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID",
  "displayName": "APP_DISPLAY_NAME",
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "searchEngineConfig": {
    "searchTier": "SEARCH_TIER_ENTERPRISE",
    "searchAddOns": ["SEARCH_ADD_ON_LLM"],
    "requiredSubscriptionTier": "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"
  },
  "industryVertical": "GENERIC",
  "appType": "APP_TYPE_INTRANET",
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app que deseas crear.
  • APP_DISPLAY_NAME: Es el nombre visible de la app que deseas crear.

Cómo activar el registro de auditoría de uso para una app existente

Para activar el registro de auditoría de uso en una app existente, ejecuta el siguiente comando:

REST

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app.

Información registrada

En la siguiente tabla, se resumen los datos de uso que registra Gemini Enterprise:

Ruta de servicio Datos registrados
SearchService.Search

Registra los datos de las fuentes que se usan para la fundamentación o como entrada del LLM.

Solicitud:
  • query
  • user_info

Respuesta:
  • attribution_token
  • results.id
AssistantService.Assist

Registra la solicitud y la respuesta del asistente de Gemini Enterprise.

Solicitud:
  • name
  • query.text
  • query.parts

Respuesta:
  • assist_token
  • answer.name
  • answer.state
  • answer.replies.grounded_content.text
  • answer.replies.grounded_content.text_grounding_metadata.segments
  • answer.replies.grounded_content.text_grounding_metadata.references
  • answer.skipped_reasons
AssistantService.StreamAssist Solicitud:
  • name
  • query.text
  • query.parts
  • agents_spec

Respuesta:
  • assist_token
  • answer.name
  • answer.state
  • answer.replies.grounded_content.text
  • answer.replies.grounded_content.text_grounding_metadata.segments
  • answer.replies.grounded_content.text_grounding_metadata.references
  • answer.skipped_reasons
ConversationSearchService.AnswerQuery Solicitud:
  • serving_config
  • query.query_id
  • query.text
  • session
  • user_pseudo_id
  • end_user_spec
  • answer_generation_spec.model_spec.model_version
  • answer_generation_spec.prompt_spec.preamble
  • answer_generation_spec.include_citations
  • answer_generation_spec.answer_language_code
  • answer_generation_spec.ignore_adversarial_query
  • answer_generation_spec.ignore_non_answer_seeking_query
  • answer_generation_spec.ignore_jail_breaking_query

Respuesta:
  • answer
  • answer_query_token
EngineService.CreateEngine Solicitud:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores

Respuesta:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
EngineService.UpdateEngine Solicitud:
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
  • update_mask

Respuesta:
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
AgentService.SetIamPolicy Solicitud:
  • policy.bindings.roles
  • policy.bindings.members

Respuesta:
  • policy.bindings.roles
  • policy.bindings.members
AgentService.CreateAgent Solicitud:
  • parent
  • agent_id
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case

Respuesta:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
AgentService.UpdateAgent Solicitud:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
  • update_mask

Respuesta:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case

Accede a los registros de uso

Para acceder a los registros de auditoría de uso y verlos, sigue estos pasos:

  1. En la consola de Google Cloud , accede a la página Explorador de registros.

    Ir al Explorador de registros

  2. Selecciona el proyecto Google Cloud para el que habilitaste el registro de auditoría.

  3. Para mostrar solo los registros de Gemini Enterprise, ingresa la siguiente consulta en el campo del editor de consultas y haz clic en Ejecutar consulta:

      logName="projects/PROJECT_ID/logs/discoveryengine.googleapis.com%2Fgemini_enterprise_user_activity

    Reemplaza lo siguiente:

    • PROJECT_ID: el ID de tu proyecto.

Cómo desactivar los registros de auditoría de uso de una app

Para desactivar el registro de auditoría de uso, ejecuta el siguiente comando:

REST

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": false,
    "sensitiveLoggingEnabled": false
  }
}'

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app.