Package io.github.stefanbratanov.jvm.openai

Record Class Moderation

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.Moderation

public record Moderation(String id, String model, List<Moderation.Result> results)
extends Record

Represents if a given text input is potentially harmful.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Moderation.Result

Constructor Summary

Constructors

Constructor	Description
Moderation(String id, String model, List<Moderation.Result> results)	Creates an instance of a Moderation record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
String	model()	Returns the value of the model record component.
List<Moderation.Result>	results()	Returns the value of the results record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Moderation

public Moderation(String id,
 String model,
 List<Moderation.Result> results)

Creates an instance of a Moderation record class.

Parameters:

id - the value for the id record component

model - the value for the model record component

results - the value for the results 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

model

public String model()

Returns the value of the model record component.

Returns:

the value of the model record component

results

public List<Moderation.Result> results()

Returns the value of the results record component.

Returns:

the value of the results record component