guardrails

type Action string

type AuthorizationConfig struct {
	Enabled      bool     `json:"enabled" yaml:"enabled"`
	AllowedTools []string `json:"allowed_tools,omitempty" yaml:"allowed_tools,omitempty"`
	BlockedTools []string `json:"blocked_tools,omitempty" yaml:"blocked_tools,omitempty"`
	Action       Action   `json:"action" yaml:"action"`
	Severity     Severity `json:"severity" yaml:"severity"`
}

type ChainError struct {
	Errors []*GuardrailError
}

type ChainMode string

type Config struct {
	// Input guardrail configurations.
	Input InputConfig `json:"input" yaml:"input"`

	// Output guardrail configurations.
	Output OutputConfig `json:"output" yaml:"output"`

	// Tool guardrail configurations.
	Tool ToolConfig `json:"tool" yaml:"tool"`
}

type ContentConfig struct {
	Enabled         bool     `json:"enabled" yaml:"enabled"`
	BlockedKeywords []string `json:"blocked_keywords,omitempty" yaml:"blocked_keywords,omitempty"`
	BlockedPatterns []string `json:"blocked_patterns,omitempty" yaml:"blocked_patterns,omitempty"`
	Action          Action   `json:"action" yaml:"action"`
	Severity        Severity `json:"severity" yaml:"severity"`
}

type GuardrailError struct {
	GuardrailName string
	Reason        string
	Severity      Severity
	Details       map[string]any
}

type InjectionConfig struct {
	Enabled       bool     `json:"enabled" yaml:"enabled"`
	Patterns      []string `json:"patterns,omitempty" yaml:"patterns,omitempty"`
	CaseSensitive bool     `json:"case_sensitive" yaml:"case_sensitive"`
	Action        Action   `json:"action" yaml:"action"`
	Severity      Severity `json:"severity" yaml:"severity"`
}

type InputChain struct {
	// contains filtered or unexported fields
}

type InputChainBuilders struct {
	LengthValidator   func(*LengthConfig) InputGuardrail
	InjectionDetector func(*InjectionConfig) InputGuardrail
	Sanitizer         func(*SanitizerConfig) InputGuardrail
}

type InputConfig struct {
	// ChainMode for input guardrails.
	ChainMode ChainMode `json:"chain_mode" yaml:"chain_mode"`

	// Length validation settings.
	Length *LengthConfig `json:"length,omitempty" yaml:"length,omitempty"`

	// Injection detection settings.
	Injection *InjectionConfig `json:"injection,omitempty" yaml:"injection,omitempty"`

	// Sanitization settings.
	Sanitizer *SanitizerConfig `json:"sanitizer,omitempty" yaml:"sanitizer,omitempty"`
}

type InputGuardrail interface {
	// Name returns the guardrail's unique identifier.
	Name() string

	// Check validates the input and returns a result.
	// If the result action is ActionModify, the Modified field contains
	// the transformed input string.
	Check(ctx context.Context, input string) (*Result, error)
}

type LengthConfig struct {
	Enabled   bool     `json:"enabled" yaml:"enabled"`
	MinLength int      `json:"min_length" yaml:"min_length"`
	MaxLength int      `json:"max_length" yaml:"max_length"`
	Action    Action   `json:"action" yaml:"action"`
	Severity  Severity `json:"severity" yaml:"severity"`
}

type OutputChain struct {
	// contains filtered or unexported fields
}

type OutputChainBuilders struct {
	PIIRedactor   func(*PIIConfig) OutputGuardrail
	ContentFilter func(*ContentConfig) OutputGuardrail
}

type OutputConfig struct {
	// ChainMode for output guardrails.
	ChainMode ChainMode `json:"chain_mode" yaml:"chain_mode"`

	// PII detection/redaction settings.
	PII *PIIConfig `json:"pii,omitempty" yaml:"pii,omitempty"`

	// Content filtering settings.
	Content *ContentConfig `json:"content,omitempty" yaml:"content,omitempty"`
}

type OutputGuardrail interface {
	// Name returns the guardrail's unique identifier.
	Name() string

	// Check validates the output and returns a result.
	// If the result action is ActionModify, the Modified field contains
	// the transformed output string.
	Check(ctx context.Context, output string) (*Result, error)
}

type PIIConfig struct {
	Enabled          bool       `json:"enabled" yaml:"enabled"`
	DetectEmail      bool       `json:"detect_email" yaml:"detect_email"`
	DetectPhone      bool       `json:"detect_phone" yaml:"detect_phone"`
	DetectSSN        bool       `json:"detect_ssn" yaml:"detect_ssn"`
	DetectCreditCard bool       `json:"detect_credit_card" yaml:"detect_credit_card"`
	RedactMode       RedactMode `json:"redact_mode" yaml:"redact_mode"`
	Action           Action     `json:"action" yaml:"action"`
	Severity         Severity   `json:"severity" yaml:"severity"`
}

type RedactMode string

type Result struct {
	// Action to take based on the check result.
	Action Action `json:"action"`

	// Severity of the issue detected (if any).
	Severity Severity `json:"severity,omitempty"`

	// Reason provides a human-readable explanation.
	Reason string `json:"reason,omitempty"`

	// GuardrailName is the name of the guardrail that produced this result.
	GuardrailName string `json:"guardrail_name"`

	// Modified contains the modified value if Action == ActionModify.
	Modified any `json:"-"`

	// Details contains additional metadata about the check.
	Details map[string]any `json:"details,omitempty"`
}

type SanitizerConfig struct {
	Enabled          bool `json:"enabled" yaml:"enabled"`
	TrimWhitespace   bool `json:"trim_whitespace" yaml:"trim_whitespace"`
	NormalizeUnicode bool `json:"normalize_unicode" yaml:"normalize_unicode"`
	MaxLength        int  `json:"max_length" yaml:"max_length"`
	StripHTML        bool `json:"strip_html" yaml:"strip_html"`
}

type Severity string

type ToolChain struct {
	// contains filtered or unexported fields
}

type ToolChainBuilders struct {
	Authorizer func(*AuthorizationConfig) ToolGuardrail
}

type ToolConfig struct {
	// ChainMode for tool guardrails.
	ChainMode ChainMode `json:"chain_mode" yaml:"chain_mode"`

	// Authorization settings.
	Authorization *AuthorizationConfig `json:"authorization,omitempty" yaml:"authorization,omitempty"`
}

type ToolGuardrail interface {
	// Name returns the guardrail's unique identifier.
	Name() string

	// Check validates the tool call and returns a result.
	// If the result action is ActionModify, the Modified field contains
	// the transformed arguments map.
	Check(ctx context.Context, toolName string, args map[string]any) (*Result, error)
}