Skip to main content

API Prompt Shield

A API Prompt Shield permite verificar prompts e respostas de qualquer aplicativo. Você não precisa usar a infraestrutura de chatbot integrada do SecureAI. Integre o mecanismo de verificação ao seu próprio pipeline LLM com três endpoints REST. O Prompt Shield pode ser usado de duas maneiras:
  1. API de varredura autônoma — os endpoints /scan, /scan-output e /scan-conversation documentados abaixo, para seu próprio pipeline LLM.
  2. Inline nas conclusões — quando você chama Chat Completion ou o endpoint compatível com OpenAI, o Prompt Shield é executado automaticamente e pode ser ajustado por chamada. Consulte Controle por chamada nas conclusões.

Controle por chamada nas conclusões

A conclusão solicita entrada (e saída) de varredura por meio do Prompt Shield automaticamente quando a chave de API está habilitada. Você pode substituir o comportamento de uma única chamada por um objeto prompt_shield no corpo da solicitação:
Você não pode combinar policy com enabled: false. A política aplicada é ecoada na resposta (metadata.prompt_shield_policy no endpoint clássico, secureai.prompt_shield_policy no endpoint /v1). Para visualizar o veredicto de uma chamada sem executar o modelo, use Policy Check.

Autenticação

Todas as solicitações da API Prompt Shield requerem uma chave de API SecureAI no cabeçalho Authorization:
As chaves de API são criadas e gerenciadas em Admin -> Chaves de API. Para ativar o Prompt Shield para uma chave de API, edite a chave e alterne Ativar Prompt Shield. Opcionalmente, você pode vincular uma política específica à chave.
##URL base

POSTAR /scan

Analise um único prompt do usuário em busca de ataques de injeção antes de enviá-lo ao seu LLM.

Solicitação

Resposta

Padrão de integração recomendado


POST /saída de digitalização

Examine uma resposta do LLM em busca de evidências de comprometimento, incluindo vazamento de prompt do sistema, vazamento de token canário ou desvio de função.

Solicitação

Resposta


POST /scan-conversa

Digitalize uma conversa inteira de várias voltas de uma só vez. Isso é útil para análise em lote ou para avaliar conversas históricas para detecção retroativa.

Solicitação

Resposta


Respostas de erro


Limites de taxa e desempenho

  • A latência de varredura normalmente é de 1 a 5 ms para as camadas regex e heurística.
  • Adicionar a camada de ML aumenta a latência para 20-50 ms dependendo do provedor de incorporação.
  • A API externa compartilha limites de taxa com o restante da sua alocação de chaves de API.
  • O disjuntor retorna respostas 503 se o motor apresentar 5 falhas consecutivas em 30 segundos.

Habilitando Prompt Shield em uma chave de API

  1. Vá para Administrador -> Chaves de API.
  2. Edite a chave de API usada para chamadas externas.
  3. Ative Ativar Prompt Shield.
  4. Opcionalmente, defina Sensibilidade da blindagem de alerta para strict, balanced ou permissive.
  5. Opcionalmente, defina Prompt Shield Policy para vincular uma política específica a esta chave.
  6. Salve.
Todas as solicitações /api/external/prompt-shield/* feitas com esta chave passam pelo mecanismo com a política configurada.