Política SanitizeUserPrompt

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Descripción general

La política SanitizeUserPrompt protege a las aplicaciones de IA del contenido dañino, ya que limpia las instrucciones del usuario que se envían a los modelos de IA generativa. La política usa Model Armor para evaluar las instrucciones del usuario en busca de contenido dañino, lo que habilita la protección nativa para las cargas de trabajo de IA con Apigee. Model Armor es un Google Cloud servicio que ofrece medidas de seguridad y protección de la IA para mitigar los riesgos asociados con los modelos de lenguaje grande (LLM).

Esta política se usa junto con la política SanitizeModelResponse.

Esta política es una política extensible, y el uso de esta política puede tener implicaciones de costo o uso, según tu licencia de Apigee. Para obtener información sobre los tipos de políticas y sus implicaciones de uso, consulta Tipos de políticas.

Antes de comenzar

Antes de usar la política SanitizeUserPrompt, debes completar las siguientes tareas:

• Crea una plantilla de Model Armor. Debes completar este paso antes de crear una política de SanitizeUserPrompt.
• Establece el extremo de API para el servicio de Model Armor.
• Crea una política de SanitizeModelResponse. Esta tarea se debe completar antes de implementar la política SanitizeUserPrompt.

Roles obligatorios

Para obtener los permisos que necesitas para aplicar y usar la política SanitizeUserPrompt, pídele a tu administrador que te otorgue los siguientes roles de IAM en la cuenta de servicio que usas para implementar proxies de Apigee:

• Usuario de Model Armor (roles/modelarmor.user)
• Visualizador de Model Armor (roles/modelarmor.viewer)

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 mediante roles personalizados o cualquier otro rol predefinido.

Habilita las APIs

Enable the Model Armor API.

Enable the API

Elemento <SanitizeUserPrompt>

Define una política SanitizeUserPrompt.

El elemento <SanitizeUserPrompt> usa la siguiente sintaxis:

<SanitizeUserPrompt async="false" continueOnError="false" enabled="true" name="sanitize-text">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>Sanitize-Text-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
  <UserPromptSource>{jsonPath('$.contents[-1].parts[-1].text',request.content,true)}</UserPromptSource>
</SanitizeUserPrompt>

<SanitizeUserPrompt async="false" continueOnError="false" enabled="true" name="sanitize-text">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>Sanitize-Text-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
  <UserPromptSource>{jsonPath('$.contents[-1].parts[-1].text',request.content,true)}</UserPromptSource>
</SanitizeUserPrompt>

Este elemento tiene los siguientes atributos que son comunes a todas las políticas:

En la siguiente tabla, se proporciona una descripción de alto nivel de los elementos secundarios de <SanitizeUserPrompt>:

{jsonpath('$.input.prompt.text',request.content,false)}

Ejemplo

En esta sección, se proporciona un ejemplo del uso de <SanitizeUserPrompt>.

En este ejemplo, se usan todos los valores predeterminados para la detección de modelos y la extracción de instrucciones:

<SanitizeUserPrompt async="false" continueOnError="false" enabled="true" name="sanitize-text">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <DisplayName>Sanitize-Text-sample</DisplayName>
  <ModelArmor>
    <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
  </ModelArmor>
</SanitizeUserPrompt>

Referencia del elemento secundario

En esta sección, se describen los elementos secundarios de <SanitizeUserPrompt>.

<DisplayName>

Se usan además del atributo name para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

El elemento <DisplayName> es común a todas las políticas.

El elemento <DisplayName> usa la siguiente sintaxis:

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

El elemento <DisplayName> no tiene atributos ni elementos secundarios.

<IgnoreUnresolvedVariables>

Determina si el procesamiento se detiene cuando una variable no se resuelve. Configúralo como true para ignorar las variables sin resolver y continuar con el procesamiento.

<ModelArmor>

Contiene la información necesaria para especificar la plantilla de Model Armor.

El elemento <ModelArmor> usa la siguiente sintaxis:

<ModelArmor>
  <TemplateName>projects/{project}/locations/{location}/templates/{template-name}</TemplateName>
</ModelArmor>

<ModelArmor>
  <TemplateName>projects/{organization.name}/locations/{system.region.name}/templates/{id}</TemplateName>
</ModelArmor>

En la siguiente tabla, se proporciona una descripción de alto nivel de los elementos secundarios de <ModelArmor>.

projects/{organization.name}/locations/{system.region.name}/templates/{id}

<UserPromptSource>

Es la ubicación de la carga útil para que se extraiga el texto de la instrucción del usuario. Este campo admite la sintaxis de la plantilla de mensajes de Apigee, incluido el uso de variables o funciones de ruta de acceso JSON. Por ejemplo:

{jsonpath('$.input.prompt.text',request.content,false)}

Variables de flujo

Las variables de flujo se pueden usar para configurar el comportamiento del entorno de ejecución dinámico de las políticas y los flujos, según los encabezados HTTP, el contenido del mensaje, o el contexto disponible en el flujo. Para obtener más información sobre las variables de flujo, consulta Referencia de variables de flujo.

La política puede establecer estas variables de solo lectura durante la ejecución.

Referencia de errores

En esta sección, se describen los códigos de falla y los mensajes de error que se muestran, y las variables de falla que establece Apigee específicas para la política SanitizeUserPrompt. Esta información es importante para saber si estás desarrollando reglas de fallas con el propósito de manejar fallas. Para obtener más información, consulta Lo que necesitas saber sobre los errores de políticas y Controla fallas.

Errores de entorno de ejecución

Estos errores pueden producirse cuando se ejecuta la política.

Errores en la implementación

Estos errores pueden generarse cuando implementas un proxy que contiene esta política.

Variables con fallas

Estas variables se configuran cuando esta política activa un error en el entorno de ejecución. Para obtener más información, consulta Qué debes saber sobre los errores de la política.

Ejemplo de respuesta de error

{
  "fault": {
    "faultstring": "SanitizeUserPrompt[sanitize-prompt]: unable to resolve variable [variable_name]",
    "detail": {
      "errorcode": "steps.sanitizeuserprompt.UnresolvedVariable"
    }
  }
}

Ejemplo de regla de falla

<FaultRule name="SanitizeUserPrompt Faults">
    <Step>
        <Name>SUP-CustomSetVariableErrorResponse</Name>
        <Condition>(fault.name = "SetVariableFailed")</Condition>
    </Step>
    <Condition>(sanitizeuserprompt.failed = true)</Condition>
</FaultRule>

Códigos de error y mensajes de error de la plantilla de Model Armor

La plantilla de Model Armor admite la anulación de los códigos de error y los mensajes de error que arrojan las solicitudes de la API de la política SanitizeUserPrompt. Si el usuario establece las anulaciones, los códigos de error y los mensajes de error de Model Armor propagarán las variables de flujo.

Por ejemplo, una respuesta con códigos y mensajes de error de Model Armor podría verse de la siguiente manera:

{
  "sanitizationResult": {
    "filterMatchState": "MATCH_FOUND",
    "filterResults": {...},
    "sanitizationMetadata": {
      "errorCode": "890",
      "errorMessage": "get out"
      },
    "invocationResult": "SUCCESS"
  }
}

Esquemas

Un esquema XML (.xsd) define cada tipo de política. Como referencia, los esquemas de políticas están disponibles en GitHub.