outputguard

Documentation

Index

• Variables
• type BoundGuard
  • func (g *BoundGuard) Check(text string) Evaluation
  • func (g *BoundGuard) Validate(text string) error
• type CheckRequest
• type Decision
• type Evaluation
• type Guard
  • func NewGuard() *Guard
  • func (g *Guard) Bind(protectedTexts []string) (*BoundGuard, error)
  • func (g *Guard) Check(req CheckRequest) Evaluation
  • func (g *Guard) Validate(req CheckRequest) error
• type ReasonCode

Variables

var ErrInvalidProtectedTexts = errors.New("outputguard: invalid protected texts")

var ErrRestrictedGeneratedText = errors.New("generated answer contains restricted output")

Types

type BoundGuard

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

BoundGuard는 한 요청의 정규화된 protected text index를 소유한다.

func (*BoundGuard) Check

func (g *BoundGuard) Check(text string) Evaluation

func (*BoundGuard) Validate

func (g *BoundGuard) Validate(text string) error

type CheckRequest

type CheckRequest struct {
	Text string `json:"text"`
}

type Decision

type Decision string

const (
	DecisionAllow Decision = "allow"
	DecisionBlock Decision = "block"
)

type Evaluation

type Evaluation struct {
	Decision    Decision     `json:"decision"`
	ReasonCodes []ReasonCode `json:"reason_codes,omitempty"`
	RuleIDs     []string     `json:"rule_ids,omitempty"`
	OutputBytes int          `json:"output_bytes"`
}

type Guard

type Guard struct{}

func NewGuard

func NewGuard() *Guard

func (*Guard) Bind

func (g *Guard) Bind(protectedTexts []string) (*BoundGuard, error)

func (*Guard) Check

func (g *Guard) Check(req CheckRequest) Evaluation

func (*Guard) Validate

func (g *Guard) Validate(req CheckRequest) error

type ReasonCode

type ReasonCode string

const (
	ReasonRoleBlock             ReasonCode = "role_block"
	ReasonSecretPattern         ReasonCode = "secret_pattern"
	ReasonProtectedTextOverlap  ReasonCode = "protected_text_overlap"
	ReasonProtectedInputInvalid ReasonCode = "protected_input_invalid"
	ReasonDecodeIncomplete      ReasonCode = "decode_incomplete"
	ReasonOutputOversize        ReasonCode = "output_oversize"
)