com.theokanning.openai.moderation

Class Moderation

java.lang.Object

com.theokanning.openai.moderation.Moderation

public class Moderation
extends java.lang.Object

An object containing the moderation data for a single input string https://beta.openai.com/docs/api-reference/moderations/create

Field Summary

Fields

Modifier and Type	Field and Description
ModerationCategories	categories Object containing per-category binary content policy violation flags.
ModerationCategoryScores	categoryScores Object containing per-category raw scores output by the model, denoting the model's confidence that the input violates the OpenAI's policy for the category.
boolean	flagged Set to true if the model classifies the content as violating OpenAI's content policy, false otherwise

Constructor Summary

Constructors

Constructor and Description
Moderation()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

flagged

public boolean flagged

Set to true if the model classifies the content as violating OpenAI's content policy, false otherwise

categories

public ModerationCategories categories

Object containing per-category binary content policy violation flags. For each category, the value is true if the model flags the corresponding category as violated, false otherwise.

categoryScores

public ModerationCategoryScores categoryScores

Object containing per-category raw scores output by the model, denoting the model's confidence that the input violates the OpenAI's policy for the category. The value is between 0 and 1, where higher values denote higher confidence. The scores should not be interpreted as probabilities.

Constructor Detail

Moderation

public Moderation()