com.launchableinc.openai.moderation.Moderation Maven / Gradle / Ivy
Show all versions of api Show documentation
package com.launchableinc.openai.moderation;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
/**
* An object containing the moderation data for a single input string
*
* https://beta.openai.com/docs/api-reference/moderations/create
*/
@Data
public class Moderation {
/**
* Set to true if the model classifies the content as violating OpenAI's content policy, false
* otherwise
*/
public boolean flagged;
/**
* 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.
*/
public ModerationCategories categories;
/**
* 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.
*/
@JsonProperty("category_scores")
public ModerationCategoryScores categoryScores;
}