Package org.springframework.ai.moderation

Class ModerationResponse

java.lang.Object

org.springframework.ai.moderation.ModerationResponse

All Implemented Interfaces:

ModelResponse<Generation>

public class ModerationResponse
extends Object
implements ModelResponse<Generation>

Represents a response from a moderation process, encapsulating the moderation metadata and the generated content. This class provides access to both the single generation result and a list containing that result, alongside the metadata associated with the moderation response. Designed for flexibility, it allows retrieval of moderation-specific metadata as well as the moderated content.

Since:

1.0.0

Author:

Ahmed Yousri

Constructor Summary

Constructors

Constructor	Description
ModerationResponse(Generation generations)
ModerationResponse(Generation generations, ModerationResponseMetadata moderationResponseMetadata)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ModerationResponseMetadata	getMetadata()	Retrieves the response metadata associated with the AI model's response.
Generation	getResult()	Retrieves the result of the AI model.
List<Generation>	getResults()	Retrieves the list of generated outputs by the AI model.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ModerationResponse

public ModerationResponse(Generation generations)

ModerationResponse

public ModerationResponse(Generation generations,
 ModerationResponseMetadata moderationResponseMetadata)

Method Details

getResult

public Generation getResult()

Description copied from interface: ModelResponse

Retrieves the result of the AI model.

Specified by:

getResult in interface ModelResponse<Generation>

Returns:

the result generated by the AI model

getResults

public List<Generation> getResults()

Description copied from interface: ModelResponse

Retrieves the list of generated outputs by the AI model.

Specified by:

getResults in interface ModelResponse<Generation>

Returns:

the list of generated outputs

getMetadata

public ModerationResponseMetadata getMetadata()

Description copied from interface: ModelResponse

Retrieves the response metadata associated with the AI model's response.

Specified by:

getMetadata in interface ModelResponse<Generation>

Returns:

the response metadata

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object