Record Class OpenAiModerationApi.OpenAiModerationResult

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiModerationApi.OpenAiModerationResult

Enclosing class:

OpenAiModerationApi

public static record OpenAiModerationApi.OpenAiModerationResult(boolean flagged, OpenAiModerationApi.Categories categories, OpenAiModerationApi.CategoryScores categoryScores)
extends Record

Author:

Ahmed Yousri, Ilayaperumal Gopinathan, Filip Hrisafov

Constructor Summary

Constructors

Constructor	Description
OpenAiModerationResult(boolean flagged, OpenAiModerationApi.Categories categories, OpenAiModerationApi.CategoryScores categoryScores)	Creates an instance of a OpenAiModerationResult record class.

Method Summary

Modifier and Type	Method	Description
OpenAiModerationApi.Categories	categories()	Returns the value of the categories record component.
OpenAiModerationApi.CategoryScores	categoryScores()	Returns the value of the categoryScores record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	flagged()	Returns the value of the flagged record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OpenAiModerationResult

public OpenAiModerationResult(boolean flagged,
 OpenAiModerationApi.Categories categories,
 OpenAiModerationApi.CategoryScores categoryScores)

Creates an instance of a OpenAiModerationResult record class.

Parameters:

flagged - the value for the flagged record component

categories - the value for the categories record component

categoryScores - the value for the categoryScores record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

flagged

public boolean flagged()

Returns the value of the flagged record component.

Returns:

the value of the flagged record component

categories

public OpenAiModerationApi.Categories categories()

Returns the value of the categories record component.

Returns:

the value of the categories record component

categoryScores

public OpenAiModerationApi.CategoryScores categoryScores()

Returns the value of the categoryScores record component.

Returns:

the value of the categoryScores record component