Crea y administra plantillas de Model Armor

En esta página, se describe cómo crear, ver, actualizar y borrar plantillas de Model Armor.

Crea una plantilla de Model Armor

Console

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

    Ir a Model Armor

  2. Verifica que estés viendo el proyecto en el que activaste Model Armor.

  3. En la página Model Armor, haz clic en Crear plantilla. Aparecerá la página Crear plantilla.

  4. Especifica el ID de plantilla. El ID de la plantilla puede tener letras, dígitos o guiones. No debe superar los 63 caracteres, no puede tener espacios ni comenzar con un guion.

  5. Selecciona una región para ejecutar tus plantillas de Model Armor. No podrás cambiar la región más adelante.

  6. Opcional: Agrega etiquetas. Las etiquetas son pares clave-valor que puedes usar para agrupar plantillas relacionadas.

  7. En la sección Detecciones, configura los siguientes parámetros de detección:

    • Detección de URLs maliciosas: Identifica direcciones web (URLs) diseñadas para dañar a usuarios o sistemas. Estas URLs pueden dirigir a sitios de phishing, descargas de software malicioso o a otros ciberataques. Para obtener más información, consulta Detección de URLs maliciosas.

    • Detección de inyección de instrucciones y jailbreak: Detecta contenido malicioso y los intentos de jailbreak en una instrucción. Para una aplicación más estricta, establece el nivel de confianza en Bajo y superior** para detectar la mayoría del contenido que probablemente corresponda a inyección de instrucciones o intento de jailbreaking. Para obtener más información, consulta Detección de inyección de instrucciones y jailbreak.

    • Sensitive Data Protection: Detecta datos sensibles y ayuda a evitar la exposición accidental por ataques como la inyección de instrucciones. Para obtener más información, consulta Sensitive Data Protection.

      Puedes configurar la protección de datos sensibles básica o avanzada.

      • Básico: Usa Infotipos predefinidos para detectar tipos de datos sensibles. Para obtener más información sobre el infotipo predefinido, consulta Configuración básica de la Protección de datos sensibles.

      • Avanzado: Usa una plantilla de inspección definida en el servicio Sensitive Data Protection como una única fuente para los infoTypes de datos sensibles.

        Si seleccionas la Protección de datos sensibles avanzada, debes especificar los siguientes parámetros:

        • Plantilla de inspección: Plantillas para guardar la información de configuración en trabajos de análisis de inspección, que incluyen qué detectores personalizados o predefinidos usar. Ingresa el nombre de la plantilla con el siguiente formato: projects/projectName/locations/locationID/inspectTemplates/templateName

        • Opcional: Plantilla de desidentificación: Plantillas para guardar la información de configuración en trabajos de desidentificación, que incluyen transformaciones de Infotipo y de conjunto de datos estructurados. Ingresa un identificador para la plantilla de desidentificación en el siguiente formato: projects/projectName/locations/locationID/deidentifyTemplates/templateName

          Verifica que la plantilla de inspección y la plantilla de desidentificación existan en Sensitive Data Protection. Si la plantilla reside en un proyecto diferente, se le debe otorgar al agente de servicio de Model Armor el rol de usuario de DLP (roles/dlp.user) y el rol de lector de DLP (roles/dlp.reader) para ese proyecto.

  8. En la sección Responsible AI, puedes establecer el nivel de confianza para cada filtro de contenido. El nivel de confianza representa la probabilidad de que los resultados coincidan con un tipo de filtro de contenido. Los valores posibles son:

    • Ninguno: No detecta ningún tipo de contenido.
    • Baja y superior: Detecta contenido con niveles de confianza bajos, medios o altos.
    • Media y superior: Detecta contenido con un nivel de confianza medio o alto.
    • Alto: Detecta contenido con un nivel de confianza alto.

    Para una aplicación más estricta, establece el nivel de confianza en Bajo y superior para detectar la mayoría del contenido que se incluye en un tipo de filtro. También puedes seleccionar el nivel de confianza para todos los tipos de contenido a la vez.

  9. Haz clic en Crear.

gcloud

Ejecuta el siguiente comando:

gcloud model-armor templates create TEMPLATE_ID --location LOCATION

Reemplaza lo siguiente:

  • LOCATION es la ubicación de la plantilla.
  • TEMPLATE_ID es el ID de la plantilla.

A continuación, se muestra un ejemplo con todos los filtros.

 gcloud model-armor templates create --location LOCATION TEMPLATE_ID 
--rai-settings-filters='[{ "filterType": "HATE_SPEECH", "confidenceLevel": "MEDIUM_AND_ABOVE" },{ "filterType": "HARASSMENT", "confidenceLevel": "MEDIUM_AND_ABOVE" },{ "filterType": "SEXUALLY_EXPLICIT", "confidenceLevel": "MEDIUM_AND_ABOVE" }]'
--basic-config-filter-enforcement=enabled
--pi-and-jailbreak-filter-settings-enforcement=enabled
--pi-and-jailbreak-filter-settings-confidence-level=LOW_AND_ABOVE
--malicious-uri-filter-settings-enforcement=enabled
--template-metadata-custom-llm-response-safety-error-code=798
--template-metadata-custom-llm-response-safety-error-message="test template llm response evaluation failed"
--template-metadata-custom-prompt-safety-error-code=799
--template-metadata-custom-prompt-safety-error-message="test template prompt evaluation failed"
--template-metadata-ignore-partial-invocation-failures
--template-metadata-log-operations
--template-metadata-log-sanitize-operations

REST

Usa este comando para crear una plantilla de Model Armor nueva.

  curl -X POST \
    -d "{'FILTER_CONFIG': {} }" \
    -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 lo siguiente:

  • FILTER_CONFIG es la configuración del filtro para la plantilla.
  • PROJECT_ID es el ID del proyecto al que pertenece la plantilla.
  • TEMPLATE_ID es el ID de la plantilla que se creará.
  • LOCATION es la ubicación de la plantilla.

Sigue estos pasos para obtener este token.

En el siguiente ejemplo, se explica la configuración de la plantilla de Model Armor.

  1. Crea una configuración (en este caso, FILTER_CONFIG) de los filtros que deseas que la plantilla de Model Armor aplique y el nivel de confianza en el que se aplicarán, si corresponde.
  2. Crea una plantilla de Model Armor (en este caso, ma-template-id-1234) con la configuración que creaste.

Ten en cuenta que LOW_AND_ABOVE significa que se marcará todo el contenido con una probabilidad de LOW, MEDIUM o HIGH.

  export FILTER_CONFIG='{
   "filterConfig": {
    "raiSettings": {
     "raiFilters": [{
       "filterType": "HATE_SPEECH",
       "confidenceLevel": "MEDIUM_AND_ABOVE"
      }, {
      "filterType": "HARASSMENT",
      "confidenceLevel": "HIGH"
    }, {
      "filterType": "DANGEROUS",
      "confidenceLevel": "MEDIUM_AND_ABOVE"
    },{
      "filterType": "SEXUALLY_EXPLICIT",
      "confidenceLevel": "MEDIUM_AND_ABOVE"
    }]
  },

  "piAndJailbreakFilterSettings": {
    "filterEnforcement": "ENABLED",
    "confidenceLevel": "LOW_AND_ABOVE"
  },
  "maliciousUriFilterSettings": {
    "filterEnforcement": "ENABLED"
  }
 }
}'

curl -X POST \
 -d  $FILTER_CONFIG \
 -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_ID/templates?template_id=TEMPLATE_ID"

Para crear una plantilla de Model Armor con la detección de varios idiomas habilitada, debes pasar el parámetro TEMPLATE_CONFIG en tu comando. Este parámetro define la configuración de los parámetros de configuración de detección de idioma.

Usa este comando para crear una nueva plantilla de Model Armor con la detección en varios idiomas habilitada.

curl -X POST \
    -d "{'TEMPLATE_CONFIG': {} }" \
    -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"

En el siguiente ejemplo, se explica la configuración de la plantilla Model Armor con la detección en varios idiomas habilitada.

  export TEMPLATE_CONFIG='{
   "filterConfig": {
    "raiSettings": {
     "raiFilters": [{
       "filterType": "HATE_SPEECH",
       "confidenceLevel": "MEDIUM_AND_ABOVE"
      }, {
      "filterType": "HARASSMENT",
      "confidenceLevel": "HIGH"
    }, {
      "filterType": "DANGEROUS",
      "confidenceLevel": "MEDIUM_AND_ABOVE"
    },{
      "filterType": "SEXUALLY_EXPLICIT",
      "confidenceLevel": "MEDIUM_AND_ABOVE"
    }]
  },

  "piAndJailbreakFilterSettings": {
    "filterEnforcement": "ENABLED",
    "confidenceLevel": "LOW_AND_ABOVE"
  },
  "maliciousUriFilterSettings": {
    "filterEnforcement": "ENABLED"
  }
 },
 "templateMetadata": {
    "multiLanguageDetection": {
      "enableMultiLanguageDetection": true
    }
  }
}'

curl -X POST \
 -d  $TEMPLATE_CONFIG  \
 -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_ID/templates?template_id=TEMPLATE_ID"

Python

Para ejecutar este comando, primero inicializa un cliente de Model Armor en Python.

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

Reemplaza lo siguiente:

  • FILTER_CONFIG es la configuración del filtro para la plantilla.
  • PROJECT_ID es el ID del proyecto al que pertenece la plantilla.
  • TEMPLATE_ID es el ID de la plantilla que se creará.
  • LOCATION es la ubicación de la plantilla.

Para habilitar el registro integral en una plantilla, consulta Registro de auditoría y de plataforma de Model Armor.

Cómo ver una plantilla de Model Armor

Console

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

    Ir a Model Armor

  2. Verifica que estés viendo el proyecto en el que activaste Model Armor. Se muestra la página Model Armor, en la que se enumeran las plantillas creadas para tu proyecto.

  3. Haz clic en cualquier plantilla de la lista para ver sus detalles.

gcloud

Ejecuta el siguiente comando:

gcloud model-armor templates describe TEMPLATE_ID --location LOCATION

Reemplaza lo siguiente:

  • LOCATION es la ubicación de la plantilla.
  • TEMPLATE_ID es el ID de la plantilla.

REST

Ejecuta el siguiente comando:

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://modelarmor.LOCATION_ID.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID"

Reemplaza lo siguiente:

  • PROJECT_ID es el ID del proyecto al que pertenece la plantilla.
  • TEMPLATE_ID es el ID de la plantilla que se visualizará.
  • LOCATION es la ubicación de la plantilla.

Python

Para ejecutar este comando, primero inicializa un cliente de Model Armor en Python.

  request = modelarmor_v1.GetTemplateRequest(
    name="projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID",
    )
  response = client.get_template(request=request)
 

Reemplaza lo siguiente:

  • PROJECT_ID es el ID del proyecto al que pertenece la plantilla.
  • TEMPLATE_ID es el ID de la plantilla que se visualizará.
  • LOCATION es la ubicación de la plantilla.

Actualiza una plantilla de Model Armor

Console

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

    Ir a Model Armor

  2. Verifica que estés viendo el proyecto en el que activaste Model Armor. Se mostrará la página Model Armor, en la que se enumeran las plantillas creadas para tu organización.

  3. Haz clic en la plantilla que deseas actualizar en la lista. Se muestra la página Detalles de la plantilla.

  4. Haz clic en Editar.

  5. Actualiza los parámetros obligatorios y haz clic en Guardar.

gcloud

Ejecuta el siguiente comando:

gcloud model-armor templates update TEMPLATE_ID --location LOCATION

Reemplaza lo siguiente:

  • LOCATION es la ubicación de la plantilla.
  • TEMPLATE_ID es el ID de la plantilla.

REST

Ejecuta el siguiente comando:

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d $FILTER_CONFIG \
  "https://modelarmor.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID?update_mask=FILTER_CONFIG"

Reemplaza lo siguiente:

  • 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.
  • FILTER_CONFIG es la representación JSON de la configuración del filtro.

Todos los demás campos son inmutables. Los intentos de actualizar otros campos (por ejemplo, el nombre de la plantilla) generan un error.

Python

Para ejecutar este comando, primero inicializa un cliente de Model Armor en Python.

  request = modelarmor_v1.UpdateTemplateRequest(
    template={
      "name": "projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID",
      "filter_config": FILTER_CONFIG
    }
  )
  response = client.update_template(request=request)
 

Reemplaza lo siguiente:

  • FILTER_CONFIG es la configuración del filtro para la plantilla.
  • PROJECT_ID es el ID del proyecto al que pertenece la plantilla.
  • TEMPLATE_ID es el ID de la plantilla que se actualizará.
  • LOCATION es la ubicación de la plantilla.

Borra una plantilla de Model Armor

Console

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

    Ir a Model Armor

  2. Verifica que estés viendo el proyecto en el que activaste Model Armor. Se mostrará la página Model Armor, en la que se enumeran las plantillas creadas para tu organización.

  3. Haz clic en la plantilla que deseas borrar de la lista. Se muestra la página Detalles de la plantilla.

  4. Haz clic en Borrar. Aparecerá un diálogo de confirmación.

  5. Ingresa el nombre de la plantilla para confirmar la eliminación y haz clic en Borrar.

gcloud

Ejecuta el siguiente comando:

gcloud model-armor templates delete TEMPLATE_ID --location LOCATION

Reemplaza lo siguiente:

  • LOCATION es la ubicación de la plantilla.
  • TEMPLATE_ID es el ID de la plantilla.

REST

Ejecuta el siguiente comando:

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth print-access-token)"  \
  "https://modelarmor.LOCATION_ID.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID"

Reemplaza lo siguiente:

  • 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 comando, primero inicializa un cliente de Model Armor en Python.

  request = modelarmor_v1.DeleteTemplateRequest(
    name="projects/PROJECT_ID/locations/LOCATION/templates/TEMPLATE_ID",
  )
  response = client.delete_template(request=request)
 

Reemplaza lo siguiente:

  • PROJECT_ID es el ID del proyecto al que pertenece la plantilla.
  • TEMPLATE_ID es el ID de la plantilla que se borrará.
  • LOCATION es la ubicación de la plantilla.

Metadatos de plantillas

Los metadatos de la plantilla de Model Armor te ayudan a configurar el comportamiento de Model Armor, incluido el manejo de verificaciones de seguridad y protección, el manejo de errores y el comportamiento de registro.

Los metadatos de la plantilla de Model Armor incluyen los siguientes campos:

Metadatos Tipo Descripción
multi_language_detection Booleano Habilita la detección de varios idiomas.
enforcement_type Enum

Define el tipo de aplicación. Usa uno de los siguientes valores:

  • INSPECT_ONLY: Inspecciona las solicitudes que incumplen la configuración establecida, pero no las bloquea.
  • INSPECT_AND_BLOCK: Bloquea las solicitudes que incumplen la configuración establecida.
log_template_operations Booleano Habilita el registro de las operaciones de la plantilla.
log_sanitize_operations Booleano Habilita el registro de las operaciones de saneamiento.

¿Qué sigue?