Package org.springframework.ai.moderation

Class Generation

java.lang.Object

org.springframework.ai.moderation.Generation

All Implemented Interfaces:

ModelResult<Moderation>

public class Generation
extends Object
implements ModelResult<Moderation>

The Generation class represents a response from a moderation process. It encapsulates the moderation generation metadata and the moderation object.

Since:

1.0.0

Author:

Ahmed Yousri

Constructor Summary

Constructors

Constructor	Description
Generation()
Generation(Moderation moderation)
Generation(Moderation moderation, ModerationGenerationMetadata moderationGenerationMetadata)

Method Summary

Modifier and Type	Method	Description
Generation	generationMetadata(ModerationGenerationMetadata moderationGenerationMetadata)
ModerationGenerationMetadata	getMetadata()	Retrieves the metadata associated with the result of an AI model.
Moderation	getOutput()	Retrieves the output generated by the AI model.
String	toString()
Generation	withGenerationMetadata(ModerationGenerationMetadata moderationGenerationMetadata)	Deprecated, for removal: This API element is subject to removal in a future version. use generationMetadata(ModerationGenerationMetadata) instead.

Methods inherited from class java.lang.Object

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

Constructor Details

Generation

public Generation()

Generation

public Generation(Moderation moderation)

Generation

public Generation(Moderation moderation,
 ModerationGenerationMetadata moderationGenerationMetadata)

Method Details

generationMetadata

public Generation generationMetadata(@Nullable
 ModerationGenerationMetadata moderationGenerationMetadata)

withGenerationMetadata

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public Generation withGenerationMetadata(@Nullable
 ModerationGenerationMetadata moderationGenerationMetadata)

Deprecated, for removal: This API element is subject to removal in a future version.

use generationMetadata(ModerationGenerationMetadata) instead.

getOutput

public Moderation getOutput()

Description copied from interface: ModelResult

Retrieves the output generated by the AI model.

Specified by:

getOutput in interface ModelResult<Moderation>

Returns:

the output generated by the AI model

getMetadata

public ModerationGenerationMetadata getMetadata()

Description copied from interface: ModelResult

Retrieves the metadata associated with the result of an AI model.

Specified by:

getMetadata in interface ModelResult<Moderation>

Returns:

the metadata associated with the result

toString

public String toString()

Overrides:

toString in class Object