Configurar a geração de registros de auditoria de uso do Gemini Enterprise

Este guia explica como os administradores podem ativar e monitorar o registro em log de auditoria de uso do Gemini Enterprise pela API. Com os registros de auditoria de uso, as organizações podem rastrear operações de usuários, metadados e conteúdo principal para fins de auditoria e observabilidade.

É possível gerenciar a auditoria de uso do Gemini Enterprise usando as configurações de ObservabilityConfig no app Gemini Enterprise. Ao ativar a capacidade de observação, os dados de solicitação e resposta são capturados, incluindo comandos e metadados de embasamento, e armazenados no Cloud Logging.

Antes de começar

Antes de configurar os registros de auditoria, verifique se você tem os seguintes papéis do IAM:

Ativar o registro de auditoria de uso para apps

As seções a seguir descrevem como ativar o registro de auditoria de uso ao criar um app ou para um app já existente.

Ativar o registro de auditoria de uso ao criar um app

É possível ativar o registro de auditoria de uso ao criar um app incluindo as configurações observabilityConfig no comando de criação do app. Para criar um app com o registro de auditoria de uso ativado, execute o seguinte 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
  }
}'

Substitua:

  • ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:
    • us para a multirregião dos EUA
    • eu para a multirregião da UE
    • global para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: ID do projeto.
  • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
  • APP_ID: o ID do app que você quer criar.
  • APP_DISPLAY_NAME: o nome de exibição do app que você quer criar.

Ativar o registro de auditoria de uso para um app atual

Para ativar o registro de auditoria de uso em um app, execute o seguinte 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
  }
}'

Substitua:

  • ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:
    • us para a multirregião dos EUA
    • eu para a multirregião da UE
    • global para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: ID do projeto.
  • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
  • APP_ID: o ID do app.

Informações registradas

A tabela a seguir resume os dados de uso registrados pelo Gemini Enterprise:

Caminho do serviço Dados registrados
SearchService.Search

Registra os dados nas fontes usadas para embasamento ou como entrada de LLM.

Solicitação:
  • query
  • user_info

Resposta:
  • attribution_token
  • results.id
AssistantService.Assist

Registra a solicitação e a resposta do assistente do Gemini Enterprise.

Solicitação:
  • name
  • query.text
  • query.parts

Resposta:
  • 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 Solicitação:
  • name
  • query.text
  • query.parts
  • agents_spec

Resposta:
  • 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 Solicitação:
  • 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

Resposta:
  • answer
  • answer_query_token
EngineService.CreateEngine Solicitação:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores

Resposta:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
EngineService.UpdateEngine Solicitação:
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
  • update_mask

Resposta:
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
AgentService.SetIamPolicy Solicitação:
  • policy.bindings.roles
  • policy.bindings.members

Resposta:
  • policy.bindings.roles
  • policy.bindings.members
AgentService.CreateAgent Solicitação:
  • parent
  • agent_id
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case

Resposta:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
AgentService.UpdateAgent Solicitação:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
  • update_mask

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

Acessar registros de uso

Para acessar e ver os registros de auditoria de uso, siga estas etapas:

  1. No console do Google Cloud , acesse a página Análise de registros.

    Acessar a Análise de registros

  2. Selecione o projeto Google Cloud em que você ativou a geração de registros de auditoria.

  3. Para mostrar apenas os registros do Gemini Enterprise, insira a seguinte consulta no campo do editor de consultas e clique em Executar consulta:

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

    Substitua:

    • PROJECT_ID: ID do projeto.

Desativar os registros de auditoria de uso de um app

Para desativar o registro de auditoria de uso, execute o seguinte 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
  }
}'

Substitua:

  • ENDPOINT_LOCATION: a multirregião da sua solicitação de API. Especifique um dos seguintes valores:
    • us para a multirregião dos EUA
    • eu para a multirregião da UE
    • global para o local global
    Para mais informações, consulte Especificar uma multirregião para seu repositório de dados.
  • PROJECT_ID: ID do projeto.
  • LOCATION: a multirregião do seu repositório de dados: global, us ou eu
  • APP_ID: o ID do app.