moderation.go

package openai

import (
"context"
"errors"
"net/http"
)

// The moderation endpoint is a tool you can use to check whether content complies with OpenAI's usage policies.
// Developers can thus identify content that our usage policies prohibits and take action, for instance by filtering it.

// The default is text-moderation-latest which will be automatically upgraded over time.
// This ensures you are always using our most accurate model.
// If you use text-moderation-stable, we will provide advanced notice before updating the model.
// Accuracy of text-moderation-stable may be slightly lower than for text-moderation-latest.
const (
ModerationOmniLatest="omni-moderation-latest"
ModerationOmni20240926="omni-moderation-2024-09-26"
ModerationTextStable="text-moderation-stable"
ModerationTextLatest="text-moderation-latest"
// Deprecated: use ModerationTextStable and ModerationTextLatest instead.
ModerationText001="text-moderation-001"
)

var (
ErrModerationInvalidModel=errors.New("this model is not supported with moderation, please use text-moderation-stable or text-moderation-latest instead") //nolint:lll
)

varvalidModerationModel=map[string]struct{}{
ModerationOmniLatest: {},
ModerationOmni20240926: {},
ModerationTextStable: {},
ModerationTextLatest: {},
}

// ModerationRequest represents a request structure for moderation API.
typeModerationRequeststruct {
Inputstring`json:"input,omitempty"`
Modelstring`json:"model,omitempty"`
}

// Result represents one of possible moderation results.
typeResultstruct {
CategoriesResultCategories`json:"categories"`
CategoryScoresResultCategoryScores`json:"category_scores"`
Flaggedbool`json:"flagged"`
}

// ResultCategories represents Categories of Result.
typeResultCategoriesstruct {
Hatebool`json:"hate"`
HateThreateningbool`json:"hate/threatening"`
Harassmentbool`json:"harassment"`
HarassmentThreateningbool`json:"harassment/threatening"`
SelfHarmbool`json:"self-harm"`
SelfHarmIntentbool`json:"self-harm/intent"`
SelfHarmInstructionsbool`json:"self-harm/instructions"`
Sexualbool`json:"sexual"`
SexualMinorsbool`json:"sexual/minors"`
Violencebool`json:"violence"`
ViolenceGraphicbool`json:"violence/graphic"`
}

// ResultCategoryScores represents CategoryScores of Result.
typeResultCategoryScoresstruct {
Hatefloat32`json:"hate"`
HateThreateningfloat32`json:"hate/threatening"`
Harassmentfloat32`json:"harassment"`
HarassmentThreateningfloat32`json:"harassment/threatening"`
SelfHarmfloat32`json:"self-harm"`
SelfHarmIntentfloat32`json:"self-harm/intent"`
SelfHarmInstructionsfloat32`json:"self-harm/instructions"`
Sexualfloat32`json:"sexual"`
SexualMinorsfloat32`json:"sexual/minors"`
Violencefloat32`json:"violence"`
ViolenceGraphicfloat32`json:"violence/graphic"`
}

// ModerationResponse represents a response structure for moderation API.
typeModerationResponsestruct {
IDstring`json:"id"`
Modelstring`json:"model"`
Results []Result`json:"results"`

httpHeader
}

// Moderations — perform a moderation api call over a string.
// Input can be an array or slice but a string will reduce the complexity.
func (c*Client) Moderations(ctx context.Context, requestModerationRequest) (responseModerationResponse, errerror) {
if_, ok:=validModerationModel[request.Model]; len(request.Model) >0&&!ok {
err=ErrModerationInvalidModel
return
 }
req, err:=c.newRequest(
ctx,
http.MethodPost,
c.fullURL("/moderations", withModel(request.Model)),
withBody(&request),
 )
iferr!=nil {
return
 }

err=c.sendRequest(req, &response)
return
}