moderation

Documentation

Index

• type Categories
• type CategoryScores
• type Client
  • func New(httpCli *http.Client, apiKey string) *Client
  • func (c Client) Check(ctx context.Context, input string) (*Response, error)
• type Request
• type Response
  • func (r Response) Flagged() bool
  • func (r Response) Reasons() string
• type Results

Types

type Categories

type Categories struct {
	Hate            bool `json:"hate"`
	HateThreatening bool `json:"hate/threatening"`
	SelfHarm        bool `json:"self-harm"`
	Sexual          bool `json:"sexual"`
	SexualMinors    bool `json:"sexual/minors"`
	Violence        bool `json:"violence"`
	ViolenceGraphic bool `json:"violence/graphic"`
}

type CategoryScores

type CategoryScores struct {
	Hate            float64 `json:"hate"`
	HateThreatening float64 `json:"hate/threatening"`
	SelfHarm        float64 `json:"self-harm"`
	Sexual          float64 `json:"sexual"`
	SexualMinors    float64 `json:"sexual/minors"`
	Violence        float64 `json:"violence"`
	ViolenceGraphic float64 `json:"violence/graphic"`
}

type Client

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

func New

func New(httpCli *http.Client, apiKey string) *Client

func (Client) Check

func (c Client) Check(ctx context.Context, input string) (*Response, error)

type Request

type Request struct {
	Input string `json:"input"`
}

type Response

type Response struct {
	ID      string    `json:"id"`
	Model   string    `json:"model"`
	Results []Results `json:"results"`
}

func (Response) Flagged

func (r Response) Flagged() bool

func (Response) Reasons

func (r Response) Reasons() string

type Results

type Results struct {
	Categories     Categories     `json:"categories"`
	CategoryScores CategoryScores `json:"category_scores"`
	Flagged        bool           `json:"flagged"`
}