Documentation
¶
Overview ¶
Package guards provides built-in guardrail implementations.
Index ¶
- type ContentFilterGuard
- type InjectionGuard
- type PIIGuard
- type RegexGuard
- func (g *RegexGuard) AddRedactRule(name, pattern, replacement string) *RegexGuard
- func (g *RegexGuard) AddRule(name, pattern string, action guard.Action, reason string) *RegexGuard
- func (g *RegexGuard) Check(_ context.Context, input *guard.CheckInput) (*guard.CheckResult, error)
- func (g *RegexGuard) Name() string
- func (g *RegexGuard) Phase() guard.Phase
- type RegexRule
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContentFilterGuard ¶
type ContentFilterGuard struct {
// contains filtered or unexported fields
}
ContentFilterGuard blocks requests containing specified keywords or phrases.
func NewContentFilter ¶
func NewContentFilter(action guard.Action, blocklist ...string) *ContentFilterGuard
NewContentFilter creates a content filter guard.
func (*ContentFilterGuard) Check ¶
func (g *ContentFilterGuard) Check(_ context.Context, input *guard.CheckInput) (*guard.CheckResult, error)
func (*ContentFilterGuard) Name ¶
func (g *ContentFilterGuard) Name() string
func (*ContentFilterGuard) Phase ¶
func (g *ContentFilterGuard) Phase() guard.Phase
type InjectionGuard ¶
type InjectionGuard struct {
// contains filtered or unexported fields
}
InjectionGuard detects prompt injection attempts.
func NewInjection ¶
func NewInjection() *InjectionGuard
NewInjection creates a prompt injection detection guard.
func (*InjectionGuard) AddPattern ¶
func (g *InjectionGuard) AddPattern(pattern string)
AddPattern adds a custom injection detection regex pattern.
func (*InjectionGuard) Check ¶
func (g *InjectionGuard) Check(_ context.Context, input *guard.CheckInput) (*guard.CheckResult, error)
func (*InjectionGuard) Name ¶
func (g *InjectionGuard) Name() string
func (*InjectionGuard) Phase ¶
func (g *InjectionGuard) Phase() guard.Phase
type PIIGuard ¶
type PIIGuard struct {
// contains filtered or unexported fields
}
PIIGuard detects and redacts personally identifiable information.
func (*PIIGuard) AddPattern ¶
AddPattern adds a custom PII pattern.
func (*PIIGuard) Check ¶
func (g *PIIGuard) Check(_ context.Context, input *guard.CheckInput) (*guard.CheckResult, error)
type RegexGuard ¶
type RegexGuard struct {
// contains filtered or unexported fields
}
RegexGuard applies custom regex rules to content.
func NewRegex ¶
func NewRegex(name string, phase guard.Phase) *RegexGuard
NewRegex creates a regex-based guard.
func (*RegexGuard) AddRedactRule ¶
func (g *RegexGuard) AddRedactRule(name, pattern, replacement string) *RegexGuard
AddRedactRule adds a rule that redacts matching content.
func (*RegexGuard) AddRule ¶
func (g *RegexGuard) AddRule(name, pattern string, action guard.Action, reason string) *RegexGuard
AddRule adds a regex rule to the guard.
func (*RegexGuard) Check ¶
func (g *RegexGuard) Check(_ context.Context, input *guard.CheckInput) (*guard.CheckResult, error)
func (*RegexGuard) Name ¶
func (g *RegexGuard) Name() string
func (*RegexGuard) Phase ¶
func (g *RegexGuard) Phase() guard.Phase
Source Files
Click to show internal directories.
Click to hide internal directories.