moderation.go

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

package openai

import (
"context"
"net/http"
"reflect"

"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"
"github.com/tidwall/gjson"
)

// 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.
typeModerationServicestruct {
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.
funcNewModerationService(opts...option.RequestOption) (rModerationService) {
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, bodyModerationNewParams, opts...option.RequestOption) (res*ModerationNewResponse, errerror) {
opts=append(r.Options[:], opts...)
path:="moderations"
err=requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return
}

typeModerationstruct {
// A list of the categories, and whether they are flagged or not.
CategoriesModerationCategories`json:"categories,required"`
// A list of the categories along with the input type(s) that the score applies to.
CategoryAppliedInputTypesModerationCategoryAppliedInputTypes`json:"category_applied_input_types,required"`
// A list of the categories along with their scores as predicted by model.
CategoryScoresModerationCategoryScores`json:"category_scores,required"`
// Whether any of the below categories are flagged.
Flaggedbool`json:"flagged,required"`
// Metadata for the response, check the presence of optional fields with the
// [resp.Field.IsPresent] method.
JSONstruct {
Categories resp.Field
CategoryAppliedInputTypes resp.Field
CategoryScores resp.Field
Flagged resp.Field
ExtraFieldsmap[string]resp.Field
rawstring
 } `json:"-"`
}

// Returns the unmodified JSON received from the API
func (rModeration) RawJSON() string { returnr.JSON.raw }
func (r*Moderation) UnmarshalJSON(data []byte) error {
returnapijson.UnmarshalRoot(data, r)
}

// A list of the categories, and whether they are flagged or not.
typeModerationCategoriesstruct {
// Content that expresses, incites, or promotes harassing language towards any
// target.
Harassmentbool`json:"harassment,required"`
// Harassment content that also includes violence or serious harm towards any
// target.
HarassmentThreateningbool`json:"harassment/threatening,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.
Hatebool`json:"hate,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.
HateThreateningbool`json:"hate/threatening,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.
Illicitbool`json:"illicit,required"`
// 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.
IllicitViolentbool`json:"illicit/violent,required"`
// Content that promotes, encourages, or depicts acts of self-harm, such as
// suicide, cutting, and eating disorders.
SelfHarmbool`json:"self-harm,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.
SelfHarmInstructionsbool`json:"self-harm/instructions,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.
SelfHarmIntentbool`json:"self-harm/intent,required"`
// Content meant to arouse sexual excitement, such as the description of sexual
// activity, or that promotes sexual services (excluding sex education and
// wellness).
Sexualbool`json:"sexual,required"`
// Sexual content that includes an individual who is under 18 years old.
SexualMinorsbool`json:"sexual/minors,required"`
// Content that depicts death, violence, or physical injury.
Violencebool`json:"violence,required"`
// Content that depicts death, violence, or physical injury in graphic detail.
ViolenceGraphicbool`json:"violence/graphic,required"`
// Metadata for the response, check the presence of optional fields with the
// [resp.Field.IsPresent] method.
JSONstruct {
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
ExtraFieldsmap[string]resp.Field
rawstring
 } `json:"-"`
}

// Returns the unmodified JSON received from the API
func (rModerationCategories) RawJSON() string { returnr.JSON.raw }
func (r*ModerationCategories) UnmarshalJSON(data []byte) error {
returnapijson.UnmarshalRoot(data, r)
}

// A list of the categories along with the input type(s) that the score applies to.
typeModerationCategoryAppliedInputTypesstruct {
// The applied input type(s) for the category 'harassment'.
//
// Any of "text".
Harassment []string`json:"harassment,required"`
// The applied input type(s) for the category 'harassment/threatening'.
//
// Any of "text".
HarassmentThreatening []string`json:"harassment/threatening,required"`
// The applied input type(s) for the category 'hate'.
//
// Any of "text".
Hate []string`json:"hate,required"`
// The applied input type(s) for the category 'hate/threatening'.
//
// Any of "text".
HateThreatening []string`json:"hate/threatening,required"`
// The applied input type(s) for the category 'illicit'.
//
// Any of "text".
Illicit []string`json:"illicit,required"`
// The applied input type(s) for the category 'illicit/violent'.
//
// Any of "text".
IllicitViolent []string`json:"illicit/violent,required"`
// The applied input type(s) for the category 'self-harm'.
//
// Any of "text", "image".
SelfHarm []string`json:"self-harm,required"`
// The applied input type(s) for the category 'self-harm/instructions'.
//
// Any of "text", "image".
SelfHarmInstructions []string`json:"self-harm/instructions,required"`
// The applied input type(s) for the category 'self-harm/intent'.
//
// Any of "text", "image".
SelfHarmIntent []string`json:"self-harm/intent,required"`
// The applied input type(s) for the category 'sexual'.
//
// Any of "text", "image".
Sexual []string`json:"sexual,required"`
// The applied input type(s) for the category 'sexual/minors'.
//
// Any of "text".
SexualMinors []string`json:"sexual/minors,required"`
// The applied input type(s) for the category 'violence'.
//
// Any of "text", "image".
Violence []string`json:"violence,required"`
// The applied input type(s) for the category 'violence/graphic'.
//
// Any of "text", "image".
ViolenceGraphic []string`json:"violence/graphic,required"`
// Metadata for the response, check the presence of optional fields with the
// [resp.Field.IsPresent] method.
JSONstruct {
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
ExtraFieldsmap[string]resp.Field
rawstring
 } `json:"-"`
}

// Returns the unmodified JSON received from the API
func (rModerationCategoryAppliedInputTypes) RawJSON() string { returnr.JSON.raw }
func (r*ModerationCategoryAppliedInputTypes) UnmarshalJSON(data []byte) error {
returnapijson.UnmarshalRoot(data, r)
}

// A list of the categories along with their scores as predicted by model.
typeModerationCategoryScoresstruct {
// The score for the category 'harassment'.
Harassmentfloat64`json:"harassment,required"`
// The score for the category 'harassment/threatening'.
HarassmentThreateningfloat64`json:"harassment/threatening,required"`
// The score for the category 'hate'.
Hatefloat64`json:"hate,required"`
// The score for the category 'hate/threatening'.
HateThreateningfloat64`json:"hate/threatening,required"`
// The score for the category 'illicit'.
Illicitfloat64`json:"illicit,required"`
// The score for the category 'illicit/violent'.
IllicitViolentfloat64`json:"illicit/violent,required"`
// The score for the category 'self-harm'.
SelfHarmfloat64`json:"self-harm,required"`
// The score for the category 'self-harm/instructions'.
SelfHarmInstructionsfloat64`json:"self-harm/instructions,required"`
// The score for the category 'self-harm/intent'.
SelfHarmIntentfloat64`json:"self-harm/intent,required"`
// The score for the category 'sexual'.
Sexualfloat64`json:"sexual,required"`
// The score for the category 'sexual/minors'.
SexualMinorsfloat64`json:"sexual/minors,required"`
// The score for the category 'violence'.
Violencefloat64`json:"violence,required"`
// The score for the category 'violence/graphic'.
ViolenceGraphicfloat64`json:"violence/graphic,required"`
// Metadata for the response, check the presence of optional fields with the
// [resp.Field.IsPresent] method.
JSONstruct {
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
ExtraFieldsmap[string]resp.Field
rawstring
 } `json:"-"`
}

// Returns the unmodified JSON received from the API
func (rModerationCategoryScores) RawJSON() string { returnr.JSON.raw }
func (r*ModerationCategoryScores) UnmarshalJSON(data []byte) error {
returnapijson.UnmarshalRoot(data, r)
}

// An object describing an image to classify.
//
// The properties ImageURL, Type are required.
typeModerationImageURLInputParamstruct {
// Contains either an image URL or a data URL for a base64 encoded image.
ImageURLModerationImageURLInputImageURLParam`json:"image_url,omitzero,required"`
// Always `image_url`.
//
// This field can be elided, and will marshal its zero value as "image_url".
Type constant.ImageURL`json:"type,required"`
paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (fModerationImageURLInputParam) IsPresent() bool { return!param.IsOmitted(f) &&!f.IsNull() }
func (rModerationImageURLInputParam) MarshalJSON() (data []byte, errerror) {
typeshadowModerationImageURLInputParam
returnparam.MarshalObject(r, (*shadow)(&r))
}

// Contains either an image URL or a data URL for a base64 encoded image.
//
// The property URL is required.
typeModerationImageURLInputImageURLParamstruct {
// Either a URL of the image or the base64 encoded image data.
URLstring`json:"url,required" format:"uri"`
paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (fModerationImageURLInputImageURLParam) IsPresent() bool {
return!param.IsOmitted(f) &&!f.IsNull()
}
func (rModerationImageURLInputImageURLParam) MarshalJSON() (data []byte, errerror) {
typeshadowModerationImageURLInputImageURLParam
returnparam.MarshalObject(r, (*shadow)(&r))
}

typeModerationModel=string

const (
ModerationModelOmniModerationLatestModerationModel="omni-moderation-latest"
ModerationModelOmniModeration2024_09_26ModerationModel="omni-moderation-2024-09-26"
ModerationModelTextModerationLatestModerationModel="text-moderation-latest"
ModerationModelTextModerationStableModerationModel="text-moderation-stable"
)

funcModerationMultiModalInputParamOfImageURL(imageURLModerationImageURLInputImageURLParam) ModerationMultiModalInputUnionParam {
varvariantModerationImageURLInputParam
variant.ImageURL=imageURL
returnModerationMultiModalInputUnionParam{OfImageURL: &variant}
}

funcModerationMultiModalInputParamOfText(textstring) ModerationMultiModalInputUnionParam {
varvariantModerationTextInputParam
variant.Text=text
returnModerationMultiModalInputUnionParam{OfText: &variant}
}

// Only one field can be non-zero.
//
// Use [param.IsOmitted] to confirm if a field is set.
typeModerationMultiModalInputUnionParamstruct {
OfImageURL*ModerationImageURLInputParam`json:",omitzero,inline"`
OfText*ModerationTextInputParam`json:",omitzero,inline"`
paramUnion
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (uModerationMultiModalInputUnionParam) IsPresent() bool {
return!param.IsOmitted(u) &&!u.IsNull()
}
func (uModerationMultiModalInputUnionParam) MarshalJSON() ([]byte, error) {
returnparam.MarshalUnion[ModerationMultiModalInputUnionParam](u.OfImageURL, u.OfText)
}

func (u*ModerationMultiModalInputUnionParam) asAny() any {
if!param.IsOmitted(u.OfImageURL) {
returnu.OfImageURL
 } elseif!param.IsOmitted(u.OfText) {
returnu.OfText
 }
returnnil
}

// Returns a pointer to the underlying variant's property, if present.
func (uModerationMultiModalInputUnionParam) GetImageURL() *ModerationImageURLInputImageURLParam {
ifvt:=u.OfImageURL; vt!=nil {
return&vt.ImageURL
 }
returnnil
}

// Returns a pointer to the underlying variant's property, if present.
func (uModerationMultiModalInputUnionParam) GetText() *string {
ifvt:=u.OfText; vt!=nil {
return&vt.Text
 }
returnnil
}

// Returns a pointer to the underlying variant's property, if present.
func (uModerationMultiModalInputUnionParam) GetType() *string {
ifvt:=u.OfImageURL; vt!=nil {
return (*string)(&vt.Type)
 } elseifvt:=u.OfText; vt!=nil {
return (*string)(&vt.Type)
 }
returnnil
}

funcinit() {
apijson.RegisterUnion[ModerationMultiModalInputUnionParam](
"type",
 apijson.UnionVariant{
TypeFilter: gjson.JSON,
Type: reflect.TypeOf(ModerationImageURLInputParam{}),
DiscriminatorValue: "image_url",
 },
 apijson.UnionVariant{
TypeFilter: gjson.JSON,
Type: reflect.TypeOf(ModerationTextInputParam{}),
DiscriminatorValue: "text",
 },
 )
}

// An object describing text to classify.
//
// The properties Text, Type are required.
typeModerationTextInputParamstruct {
// A string of text to classify.
Textstring`json:"text,required"`
// Always `text`.
//
// This field can be elided, and will marshal its zero value as "text".
Type constant.Text`json:"type,required"`
paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (fModerationTextInputParam) IsPresent() bool { return!param.IsOmitted(f) &&!f.IsNull() }
func (rModerationTextInputParam) MarshalJSON() (data []byte, errerror) {
typeshadowModerationTextInputParam
returnparam.MarshalObject(r, (*shadow)(&r))
}

// Represents if a given text input is potentially harmful.
typeModerationNewResponsestruct {
// The unique identifier for the moderation request.
IDstring`json:"id,required"`
// The model used to generate the moderation results.
Modelstring`json:"model,required"`
// A list of moderation objects.
Results []Moderation`json:"results,required"`
// Metadata for the response, check the presence of optional fields with the
// [resp.Field.IsPresent] method.
JSONstruct {
ID resp.Field
Model resp.Field
Results resp.Field
ExtraFieldsmap[string]resp.Field
rawstring
 } `json:"-"`
}

// Returns the unmodified JSON received from the API
func (rModerationNewResponse) RawJSON() string { returnr.JSON.raw }
func (r*ModerationNewResponse) UnmarshalJSON(data []byte) error {
returnapijson.UnmarshalRoot(data, r)
}

typeModerationNewParamsstruct {
// 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.
InputModerationNewParamsInputUnion`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).
ModelModerationModel`json:"model,omitzero"`
paramObj
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (fModerationNewParams) IsPresent() bool { return!param.IsOmitted(f) &&!f.IsNull() }

func (rModerationNewParams) MarshalJSON() (data []byte, errerror) {
typeshadowModerationNewParams
returnparam.MarshalObject(r, (*shadow)(&r))
}

// Only one field can be non-zero.
//
// Use [param.IsOmitted] to confirm if a field is set.
typeModerationNewParamsInputUnionstruct {
OfString param.Opt[string] `json:",omitzero,inline"`
OfModerationNewsInputArray []string`json:",omitzero,inline"`
OfModerationMultiModalArray []ModerationMultiModalInputUnionParam`json:",omitzero,inline"`
paramUnion
}

// IsPresent returns true if the field's value is not omitted and not the JSON
// "null". To check if this field is omitted, use [param.IsOmitted].
func (uModerationNewParamsInputUnion) IsPresent() bool { return!param.IsOmitted(u) &&!u.IsNull() }
func (uModerationNewParamsInputUnion) MarshalJSON() ([]byte, error) {
returnparam.MarshalUnion[ModerationNewParamsInputUnion](u.OfString, u.OfModerationNewsInputArray, u.OfModerationMultiModalArray)
}

func (u*ModerationNewParamsInputUnion) asAny() any {
if!param.IsOmitted(u.OfString) {
return&u.OfString.Value
 } elseif!param.IsOmitted(u.OfModerationNewsInputArray) {
return&u.OfModerationNewsInputArray
 } elseif!param.IsOmitted(u.OfModerationMultiModalArray) {
return&u.OfModerationMultiModalArray
 }
returnnil
}