moderation

type Client interface {
	// ClassifyText classifies the provided text for moderation. The result
	// indicates whether the text was flagged and includes per-category scores.
	// This is the generic classification that should be applied to all text.
	// For usecase-specific moderation, an additional call must be made.
	ClassifyText(ctx context.Context, text string) (*Result, error)

	// ClassifyImage classifies the provided image data for moderation. The
	// result indicates whether the image was flagged and includes per-category
	// scores.
	ClassifyImage(ctx context.Context, data []byte) (*Result, error)

	// ClassifyCurrencyName checks whether a currency name infringes on
	// existing trademarks, impersonates known brands, or is otherwise
	// misleading. The result includes per-category scores for areas like
	// cryptocurrency, financial_service, impersonation, etc.
	ClassifyCurrencyName(ctx context.Context, name string) (*Result, error)

	// ClassifyUsername checks a user-chosen username on two independent axes:
	// who the handle claims to be, and what it says.
	//
	// A handle is unique and globally addressable, so holding one is a claim to
	// be its subject. It is scored for squatting a brand, token, exchange,
	// financial service, government body, public figure, or the Flipcash
	// platform itself, and for reading as an official support or staff role
	// rather than as a person. This is the reverse of ClassifyDisplayName,
	// which deliberately allows any name: a display name is not unique, so it
	// claims nothing.
	//
	// A handle is also text other users see when they pay, message, or search
	// for its holder, so it is scored for harmful content under the same
	// categories ClassifyDisplayName uses. Overlapping ClassifyText there is
	// deliberate: a handle is at most 30 characters with no whitespace, rarely
	// enough for the general classifier to identify a language, so it often
	// declines with ErrUnsupportedLanguage and leaves this the only classifier
	// that saw the handle.
	//
	// The result includes per-category scores for areas like impersonation,
	// official_role, hate, sexual, etc.
	ClassifyUsername(ctx context.Context, username string) (*Result, error)

	// ClassifyDisplayName checks whether a user-chosen display name abuses the
	// name field to advertise, solicit, or expose others to harmful content.
	// The result includes per-category scores for areas like solicitation,
	// contact_info, hate, etc.
	//
	// It deliberately does not score impersonation: users are free to call
	// themselves whatever they like, including the name of a real person or
	// brand. Nor does it score gibberish, and neither does ClassifyUsername: a
	// random-looking name or handle is a user's to choose, and a meaningless
	// one harms no one, so both are judged only on what they spell. ClassifyText
	// still scores gibberish when run on the same name, and a caller moderating
	// a name sets that one verdict aside with Result.Ignoring. It is also
	// distinct from ClassifyText, which is tuned for prose and has little to
	// work with in a one- or two-word name.
	ClassifyDisplayName(ctx context.Context, name string) (*Result, error)

	// ClassifyGroupTitle checks whether a user-chosen group chat title abuses
	// the title to advertise, solicit, or expose others to harmful content. It
	// is the group counterpart of ClassifyDisplayName and scores the same
	// categories (solicitation, contact_info, hate, etc.), but is tuned for what
	// a title is: a label for a shared room, seen by everyone in the group and
	// everyone considering joining it, that names a topic, a community, or an
	// occasion rather than a person. It is the one name-like classifier that
	// also scores gibberish, because a title with no plausible meaning is a
	// room nobody can find rather than a name somebody chose.
	//
	// Like ClassifyDisplayName it does not score impersonation: a group may be
	// titled after any brand, person, or topic. It is also distinct from
	// ClassifyText, which has little to work with in a short title.
	ClassifyGroupTitle(ctx context.Context, title string) (*Result, error)
}

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

type Result struct {
	// Is the piece of data flaggged as unsafe?
	Flagged bool

	// Categories that caused the data to be flagged
	FlaggedCategories []string

	// Various category scores applied to the piece of data
	CategoryScores map[string]float64
}

type Server struct {
	moderationpb.UnimplementedModerationServer
	// contains filtered or unexported fields
}