Package org.springframework.ai.chat.model

Class Generation

java.lang.Object

org.springframework.ai.chat.model.Generation

All Implemented Interfaces:

ModelResult<AssistantMessage>

public class Generation
extends Object
implements ModelResult<AssistantMessage>

Represents a response returned by the AI.

Constructor Summary

Constructors

Constructor	Description
Generation(String text)	Deprecated. Use Generation(AssitantMessage) constructor instead.
Generation(String text, Map<String,Object> properties)	Deprecated. Use Generation(AssitantMessage) constructor instead.
Generation(AssistantMessage assistantMessage)
Generation(AssistantMessage assistantMessage, ChatGenerationMetadata chatGenerationMetadata)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ChatGenerationMetadata	getMetadata()	Retrieves the metadata associated with the result of an AI model.
AssistantMessage	getOutput()	Retrieves the output generated by the AI model.
int	hashCode()
String	toString()
Generation	withGenerationMetadata(ChatGenerationMetadata chatGenerationMetadata)	Deprecated. Use Generation(AssitantMessage, ChatGenerationMetadata) constructor instead.

Methods inherited from class java.lang.Object

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

Constructor Details

Generation

@Deprecated
public Generation(String text)

Deprecated.

Use Generation(AssitantMessage) constructor instead.

Generation

@Deprecated
public Generation(String text,
 Map<String,Object> properties)

Deprecated.

Use Generation(AssitantMessage) constructor instead.

Generation

public Generation(AssistantMessage assistantMessage)

Generation

public Generation(AssistantMessage assistantMessage,
 ChatGenerationMetadata chatGenerationMetadata)

Method Details

getOutput

public AssistantMessage getOutput()

Description copied from interface: ModelResult

Retrieves the output generated by the AI model.

Specified by:

getOutput in interface ModelResult<AssistantMessage>

Returns:

the output generated by the AI model

getMetadata

public ChatGenerationMetadata getMetadata()

Description copied from interface: ModelResult

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

Specified by:

getMetadata in interface ModelResult<AssistantMessage>

Returns:

the metadata associated with the result

withGenerationMetadata

@Deprecated
public Generation withGenerationMetadata(@Nullable
 ChatGenerationMetadata chatGenerationMetadata)

Deprecated.

Use Generation(AssitantMessage, ChatGenerationMetadata) constructor instead.

Parameters:

chatGenerationMetadata -

Returns:

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object