moderation

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

type AmazonComprehendPIIClient interface {
	// ContainsPiiEntities is an interface method that checks if the input text contains Personally Identifiable Information (PII) entities.
	ContainsPiiEntities(ctx context.Context, params *comprehend.ContainsPiiEntitiesInput, optFns ...func(*comprehend.Options)) (*comprehend.ContainsPiiEntitiesOutput, error)
	// DetectPiiEntities is an interface method that checks if the input text contains Personally Identifiable Information (PII) entities and returns information about them.
	DetectPiiEntities(ctx context.Context, params *comprehend.DetectPiiEntitiesInput, optFns ...func(*comprehend.Options)) (*comprehend.DetectPiiEntitiesOutput, error)
}

type AmazonComprehendPIIOptions struct {
	// CallbackOptions embeds CallbackOptions to include the verbosity setting and callbacks.
	*schema.CallbackOptions
	// InputKey is the key to extract the input text from the input ChainValues.
	InputKey string
	// OutputKey is the key to store the output of the moderation in the output ChainValues.
	OutputKey string
	// LanguageCode is the language code to specify the language of the input text.
	LanguageCode string
	// Labels is a list of labels to check for in the PII analysis.
	Labels []string
	// Threshold is the threshold for determining if PII content is found.
	Threshold float32
	// Redact enables redaction of detected PII entities.
	Redact bool
	// MaskMarker is the redaction mask character in case redaction
	MaskMarker rune
	// RedactFunc defines how to redact PII entities found in the text.
	RedactFunc RedactFunc
}

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

type AmazonComprehendPromptSafetyClient interface {
	// Options returns the options associated with the Amazon Comprehend Prompt Safety client.
	Options() comprehend.Options
	// ClassifyDocument analyzes the provided text and classifies it as safe or unsafe based on predefined categories.
	ClassifyDocument(ctx context.Context, params *comprehend.ClassifyDocumentInput, optFns ...func(*comprehend.Options)) (*comprehend.ClassifyDocumentOutput, error)
}

type AmazonComprehendPromptSafetyOptions struct {
	// CallbackOptions embeds CallbackOptions to include the verbosity setting and callbacks.
	*schema.CallbackOptions
	// InputKey is the key to extract the input text from the input ChainValues.
	InputKey string
	// OutputKey is the key to store the output of the moderation in the output ChainValues.
	OutputKey string
	// Threshold is the confidence threshold for determining if an input is considered unsafe.
	Threshold float32
	// Endpoint is the URL endpoint for the external service that performs unsafe content detection.
	Endpoint string
}

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

type AmazonComprehendToxicityClient interface {
	// DetectToxicContent is an interface function that analyzes a given text for toxic content.
	DetectToxicContent(ctx context.Context, params *comprehend.DetectToxicContentInput, optFns ...func(*comprehend.Options)) (*comprehend.DetectToxicContentOutput, error)
}

type AmazonComprehendToxicityOptions struct {
	// CallbackOptions embeds CallbackOptions to include the verbosity setting and callbacks.
	*schema.CallbackOptions
	// InputKey is the key to extract the input text from the input ChainValues.
	InputKey string
	// OutputKey is the key to store the output of the moderation in the output ChainValues.
	OutputKey string
	// LanguageCode is the language code used for toxicity detection (default is "en").
	LanguageCode string
	// Labels is a list of specific toxicity labels to check for.
	Labels []string
	// Threshold is the threshold score for considering content as toxic (default is 0.8).
	Threshold float32
}

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

type OpenAIClient interface {
	// Moderations sends a moderation request to the OpenAI API and receives the response.
	// It takes the context and a ModerationRequest as input and returns a ModerationResponse or an error.
	Moderations(ctx context.Context, request openai.ModerationRequest) (response openai.ModerationResponse, err error)
}

type OpenAIOptions struct {
	// CallbackOptions embeds CallbackOptions to include the verbosity setting and callbacks.
	*schema.CallbackOptions
	// ModelName is the name of the OpenAI model to use for moderation.
	ModelName string
	// InputKey is the key to extract the input text from the input ChainValues.
	InputKey string
	// OutputKey is the key to store the output of the moderation in the output ChainValues.
	OutputKey string
}

type RedactFunc func(ctx context.Context, text string, maskMarker rune, entityType string, offsetBegin, offsetEnd int32) string