title: apogee-ai-guardrails description: Input/output filters: PII, prompt injection, jailbreak; commercial-grade adapters.
apogee-ai-guardrails¶
Input/output filters: PII, prompt injection, jailbreak; commercial-grade adapters.
Esta página está sendo ampliada
As tabelas abaixo são geradas do código-fonte do pacote, portanto estão corretas. Guias narrativos e exemplos comentados estão sendo escritos módulo a módulo.
API pública¶
Tudo abaixo é exportado pela raiz do pacote, então from apogee_ai_guardrails import X funciona para cada nome.
| Camada | Símbolos |
|---|---|
| Application | PolicyOutcome |
| Application · DTOs | ApplyPolicyDTO, BenchDTO, RedactDTO, ScanDTO |
| Application · Use cases | ApplyPolicyUseCase, BenchPipelineUseCase, ListDetectorsUseCase, RedactTextUseCase, ScanTextUseCase |
| Domain | GuardrailReport, GuardrailViolation, RedactionPolicy, RedactionStrategy, RuleSeverity, ScanDirection |
| Domain · Enums | PiiKind |
| Domain · Exceptions | GuardrailBlockedException, GuardrailError, PolicyViolationException |
| Domain · Protocols (ports) | IDetector, IGuardrailPipeline, IRedactor |
| Infrastructure | DetectorRegistry, FormatPreservingRedactor, HashRedactor, JailbreakDetector, MaskRedactor, PiiDetector, PresidioPiiDetector, ProfanityDetector, PromptInjectionDetector, SchemaDetector, default_redaction_policy |
Instalação¶
A instalação base não tem dependência externa obrigatória. Cada extra habilita um adapter.
| Extra | Traz |
|---|---|
presidio |
presidio-analyzer>=2.2, presidio-anonymizer>=2.2 |
detoxify |
detoxify>=0.5 |
CLI¶
Instalado como console script e registrado como plugin do apogee, então os mesmos subcomandos funcionam sob o binário global.
Leia a seguir¶
- Instalação
- Referência — todo símbolo público, gerado do código-fonte
- Apogee Framework — como os pacotes se encaixam