shieldadapter

package

v1.9.2 Latest Latest Go to latest Published: Nov 4, 2026 License: MIT Imports: 3 Imported by: 0

Details

Package shieldadapter provides a guardrail adapter that bridges an external Shield content safety engine to the Nexus guard.Guard interface.

Deprecated: Shield ships its own guard, github.com/xraph/shield/integrations/nexusguard. This package will be removed in v2.

This section is empty.

This section is empty.

func WrapMessages(messages []provider.Message) string

WrapMessages extracts text from provider messages for Shield checking.

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

Adapter bridges Shield to the Nexus guard.Guard interface.

Deprecated: Shield ships its own guard, github.com/xraph/shield/integrations/nexusguard. This package will be removed in v2.

func New(engine Engine) *Adapter

New creates a Shield guard adapter.

Deprecated: Shield ships its own guard, github.com/xraph/shield/integrations/nexusguard. This package will be removed in v2.

func NewWithAction(engine Engine, action guard.Action) *Adapter

NewWithAction creates a Shield guard adapter with a specific action.

Deprecated: Shield ships its own guard, github.com/xraph/shield/integrations/nexusguard. This package will be removed in v2.

func (a *Adapter) Check(ctx context.Context, input *guard.CheckInput) (*guard.CheckResult, error)

func (a *Adapter) Name() string

func (a *Adapter) Phase() guard.Phase

type Engine interface {
	// Check evaluates content for safety violations.
	Check(ctx context.Context, content string) (*Result, error)
}

Engine represents an external Shield content safety engine. This is the minimal interface that the adapter requires.

type Result struct {
	Allowed bool    `json:"allowed"`
	Reason  string  `json:"reason,omitempty"`
	Score   float64 `json:"score"`
}

Result is the Shield check result.