Configura el registro

En este documento, se describe cómo configurar Model Armor para registrar las operaciones siguientes:

• Operaciones que crean, actualizan o borran una plantilla
• Operaciones que limpian un prompt del usuario o una respuesta del modelo

Model Armor usa registros de auditoría para registrar las actividades de gestión y de administración de recursos. Para obtener más información, consulta Registro de auditoría de Model Armor.

Para obtener información sobre los precios de los registros, consulta los precios de Cloud Logging. También es posible que se apliquen cargos por uso de Model Armor según el volumen de datos procesados. Consulta los precios de Model Armor para obtener más detalles.

Antes de comenzar

Antes de comenzar, completa las siguientes tareas.

Obtén los permisos necesarios

Para obtener los permisos que necesitas a la hora de configurar el registro de Model Armor, pídele a tu administrador que te otorgue el rol de IAM de Administrador de Model Armor (roles/modelarmor.admin) en la plantilla de Model Armor. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

Habilita las APIs

Para poder usar Model Armor, debes habilitar la API de Model Armor.

Cómo configurar la anulación del extremo de API con la gcloud CLI

Este paso solo es necesario si usas gcloud CLI para habilitar la API de Model Armor. Debes configurar manualmente la anulación del extremo de API para garantizar que gcloud CLI enrute correctamente las solicitudes al servicio de Model Armor.

Ejecuta el siguiente comando para configurar el extremo de API del servicio de Model Armor.

gcloud config set api_endpoint_overrides/modelarmor "https://modelarmor.LOCATION.rep.googleapis.com/"

Reemplaza LOCATION por la región en la que quieres usar Model Armor.

Configura la limpieza del tráfico

Para los servidores de MCP de Google y Google Cloud , configura la limpieza del tráfico a través de la configuración mínima. Para obtener más información, consulta Cómo configurar la protección para los servidores de Google y deGoogle Cloud MCP.

Configura el registro en plantillas

Las plantillas definen los filtros y umbrales para diferentes categorías de seguridad. Cuando creas o actualizas una plantilla de Model Armor, puedes especificar si este debe registrar ciertas operaciones. Usa las marcas siguientes en los metadatos de la plantilla:

• log_template_operations: Es un valor booleano que te permite registrar las operaciones de creación, actualización, lectura y eliminación de plantillas.
• log_sanitize_operations: Es un valor booleano que te permite registrar el contenido completo de las instrucciones del usuario y las respuestas del modelo durante las operaciones de limpieza.

  curl -X POST \
      -d '{ "filterConfig": {}, "templateMetadata": { "logTemplateOperations": true, "logSanitizeOperations": true } }' \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer $(gcloud auth print-access-token)" \
      "https://modelarmor.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/templates?template_id=TEMPLATE_ID"

   request = modelarmor_v1.CreateTemplateRequest(
     parent="projects/PROJECT_ID/locations/LOCATION",
     template_id="TEMPLATE_ID",
     template={
        "name": "projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID",
        "filter_config": {},
        "template_metadata": {
           "log_template_operations": True,
           "log_sanitize_operations": True
        }
     }
   )
   response = client.create_template(request=request)
   

Configura el registro en la configuración mínima

Cuando aplicas la configuración mínima al tráfico de los modelos de Gemini en Gemini Enterprise Agent Platform y los servidores de Google y Google Cloud MCP dentro de tu proyecto, la configuración mínima define los filtros de seguridad para las operaciones de saneamiento. Cuando actualizas la configuración mínima de Model Armor, puedes especificar si Model Armor debe registrar las operaciones de limpieza.

Puedes habilitar el registro de las operaciones de limpieza para Agent Platform y los servidores de Google y Google Cloud MCP de forma individual. Cuando se habilita, los registros incluyen la instrucción y la respuesta (para Agent Platform) o las llamadas a herramientas y las respuestas de herramientas (para los servidores de MCP), los resultados de la evaluación de Model Armor y los campos de metadatos adicionales.

En los siguientes ejemplos, se muestra cómo habilitar el registro de operaciones de limpieza para Agent Platform y los servidores de Google y Google Cloud MCP.

gcloud model-armor floorsettings update \
--full-uri='projects/PROJECT_ID/locations/global/floorSetting' \
--enable-vertex-ai-cloud-logging \
--enable-google-mcp-server-cloud-logging

curl -X PATCH \
 -d '{ "aiPlatformFloorSetting":{ "enableCloudLogging": true}, "googleMcpServerFloorSetting":{ "enableCloudLogging": true}}' \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://modelarmor.googleapis.com/v1/projects/PROJECT_ID/locations/global/floorSetting?updateMask=aiPlatformFloorSetting.enableCloudLogging,googleMcpServerFloorSetting.enableCloudLogging"

from google.cloud.modelarmor import v1 as modelarmor_v1
from google.protobuf import field_mask_pb2

# TODO: Initialize the ModelArmorClient, "client"
# client = modelarmor_v1.ModelArmorClient()

project_id = "PROJECT_ID"
location = "global"

floor_setting_name = f"projects/{project_id}/locations/{location}/floorSetting"

request = modelarmor_v1.UpdateFloorSettingRequest(
    floor_setting=modelarmor_v1.FloorSetting(
        name=floor_setting_name,
        ai_platform_floor_setting=modelarmor_v1.FloorSetting.AiPlatformFloorSetting(
            enable_cloud_logging=True
        ),
        google_mcp_server_floor_setting=modelarmor_v1.FloorSetting.GoogleMcpServerFloorSetting(
            enable_cloud_logging=True
        ),
    ),
    update_mask=field_mask_pb2.FieldMask(
        paths=["ai_platform_floor_setting.enable_cloud_logging", "google_mcp_server_floor_setting.enable_cloud_logging"]
    )
)

try:
    response = client.update_floor_setting(request=request)
    print("Successfully updated floor settings logging.")
    print(response)
except Exception as e:
    print(f"An error occurred: {e}")

Visualiza y filtra los registros de Model Armor

Para ver y filtrar los registros de Model Armor, usa el Explorador de registros en Logging:

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

   Ve al Explorador de registros

   Para obtener más información, consulta Visualiza registros con el Explorador de registros.

2. En el panel de consultas, ingresa una de las siguientes consultas para filtrar los registros de Model Armor:

   • Para ver todos los registros de Model Armor, incluidos los registros de auditoría y los registros de operaciones de saneamiento, haz lo siguiente:

     protoPayload.serviceName="modelarmor.googleapis.com" OR jsonPayload.@type="type.googleapis.com/google.cloud.modelarmor.logging.v1.SanitizeOperationLogEntry"
     

   • Para ver solo los registros de auditoría de Model Armor, haz lo siguiente:

     protoPayload.serviceName="modelarmor.googleapis.com"
     

     Para obtener una lista de todos los nombres de servicios y tipos de recurso supervisado, consulta Recursos y servicios supervisados.

   • Para ver solo los registros de Model Armor de las operaciones de limpieza, haz lo siguiente:

     jsonPayload.@type="type.googleapis.com/google.cloud.modelarmor.logging.v1.SanitizeOperationLogEntry"
     

     Para definir mejor los registros de operaciones de limpieza, puedes especificar un nombre de cliente o un ID de correlación en la consulta.

     • Usar un nombre de cliente: Cuando Model Armor se integra con servicios como Gemini Enterprise Agent Platform o Gemini Enterprise, puedes usar el nombre del cliente para filtrar los registros de una integración específica.

       jsonPayload.@type="type.googleapis.com/google.cloud.modelarmor.logging.v1.SanitizeOperationLogEntry"
       labels."modelarmor.googleapis.com/client_name"="CLIENT_NAME"
       

     • Usa un ID de correlación:

       jsonPayload.@type="type.googleapis.com/google.cloud.modelarmor.logging.v1.SanitizeOperationLogEntry"
       labels."modelarmor.googleapis.com/client_correlation_id"="CORRELATION_ID"
       

     Reemplaza lo siguiente:

     • CLIENT_NAME: Es el nombre de tu cliente. Usa uno de los siguientes valores:
       • CLIENT_NAME_UNSPECIFIED: Valor predeterminado que se usa cuando no se especifica el nombre del cliente.
       • VERTEX_AI: Para la integración con Gemini Enterprise Agent Platform.
       • LOAD_BALANCER: Para la integración con Load Balancer como extensión de servicio.
       • LANGCHAIN: Para la integración con LangChain.
       • GEMINI_ENTERPRISE_BUSINESS: Para la integración con la edición Business de Gemini Enterprise.
       • GOOGLE_MCP_SERVER: Para la integración con Google y los servidores de MCP administrados por Google.
       • AGENT_GATEWAY: Para la integración con Agent Gateway.
       • GEMINI_ENTERPRISE_NON_BUSINESS Para la integración con ediciones de Gemini Enterprise que no sean Business (Standard, Plus, Frontline).
       • SECURE_WEB_PROXY Para la integración con Secure Web Proxy.
     • CORRELATION_ID: Es el identificador único que generas para una solicitud específica.

Correlaciona registros y eventos relacionados

Para correlacionar los registros y eventos de una interacción específica, puedes usar un ID de correlación del cliente de Model Armor. Este ID es un identificador único que generas (por ejemplo, un UUID) y que hace un seguimiento de una solicitud específica en tu sistema. Para establecer un ID de correlación del cliente en un encabezado curl, usa la opción -H para incluir un encabezado personalizado MA-Client-Correlation-Id en tu solicitud.

Este es el formato de la muestra:

uuid=$(uuidgen) \
curl -X POST -d  '{"userPromptData": { "text": "USER_PROMPT" } }' \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "MA-Client-Correlation-Id:${uuid}" \
    "https://modelarmor.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID:sanitizeUserPrompt"

curl -X POST \
    -d  '{"modelResponseData": { "text": "MODEL_RESPONSE" }, "userPrompt": "USER_PROMPT" }' \
    -H "Content-Type: application/json" \
    -H "MA-Client-Correlation-Id:${uuid}" \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://modelarmor.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID:sanitizeModelResponse"

Reemplaza los parámetros que se indican a continuación:

• PROJECT_ID: Es el ID del proyecto al que pertenece la plantilla.
• LOCATION: Es la ubicación de la plantilla.
• TEMPLATE_ID: Es el ID de la plantilla.
• USER_PROMPT: Es el prompt proporcionado al modelo.
• MODEL_RESPONSE: Es la respuesta que se recibió del modelo.

Registros de la plataforma en comparación con los Registros de auditoría de Cloud

Es importante distinguir entre los registros que puedes habilitar en la configuración de una plantilla o la configuración mínima de Model Armor y los registros de auditoría de Cloud.

Si habilitas el registro en una plantilla, se escribirán las instrucciones y las respuestas sin procesar en Logging. Estos datos pueden incluir información sensible del usuario, información de identificación personal (PII) o información confidencial. El tráfico alto y las cargas útiles grandes pueden generar costos de registro significativos y la posibilidad de que los volúmenes de registros grandes superen los límites y requieran una administración cuidadosa.

Identidad del llamador en los registros de auditoría

Cuando ves los registros de auditoría, Registros de auditoría de Cloud captura la identidad de la persona que llama en el campo protoPayload.authenticationInfo.principalEmail. La identidad registrada depende de cómo se llama a la API de Model Armor:

• Invocación directa de la API: Si un usuario o una cuenta de servicio llama directamente a la API de Model Armor (por ejemplo, con gcloud, bibliotecas cliente o APIs de REST), principalEmail contiene la dirección de correo electrónico de ese usuario o cuenta de servicio.
• Invocación a través de un servicio Google Cloud integrado: Si Model Armor se integra con otro servicioGoogle Cloud , como Gemini Enterprise Agent Platform, principalEmailcontiene la identidad de ese servicio, que suele ser una cuenta de servicio administrada por Google. El formato de los agentes de servicio es service-PROJECT_NUMBER@SERVICE_NAME.. Por ejemplo, una llamada que se origina en una función de Gemini Enterprise Agent Platform usa un agente de servicio de Gemini Enterprise Agent Platform.

Para distinguir entre los llamadores, examina el campo principalEmail en la entrada de registro de auditoría. Las llamadas de los usuarios finales o las cuentas de servicio administradas por el usuario muestran sus direcciones de correo electrónico, mientras que las llamadas a través de otros servicios Google Cloud muestran las direcciones de correo electrónico de las cuentas de servicio administradas por Google.