Package org.springframework.ai.chat.model

Class ChatResponse

java.lang.Object

org.springframework.ai.chat.model.ChatResponse

All Implemented Interfaces:

ModelResponse<Generation>

public class ChatResponse
extends Object
implements ModelResponse<Generation>

The chat completion (e.g. generation) response returned by an AI provider.

Author:

Christian Tzolov, Mark Pollack, Soby Chacko, John Blum, Alexandros Pappas, Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ChatResponse.Builder

Constructor Summary

Constructors

Constructor	Description
ChatResponse(List<Generation> generations)	Construct a new ChatResponse instance without metadata.
ChatResponse(List<Generation> generations, ChatResponseMetadata chatResponseMetadata)	Construct a new ChatResponse instance.

Method Summary

Modifier and Type	Method	Description
static ChatResponse.Builder	builder()
boolean	equals(Object o)
ChatResponseMetadata	getMetadata()	Retrieves the response metadata associated with the AI model's response.
Generation	getResult()	Retrieves the result of the AI model.
List<Generation>	getResults()	The List of generated outputs.
boolean	hasFinishReasons(Set<String> finishReasons)	Whether the model has finished with any of the given finish reasons.
int	hashCode()
boolean	hasToolCalls()	Whether the model has requested the execution of a tool.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ChatResponse

public ChatResponse(List<Generation> generations)

Construct a new ChatResponse instance without metadata.

Parameters:

generations - the List of Generation returned by the AI provider.

ChatResponse

public ChatResponse(List<Generation> generations,
 ChatResponseMetadata chatResponseMetadata)

Construct a new ChatResponse instance.

Parameters:

generations - the List of Generation returned by the AI provider.

chatResponseMetadata - ChatResponseMetadata containing information about the use of the AI provider's API.

Method Details

builder

public static ChatResponse.Builder builder()

getResults

public List<Generation> getResults()

The List of generated outputs.

It is a List of lists because the Prompt could request multiple output generations.

Specified by:

getResults in interface ModelResponse<Generation>

Returns:

the List of generated outputs.

getResult

public Generation getResult()

Description copied from interface: ModelResponse

Retrieves the result of the AI model.

Specified by:

getResult in interface ModelResponse<Generation>

Returns:

Returns the first Generation in the generations list.

getMetadata

public ChatResponseMetadata 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:

Returns ChatResponseMetadata containing information about the use of the AI provider's API.

hasToolCalls

public boolean hasToolCalls()

Whether the model has requested the execution of a tool.

hasFinishReasons

public boolean hasFinishReasons(Set<String> finishReasons)

Whether the model has finished with any of the given finish reasons.

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