Configura la registrazione dei log di controllo dell'utilizzo per Gemini Enterprise

Questa guida spiega come gli amministratori possono attivare e monitorare la registrazione del controllo dell'utilizzo per Gemini Enterprise tramite l'API. I log di controllo dell'utilizzo consentono alle organizzazioni di monitorare le operazioni degli utenti, i metadati e i contenuti principali a scopo di controllo e osservabilità.

Puoi gestire il controllo dell'utilizzo di Gemini Enterprise utilizzando le impostazioni ObservabilityConfig nell'app Gemini Enterprise. L'attivazione dell'osservabilità acquisisce i dati di richiesta e risposta, inclusi prompt e metadati di grounding, e li archivia in Cloud Logging.

Prima di iniziare

Prima di configurare i log di controllo, assicurati di disporre dei seguenti ruoli IAM:

Attivare l'audit logging dell'utilizzo per le app

Le sezioni seguenti descrivono come attivare la registrazione degli audit di utilizzo durante la creazione di una nuova app o per un'app esistente.

Attiva l'audit logging dell'utilizzo durante la creazione di un'app

Puoi attivare la registrazione del controllo dell'utilizzo quando crei una nuova app includendo le impostazioni observabilityConfig nel comando di creazione dell'app. Per creare una nuova app con la registrazione di controllo dell'utilizzo attivata, esegui questo 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
  }
}'

Sostituisci quanto segue:

  • ENDPOINT_LOCATION: la multiregione per la tua richiesta API. Specifica uno dei seguenti valori:
    • us per la multi-regione Stati Uniti
    • eu per la multiregione EU
    • global per la località globale
    Per saperne di più, consulta Specifica una regione multipla per il datastore.
  • PROJECT_ID: l'ID progetto.
  • LOCATION: la multiregione del datastore: global, us o eu
  • APP_ID: l'ID dell'app che vuoi creare.
  • APP_DISPLAY_NAME: il nome visualizzato dell'app che vuoi creare.

Attiva l'audit logging dell'utilizzo per un'app esistente

Per attivare la registrazione di audit dell'utilizzo in un'app esistente, esegui questo 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
  }
}'

Sostituisci quanto segue:

  • ENDPOINT_LOCATION: la multiregione per la tua richiesta API. Specifica uno dei seguenti valori:
    • us per la multi-regione Stati Uniti
    • eu per la multiregione EU
    • global per la località globale
    Per saperne di più, consulta Specifica una regione multipla per il datastore.
  • PROJECT_ID: l'ID progetto.
  • LOCATION: la multiregione del datastore: global, us o eu
  • APP_ID: l'ID dell'app.

Informazioni registrate

La tabella seguente riepiloga i dati di utilizzo registrati da Gemini Enterprise:

Percorso del servizio Dati registrati
SearchService.Search

Registra i dati sulle fonti utilizzate per la base o come input LLM.

Richiesta:
  • query
  • user_info

Risposta:
  • attribution_token
  • results.id
AssistantService.Assist

Registra la richiesta e la risposta dell'assistente Gemini Enterprise.

Richiesta:
  • name
  • query.text
  • query.parts

Risposta:
  • 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 Richiesta:
  • name
  • query.text
  • query.parts
  • agents_spec

Risposta:
  • 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 Richiesta:
  • 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

Risposta:
  • answer
  • answer_query_token
EngineService.CreateEngine Richiesta:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores

Risposta:
  • engine_id
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
EngineService.UpdateEngine Richiesta:
  • engine.name
  • engine.create_time
  • engine.display_name
  • engine.update_time
  • engine.data_store_ids
  • engine.data_stores
  • update_mask

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

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

Risposta:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
AgentService.UpdateAgent Richiesta:
  • agent.name
  • agent.display_name
  • agent.create_time
  • agent.update_time
  • agent.definition_case
  • update_mask

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

Accedere ai log di utilizzo

Per accedere ai log di controllo dell'utilizzo e visualizzarli:

  1. Nella console Google Cloud , vai alla pagina Esplora log.

    Vai a Esplora log.

  2. Seleziona il progetto Google Cloud per cui hai attivato l'audit logging.

  3. Per visualizzare solo i log di Gemini Enterprise, inserisci la seguente query nel campo dell'editor query e fai clic su Esegui query:

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

    Sostituisci quanto segue:

    • PROJECT_ID: l'ID progetto.

Disattivare gli audit log di utilizzo per un'app

Per disattivare la registrazione degli audit log di utilizzo, esegui questo 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
  }
}'

Sostituisci quanto segue:

  • ENDPOINT_LOCATION: la multiregione per la tua richiesta API. Specifica uno dei seguenti valori:
    • us per la multi-regione Stati Uniti
    • eu per la multiregione EU
    • global per la località globale
    Per saperne di più, consulta Specifica una regione multipla per il datastore.
  • PROJECT_ID: l'ID progetto.
  • LOCATION: la multiregione del datastore: global, us o eu
  • APP_ID: l'ID dell'app.