openai.openai-go/moderation.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package openai

import (
	"context"
	"net/http"

	"github.com/openai/openai-go/internal/apijson"
	"github.com/openai/openai-go/internal/requestconfig"
	"github.com/openai/openai-go/option"
	"github.com/openai/openai-go/packages/param"
	"github.com/openai/openai-go/packages/resp"
	"github.com/openai/openai-go/shared/constant"
)

// ModerationService contains methods and other services that help with interacting
// with the openai API.
//
// Note, unlike clients, this service does not read variables from the environment
// automatically. You should not instantiate this service directly, and instead use
// the [NewModerationService] method instead.
type ModerationService struct {
	Options []option.RequestOption
}

// NewModerationService generates a new service that applies the given options to
// each request. These options are applied after the parent client's options (if
// there is one), and before any request-specific options.
func NewModerationService(opts ...option.RequestOption) (r ModerationService) {
	r = ModerationService{}
	r.Options = opts
	return
}

// Classifies if text and/or image inputs are potentially harmful. Learn more in
// the [moderation guide](https://platform.openai.com/docs/guides/moderation).
func (r *ModerationService) New(ctx context.Context, body ModerationNewParams, opts ...option.RequestOption) (res *ModerationNewResponse, err error) {
	opts = append(r.Options[:], opts...)
	path := "moderations"
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
	return
}

type Moderation struct {
	// A list of the categories, and whether they are flagged or not.
	Categories ModerationCategories `json:"categories,omitzero,required"`
	// A list of the categories along with the input type(s) that the score applies to.
	CategoryAppliedInputTypes ModerationCategoryAppliedInputTypes `json:"category_applied_input_types,omitzero,required"`
	// A list of the categories along with their scores as predicted by model.
	CategoryScores ModerationCategoryScores `json:"category_scores,omitzero,required"`
	// Whether any of the below categories are flagged.
	Flagged bool `json:"flagged,omitzero,required"`
	JSON    struct {
		Categories                resp.Field
		CategoryAppliedInputTypes resp.Field
		CategoryScores            resp.Field
		Flagged                   resp.Field
		raw                       string
	} `json:"-"`
}

func (r Moderation) RawJSON() string { return r.JSON.raw }
func (r *Moderation) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

// A list of the categories, and whether they are flagged or not.
type ModerationCategories struct {
	// Content that expresses, incites, or promotes harassing language towards any
	// target.
	Harassment bool `json:"harassment,omitzero,required"`
	// Harassment content that also includes violence or serious harm towards any
	// target.
	HarassmentThreatening bool `json:"harassment/threatening,omitzero,required"`
	// Content that expresses, incites, or promotes hate based on race, gender,
	// ethnicity, religion, nationality, sexual orientation, disability status, or
	// caste. Hateful content aimed at non-protected groups (e.g., chess players) is
	// harassment.
	Hate bool `json:"hate,omitzero,required"`
	// Hateful content that also includes violence or serious harm towards the targeted
	// group based on race, gender, ethnicity, religion, nationality, sexual
	// orientation, disability status, or caste.
	HateThreatening bool `json:"hate/threatening,omitzero,required"`
	// Content that includes instructions or advice that facilitate the planning or
	// execution of wrongdoing, or that gives advice or instruction on how to commit
	// illicit acts. For example, "how to shoplift" would fit this category.
	Illicit bool `json:"illicit,omitzero,required,nullable"`
	// Content that includes instructions or advice that facilitate the planning or
	// execution of wrongdoing that also includes violence, or that gives advice or
	// instruction on the procurement of any weapon.
	IllicitViolent bool `json:"illicit/violent,omitzero,required,nullable"`
	// Content that promotes, encourages, or depicts acts of self-harm, such as
	// suicide, cutting, and eating disorders.
	SelfHarm bool `json:"self-harm,omitzero,required"`
	// Content that encourages performing acts of self-harm, such as suicide, cutting,
	// and eating disorders, or that gives instructions or advice on how to commit such
	// acts.
	SelfHarmInstructions bool `json:"self-harm/instructions,omitzero,required"`
	// Content where the speaker expresses that they are engaging or intend to engage
	// in acts of self-harm, such as suicide, cutting, and eating disorders.
	SelfHarmIntent bool `json:"self-harm/intent,omitzero,required"`
	// Content meant to arouse sexual excitement, such as the description of sexual
	// activity, or that promotes sexual services (excluding sex education and
	// wellness).
	Sexual bool `json:"sexual,omitzero,required"`
	// Sexual content that includes an individual who is under 18 years old.
	SexualMinors bool `json:"sexual/minors,omitzero,required"`
	// Content that depicts death, violence, or physical injury.
	Violence bool `json:"violence,omitzero,required"`
	// Content that depicts death, violence, or physical injury in graphic detail.
	ViolenceGraphic bool `json:"violence/graphic,omitzero,required"`
	JSON            struct {
		Harassment            resp.Field
		HarassmentThreatening resp.Field
		Hate                  resp.Field
		HateThreatening       resp.Field
		Illicit               resp.Field
		IllicitViolent        resp.Field
		SelfHarm              resp.Field
		SelfHarmInstructions  resp.Field
		SelfHarmIntent        resp.Field
		Sexual                resp.Field
		SexualMinors          resp.Field
		Violence              resp.Field
		ViolenceGraphic       resp.Field
		raw                   string
	} `json:"-"`
}

func (r ModerationCategories) RawJSON() string { return r.JSON.raw }
func (r *ModerationCategories) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

// A list of the categories along with the input type(s) that the score applies to.
type ModerationCategoryAppliedInputTypes struct {
	// The applied input type(s) for the category 'harassment'.
	Harassment []string `json:"harassment,omitzero,required"`
	// The applied input type(s) for the category 'harassment/threatening'.
	HarassmentThreatening []string `json:"harassment/threatening,omitzero,required"`
	// The applied input type(s) for the category 'hate'.
	Hate []string `json:"hate,omitzero,required"`
	// The applied input type(s) for the category 'hate/threatening'.
	HateThreatening []string `json:"hate/threatening,omitzero,required"`
	// The applied input type(s) for the category 'illicit'.
	Illicit []string `json:"illicit,omitzero,required"`
	// The applied input type(s) for the category 'illicit/violent'.
	IllicitViolent []string `json:"illicit/violent,omitzero,required"`
	// The applied input type(s) for the category 'self-harm'.
	SelfHarm []string `json:"self-harm,omitzero,required"`
	// The applied input type(s) for the category 'self-harm/instructions'.
	SelfHarmInstructions []string `json:"self-harm/instructions,omitzero,required"`
	// The applied input type(s) for the category 'self-harm/intent'.
	SelfHarmIntent []string `json:"self-harm/intent,omitzero,required"`
	// The applied input type(s) for the category 'sexual'.
	Sexual []string `json:"sexual,omitzero,required"`
	// The applied input type(s) for the category 'sexual/minors'.
	SexualMinors []string `json:"sexual/minors,omitzero,required"`
	// The applied input type(s) for the category 'violence'.
	Violence []string `json:"violence,omitzero,required"`
	// The applied input type(s) for the category 'violence/graphic'.
	ViolenceGraphic []string `json:"violence/graphic,omitzero,required"`
	JSON            struct {
		Harassment            resp.Field
		HarassmentThreatening resp.Field
		Hate                  resp.Field
		HateThreatening       resp.Field
		Illicit               resp.Field
		IllicitViolent        resp.Field
		SelfHarm              resp.Field
		SelfHarmInstructions  resp.Field
		SelfHarmIntent        resp.Field
		Sexual                resp.Field
		SexualMinors          resp.Field
		Violence              resp.Field
		ViolenceGraphic       resp.Field
		raw                   string
	} `json:"-"`
}

func (r ModerationCategoryAppliedInputTypes) RawJSON() string { return r.JSON.raw }
func (r *ModerationCategoryAppliedInputTypes) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type ModerationCategoryAppliedInputTypesHarassment = string

const (
	ModerationCategoryAppliedInputTypesHarassmentText ModerationCategoryAppliedInputTypesHarassment = "text"
)

type ModerationCategoryAppliedInputTypesHarassmentThreatening = string

const (
	ModerationCategoryAppliedInputTypesHarassmentThreateningText ModerationCategoryAppliedInputTypesHarassmentThreatening = "text"
)

type ModerationCategoryAppliedInputTypesHate = string

const (
	ModerationCategoryAppliedInputTypesHateText ModerationCategoryAppliedInputTypesHate = "text"
)

type ModerationCategoryAppliedInputTypesHateThreatening = string

const (
	ModerationCategoryAppliedInputTypesHateThreateningText ModerationCategoryAppliedInputTypesHateThreatening = "text"
)

type ModerationCategoryAppliedInputTypesIllicit = string

const (
	ModerationCategoryAppliedInputTypesIllicitText ModerationCategoryAppliedInputTypesIllicit = "text"
)

type ModerationCategoryAppliedInputTypesIllicitViolent = string

const (
	ModerationCategoryAppliedInputTypesIllicitViolentText ModerationCategoryAppliedInputTypesIllicitViolent = "text"
)

type ModerationCategoryAppliedInputTypesSelfHarm = string

const (
	ModerationCategoryAppliedInputTypesSelfHarmText  ModerationCategoryAppliedInputTypesSelfHarm = "text"
	ModerationCategoryAppliedInputTypesSelfHarmImage ModerationCategoryAppliedInputTypesSelfHarm = "image"
)

type ModerationCategoryAppliedInputTypesSelfHarmInstruction = string

const (
	ModerationCategoryAppliedInputTypesSelfHarmInstructionText  ModerationCategoryAppliedInputTypesSelfHarmInstruction = "text"
	ModerationCategoryAppliedInputTypesSelfHarmInstructionImage ModerationCategoryAppliedInputTypesSelfHarmInstruction = "image"
)

type ModerationCategoryAppliedInputTypesSelfHarmIntent = string

const (
	ModerationCategoryAppliedInputTypesSelfHarmIntentText  ModerationCategoryAppliedInputTypesSelfHarmIntent = "text"
	ModerationCategoryAppliedInputTypesSelfHarmIntentImage ModerationCategoryAppliedInputTypesSelfHarmIntent = "image"
)

type ModerationCategoryAppliedInputTypesSexual = string

const (
	ModerationCategoryAppliedInputTypesSexualText  ModerationCategoryAppliedInputTypesSexual = "text"
	ModerationCategoryAppliedInputTypesSexualImage ModerationCategoryAppliedInputTypesSexual = "image"
)

type ModerationCategoryAppliedInputTypesSexualMinor = string

const (
	ModerationCategoryAppliedInputTypesSexualMinorText ModerationCategoryAppliedInputTypesSexualMinor = "text"
)

type ModerationCategoryAppliedInputTypesViolence = string

const (
	ModerationCategoryAppliedInputTypesViolenceText  ModerationCategoryAppliedInputTypesViolence = "text"
	ModerationCategoryAppliedInputTypesViolenceImage ModerationCategoryAppliedInputTypesViolence = "image"
)

type ModerationCategoryAppliedInputTypesViolenceGraphic = string

const (
	ModerationCategoryAppliedInputTypesViolenceGraphicText  ModerationCategoryAppliedInputTypesViolenceGraphic = "text"
	ModerationCategoryAppliedInputTypesViolenceGraphicImage ModerationCategoryAppliedInputTypesViolenceGraphic = "image"
)

// A list of the categories along with their scores as predicted by model.
type ModerationCategoryScores struct {
	// The score for the category 'harassment'.
	Harassment float64 `json:"harassment,omitzero,required"`
	// The score for the category 'harassment/threatening'.
	HarassmentThreatening float64 `json:"harassment/threatening,omitzero,required"`
	// The score for the category 'hate'.
	Hate float64 `json:"hate,omitzero,required"`
	// The score for the category 'hate/threatening'.
	HateThreatening float64 `json:"hate/threatening,omitzero,required"`
	// The score for the category 'illicit'.
	Illicit float64 `json:"illicit,omitzero,required"`
	// The score for the category 'illicit/violent'.
	IllicitViolent float64 `json:"illicit/violent,omitzero,required"`
	// The score for the category 'self-harm'.
	SelfHarm float64 `json:"self-harm,omitzero,required"`
	// The score for the category 'self-harm/instructions'.
	SelfHarmInstructions float64 `json:"self-harm/instructions,omitzero,required"`
	// The score for the category 'self-harm/intent'.
	SelfHarmIntent float64 `json:"self-harm/intent,omitzero,required"`
	// The score for the category 'sexual'.
	Sexual float64 `json:"sexual,omitzero,required"`
	// The score for the category 'sexual/minors'.
	SexualMinors float64 `json:"sexual/minors,omitzero,required"`
	// The score for the category 'violence'.
	Violence float64 `json:"violence,omitzero,required"`
	// The score for the category 'violence/graphic'.
	ViolenceGraphic float64 `json:"violence/graphic,omitzero,required"`
	JSON            struct {
		Harassment            resp.Field
		HarassmentThreatening resp.Field
		Hate                  resp.Field
		HateThreatening       resp.Field
		Illicit               resp.Field
		IllicitViolent        resp.Field
		SelfHarm              resp.Field
		SelfHarmInstructions  resp.Field
		SelfHarmIntent        resp.Field
		Sexual                resp.Field
		SexualMinors          resp.Field
		Violence              resp.Field
		ViolenceGraphic       resp.Field
		raw                   string
	} `json:"-"`
}

func (r ModerationCategoryScores) RawJSON() string { return r.JSON.raw }
func (r *ModerationCategoryScores) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

// An object describing an image to classify.
type ModerationImageURLInputParam struct {
	// Contains either an image URL or a data URL for a base64 encoded image.
	ImageURL ModerationImageURLInputImageURLParam `json:"image_url,omitzero,required"`
	// Always `image_url`.
	//
	// This field can be elided, and will be automatically set as "image_url".
	Type constant.ImageURL `json:"type,required"`
	apiobject
}

func (f ModerationImageURLInputParam) IsMissing() bool { return param.IsOmitted(f) || f.IsNull() }

func (r ModerationImageURLInputParam) MarshalJSON() (data []byte, err error) {
	type shadow ModerationImageURLInputParam
	return param.MarshalObject(r, (*shadow)(&r))
}

// Contains either an image URL or a data URL for a base64 encoded image.
type ModerationImageURLInputImageURLParam struct {
	// Either a URL of the image or the base64 encoded image data.
	URL param.String `json:"url,omitzero,required" format:"uri"`
	apiobject
}

func (f ModerationImageURLInputImageURLParam) IsMissing() bool {
	return param.IsOmitted(f) || f.IsNull()
}

func (r ModerationImageURLInputImageURLParam) MarshalJSON() (data []byte, err error) {
	type shadow ModerationImageURLInputImageURLParam
	return param.MarshalObject(r, (*shadow)(&r))
}

type ModerationModel = string

const (
	ModerationModelOmniModerationLatest     ModerationModel = "omni-moderation-latest"
	ModerationModelOmniModeration2024_09_26 ModerationModel = "omni-moderation-2024-09-26"
	ModerationModelTextModerationLatest     ModerationModel = "text-moderation-latest"
	ModerationModelTextModerationStable     ModerationModel = "text-moderation-stable"
)

func NewModerationMultiModalInputOfImageURL(imageURL ModerationImageURLInputImageURLParam) ModerationMultiModalInputUnionParam {
	var image_url ModerationImageURLInputParam
	image_url.ImageURL = imageURL
	return ModerationMultiModalInputUnionParam{OfImageURL: &image_url}
}

func NewModerationMultiModalInputOfText(text string) ModerationMultiModalInputUnionParam {
	var variant ModerationTextInputParam
	variant.Text = newString(text)
	return ModerationMultiModalInputUnionParam{OfText: &variant}
}

// Only one field can be non-zero
type ModerationMultiModalInputUnionParam struct {
	OfImageURL *ModerationImageURLInputParam
	OfText     *ModerationTextInputParam
	apiunion
}

func (u ModerationMultiModalInputUnionParam) IsMissing() bool {
	return param.IsOmitted(u) || u.IsNull()
}

func (u ModerationMultiModalInputUnionParam) MarshalJSON() ([]byte, error) {
	return param.MarshalUnion[ModerationMultiModalInputUnionParam](u.OfImageURL, u.OfText)
}

func (u ModerationMultiModalInputUnionParam) GetImageURL() *ModerationImageURLInputImageURLParam {
	if vt := u.OfImageURL; vt != nil {
		return &vt.ImageURL
	}
	return nil
}

func (u ModerationMultiModalInputUnionParam) GetText() *string {
	if vt := u.OfText; vt != nil && !vt.Text.IsOmitted() {
		return &vt.Text.V
	}
	return nil
}

func (u ModerationMultiModalInputUnionParam) GetType() *string {
	if vt := u.OfImageURL; vt != nil {
		return (*string)(&vt.Type)
	} else if vt := u.OfText; vt != nil {
		return (*string)(&vt.Type)
	}
	return nil
}

// An object describing text to classify.
type ModerationTextInputParam struct {
	// A string of text to classify.
	Text param.String `json:"text,omitzero,required"`
	// Always `text`.
	//
	// This field can be elided, and will be automatically set as "text".
	Type constant.Text `json:"type,required"`
	apiobject
}

func (f ModerationTextInputParam) IsMissing() bool { return param.IsOmitted(f) || f.IsNull() }

func (r ModerationTextInputParam) MarshalJSON() (data []byte, err error) {
	type shadow ModerationTextInputParam
	return param.MarshalObject(r, (*shadow)(&r))
}

// Represents if a given text input is potentially harmful.
type ModerationNewResponse struct {
	// The unique identifier for the moderation request.
	ID string `json:"id,omitzero,required"`
	// The model used to generate the moderation results.
	Model string `json:"model,omitzero,required"`
	// A list of moderation objects.
	Results []Moderation `json:"results,omitzero,required"`
	JSON    struct {
		ID      resp.Field
		Model   resp.Field
		Results resp.Field
		raw     string
	} `json:"-"`
}

func (r ModerationNewResponse) RawJSON() string { return r.JSON.raw }
func (r *ModerationNewResponse) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type ModerationNewParams struct {
	// Input (or inputs) to classify. Can be a single string, an array of strings, or
	// an array of multi-modal input objects similar to other models.
	Input ModerationNewParamsInputUnion `json:"input,omitzero,required"`
	// The content moderation model you would like to use. Learn more in
	// [the moderation guide](https://platform.openai.com/docs/guides/moderation), and
	// learn about available models
	// [here](https://platform.openai.com/docs/models#moderation).
	Model ModerationModel `json:"model,omitzero"`
	apiobject
}

func (f ModerationNewParams) IsMissing() bool { return param.IsOmitted(f) || f.IsNull() }

func (r ModerationNewParams) MarshalJSON() (data []byte, err error) {
	type shadow ModerationNewParams
	return param.MarshalObject(r, (*shadow)(&r))
}

// Only one field can be non-zero
type ModerationNewParamsInputUnion struct {
	OfString                    param.String
	OfModerationNewsInputArray  []string
	OfModerationMultiModalArray []ModerationMultiModalInputUnionParam
	apiunion
}

func (u ModerationNewParamsInputUnion) IsMissing() bool { return param.IsOmitted(u) || u.IsNull() }

func (u ModerationNewParamsInputUnion) MarshalJSON() ([]byte, error) {
	return param.MarshalUnion[ModerationNewParamsInputUnion](u.OfString, u.OfModerationNewsInputArray, u.OfModerationMultiModalArray)
}