Skip to main content

Prompt Shield API

La API Prompt Shield le permite escanear mensajes y respuestas de cualquier aplicación. No es necesario utilizar la infraestructura de chatbot integrada de SecureAI. Integre el motor de escaneo en su propio proceso LLM con tres endpoints REST. Prompt Shield se puede utilizar de dos maneras:
  1. API de escaneo independiente: los endpoints /scan, /scan-output y /scan-conversation documentados a continuación, para su propio proceso de LLM.
  2. En línea al finalizar: cuando llamas a Finalización del chat o al endpoint compatible con OpenAI, Prompt Shield se ejecuta automáticamente y se puede ajustar por llamada. Consulte [Control por llamada sobre finalizaciones] (#control-por-llamada-sobre-finalizaciones).

Control por llamada sobre terminaciones

Las solicitudes de finalización escanean la entrada (y la salida) a través de Prompt Shield automáticamente cuando la clave API lo tiene habilitado. Puede anular el comportamiento de una sola llamada con un objeto prompt_shield en el cuerpo de la solicitud:
No puedes combinar policy con enabled: false. La política aplicada se repite en la respuesta (metadata.prompt_shield_policy en el endpoint clásico, secureai.prompt_shield_policy en el endpoint /v1). Para obtener una vista previa del veredicto de una llamada sin ejecutar el modelo, utilice Verificación de políticas.

Autenticación

Todas las solicitudes de la API Prompt Shield requieren una clave API SecureAI en el encabezado Authorization:
Las claves API se crean y administran en Admin -> Claves API. Para habilitar Prompt Shield para una clave API, edite la clave y active Habilitar Prompt Shield. Opcionalmente, puede vincular una [política] específica (../../threat-defense/overview) a la clave.

URL base


PUBLICAR /escanear

Escanee un mensaje de usuario único en busca de ataques de inyección antes de enviarlo a su LLM.

Solicitud

Respuesta

Patrón de integración recomendado


POST /salida de escaneo

Analice una respuesta de LLM en busca de evidencia de compromiso, incluida una fuga de avisos del sistema, una fuga de token canario o una desviación de roles.

Solicitud

Respuesta


POST /escanear-conversación

Escanee una conversación completa de varios turnos a la vez. Esto es útil para el análisis por lotes o para evaluar conversaciones históricas para una detección retroactiva.

Solicitud

Respuesta


Respuestas de error


Límites de velocidad y rendimiento

  • La latencia de escaneo suele ser de 1 a 5 ms para las capas heurística y de expresiones regulares.
  • Agregar la capa ML aumenta la latencia a 20-50 ms según el proveedor de incorporación.
  • La API externa comparte límites de tarifas con el resto de su asignación de claves API.
  • El disyuntor devuelve 503 respuestas si el motor experimenta 5 fallas consecutivas en 30 segundos.

Habilitación de Prompt Shield en una clave API

  1. Vaya a Administrador -> Claves API.
  2. Edite la clave API que utiliza para llamadas externas.
  3. Active Activar protección de aviso.
  4. Opcionalmente, configure Sensibilidad de protección de aviso en strict, balanced o permissive.
  5. Opcionalmente, establezca Política de protección de avisos para vincular una política específica a esta clave.
  6. Guardar.
Todas las solicitudes /api/external/prompt-shield/* realizadas con esta clave pasan por el motor con la política configurada.