Se usó la API de Cloud Translation para traducir esta página.

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 la página Precios de Cloud Logging. También se pueden aplicar 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

Completa estas tareas antes de completar las tareas restantes de esta página.

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 las APIs de Model Armor, debes habilitarlas.

Consola

Enable the Model Armor API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the API
Elige el proyecto en el que quieres activar Model Armor.

gcloud

Antes de empezar, sigue estos pasos a través de la Google Cloud CLI con la API de Model Armor:

In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
Ejecuta el comando siguiente 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

En el caso de los servidores del Protocolo de contexto del modelo (MCP) administrados por Google, configura la limpieza del tráfico a través de la configuración de límites. Para obtener más información, consulta Configura la protección para los servidores de Google y los servidores de MCP remotos. Google Cloud (Vista previa)

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 habilita el registro de las operaciones de creación, actualización, lectura y eliminación de plantillas.
log_sanitize_operations: Es un valor booleano que habilita el registro de las operaciones de limpieza. Los registros incluyen el prompt y la respuesta, los resultados de la evaluación de Model Armor y los campos de metadatos adicionales.

Consola

En la consola de Google Cloud , accede a la página de Model Armor.

Acceder a Model Armor
Verifica que estés viendo el proyecto en el que activaste Model Armor.
En la página de Model Armor, haz clic en Crear plantilla. Para obtener más información sobre cómo crear plantillas, consulta Crea una plantilla de Model Armor.
En la sección Configura el registro, elige las operaciones para las que quieres configurar el registro.
Haz clic en Crear.

REST

  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"

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.

Python

Para ejecutar este código, primero configura un entorno de desarrollo de Python y, luego, instala el SDK de Python para Model Armor.

   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)

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.

Configura el registro en los parámetros de límites

La configuración de límites establece filtros de seguridad y protección básicos en todos los modelos de Gemini en Vertex AI y en los servidores de protocolo de contexto del modelo (MCP) administrados por Google (versión preliminar) dentro de tu proyecto. Cuando actualizas la configuración mínima de Model Armor, puedes especificar si se registran las operaciones de limpieza de Model Armor.

Puedes habilitar el registro de las operaciones de saneamiento para los servidores de MCP administrados por Google y Vertex AI de forma individual. Cuando se habilita, los registros incluyen el prompt y la respuesta (para Vertex AI) o las llamadas y respuestas de herramientas (para los servidores de MCP), los resultados de la evaluación de Model Armor y los campos de metadatos adicionales.

Console

En la consola de Google Cloud , accede a la página de Model Armor.

Acceder a Model Armor
Verifica que estés viendo el proyecto en el que activaste Model Armor.
Navega a la pestaña Configuración de piso.
En la sección Registros, selecciona MCP administrado por Google.
Haz clic en Guardar.

gcloud

Puedes usar una de las siguientes marcas para administrar el registro de las operaciones de limpieza en la configuración de la planta.

Para habilitar el registro, usa una de las siguientes marcas:

En el caso de Vertex AI, usa la marca --enable-vertex-ai-cloud-logging.
Para los servidores de MCP administrados por Google, usa la marca --enable-google-mcp-server-cloud-logging.

Para inhabilitar el registro, usa una de las siguientes marcas:

En el caso de Vertex AI, usa la marca --no-enable-vertex-ai-cloud-logging.
Para los servidores de MCP administrados por Google, usa la marca --no-enable-google-mcp-server-cloud-logging.

Nota: Puedes habilitar o inhabilitar el registro para uno o ambos servicios con un solo comando.

El siguiente comando de ejemplo habilita el registro de operaciones de limpieza para los servidores de MCP administrados por Google y Vertex AI:

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

Reemplaza PROJECT_ID por el ID de tu proyecto.

REST

Puedes usar el método UpdateFloorSetting para actualizar la configuración del piso y habilitar el registro de operaciones de limpieza. Cuando uses este método, asegúrate de establecer el parámetro adecuado como verdadero para habilitar el registro:

Para Vertex AI, establece aiPlatformFloorSetting.enableCloudLogging en true.
Para los servidores de MCP administrados por Google, establece googleMcpServerFloorSetting.enableCloudLogging en true.

El siguiente comando de ejemplo habilita el registro de operaciones de limpieza para los servidores de MCP administrados por Google y Vertex AI:

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"

Reemplaza PROJECT_ID por el ID de tu proyecto.

Python

Para ejecutar este código, primero configura un entorno de desarrollo de Python y, luego, instala el SDK de Python para Model Armor.

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}")

Reemplaza PROJECT_ID por el ID de tu proyecto.

Ver registros

Para ver los registros de Model Armor, puedes usar el Explorador de registros en Logging. Sigue estos pasos:

Navega al Explorador de registros en la consola de Google Cloud . Para obtener más información, consulta Visualiza registros con el Explorador de registros.
Filtra los registros por el nombre del servicio modelarmor.googleapis.com.
Busca entradas relacionadas con las operaciones que habilitaste en la plantilla. Para obtener una lista de todos los nombres de servicios y tipos de recurso supervisado, consulta Recursos y servicios supervisados.

Filtra los registros de Model Armor

Puedes usar etiquetas de registro para filtrar los registros de Model Armor en las operaciones de limpieza y el registro de plantillas. Para ello, sigue estas instrucciones:

Ejecuta la consulta siguiente en el Explorador de registros para filtrar los registros de operaciones de limpieza.

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

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

Usa un ID del proyecto:

jsonPayload.@type="type.googleapis.com%2Fgoogle.cloud.modelarmor.logging.v1.SanitizeOperationLogEntry";project=PROJECT_ID

Usa el nombre de un cliente:

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:

labels."modelarmor.googleapis.com/client_correlation_id"="CORRELATION_ID"

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

PROJECT_ID: Es el ID del proyecto de Google Cloud .
CLIENT_NAME: Es el nombre de tu cliente.
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. 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 en tu solicitud.

Este es el formato de la muestra:

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.

Configura el registro Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Antes de comenzar

Obtén los permisos necesarios

Habilita las APIs

Consola

gcloud

Configura la limpieza del tráfico

Configura el registro en plantillas

Consola

REST

Python

Configura el registro en los parámetros de límites

Console

gcloud

REST

Python

Ver registros

Filtra los registros de Model Armor

Correlaciona registros y eventos relacionados

Configura el registro