Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

swd

package module

Go to main page

Versions in this module

v0

v0.3.0

Sep 5, 2026

Changes in this version

type Category

+ const AIGC

+ const AdCompliance

+ const Contraband

+ const Inappropriate

+ const Promotion

+ const Religion

+ func UserCategory(n int) Category

type Engine

+ func (e *Engine) AddLabeledWord(word string, label Label) error

+ func (e *Engine) AddLabeledWords(words map[string]Label) error

+ func (e *Engine) Check(text string) Result

+ func (e *Engine) CheckIn(text string, categories ...Category) Result

+ type Label uint8

+ const AIGCGenerated

+ const AdComplianceViolation

+ const ContrabandAct

+ const ContrabandDrug

+ const ContrabandEntity

+ const ContrabandForgery

+ const ContrabandFraud

+ const ContrabandGambling

+ const ContrabandPrivacy

+ const Customized

+ const InappropriateDiscrimination

+ const InappropriateEthics

+ const InappropriateNonsense

+ const InappropriateOral

+ const InappropriateProfanity

+ const InappropriateSuperstition

+ const LabelNone

+ const PoliticalEntity

+ const PoliticalFigure

+ const PoliticalSensitive

+ const PornographicAdult

+ const PromotionContact

+ const PromotionRecruitment

+ const PromotionToSites

+ const ReligionGeneral

+ const SexualSuggestive

+ const SexualTerms

+ const ViolentExtremist

+ const ViolentIncidents

+ const ViolentWeapons

+ func Labels() []Label

+ func (l Label) Category() Category

+ func (l Label) Chinese() string

+ func (l Label) Risk() Risk

+ func (l Label) String() string

type Match

+ Confidence uint8

+ Label Label

+ Risk Risk

type Option

+ func WithLabeledWords(words map[string]Label) Option

+ type Result struct

+ Categories Category

+ Confidence uint8

+ Label Label

+ Matches []Match

+ Risk Risk

+ func (r Result) Hit() bool

+ func (r Result) Suggestion() string

+ type Risk uint8

+ const RiskHigh

+ const RiskLow

+ const RiskMedium

+ const RiskNone

+ func (r Risk) String() string

+ func (r Risk) Suggestion() string

v0.2.1

Sep 5, 2026

v0.2.0

Sep 5, 2026

Changes in this version

+ var ErrEmptyWord = errors.New("swd: empty word")

+ var ErrInvalidCategory = errors.New("swd: invalid category")

+ var ErrWordTooLong = errors.New("swd: word longer than 255 characters")

type Category

+ func (c Category) Contains(other Category) bool

+ func (c Category) IsValid() bool

+ func (c Category) String() string

+ type Engine struct

+ func (e *Engine) AddAllowWords(words ...string) error

+ func (e *Engine) AddWord(word string, category Category) error

+ func (e *Engine) AddWords(words map[string]Category) error

+ func (e *Engine) Clear() error

+ func (e *Engine) Detect(text string) bool

+ func (e *Engine) DetectIn(text string, categories ...Category) bool

+ func (e *Engine) Len() int

+ func (e *Engine) Match(text string) *Match

+ func (e *Engine) MatchAll(text string) []Match

+ func (e *Engine) MatchAllIn(text string, categories ...Category) []Match

+ func (e *Engine) MatchIn(text string, categories ...Category) *Match

+ func (e *Engine) Matches(text string) iter.Seq[Match]

+ func (e *Engine) MatchesIn(text string, categories ...Category) iter.Seq[Match]

+ func (e *Engine) RemoveAllowWords(words ...string) error

+ func (e *Engine) RemoveWord(word string) error

+ func (e *Engine) RemoveWords(words []string) error

+ func (e *Engine) Replace(text string, replacement rune) string

+ func (e *Engine) ReplaceIn(text string, replacement rune, categories ...Category) string

+ func (e *Engine) ReplaceWithAsterisk(text string) string

+ func (e *Engine) ReplaceWithAsteriskIn(text string, categories ...Category) string

+ func (e *Engine) ReplaceWithStrategy(text string, strategy func(word Match) string) string

+ func (e *Engine) ReplaceWithStrategyIn(text string, strategy func(word Match) string, categories ...Category) string

+ func (e *Engine) Stats() Stats

+ func (e *Engine) Words() map[string]Category

+ type Match struct

+ ByteEnd int

+ ByteStart int

+ Category Category

+ EndPos int

+ StartPos int

+ Word string

+ type Option func(*config)

+ func WithAllowWords(words ...string) Option

+ func WithCollapseRepeats(on bool) Option

+ func WithMaxGap(n int) Option

+ func WithWords(words map[string]Category) Option

+ func WithoutDefaultDict() Option

+ type Stats struct

+ AllowWords int

+ Alphabet int

+ Bytes int

+ Nodes int

+ Words int

v0.0.3

Aug 31, 2025

v0.0.2

Feb 5, 2025

v0.0.1

Dec 25, 2024

Changes in this version

+ const Custom

+ const Discrimination

+ const Drugs

+ const Gambling

+ const None

+ const Political

+ const Pornography

+ const Profanity

+ const Scam

+ const Violence

+ var All = category.All

+ type Category = category.Category

+ type ComponentFactory = swd.ComponentFactory

+ type SWD = swd.SWD

+ func New() (*SWD, error)

+ func NewWithFactory(factory swd.ComponentFactory) (*SWD, error)

+ type SensitiveWord = core.SensitiveWord