Package org.springframework.ai.decision

Class DecisionResponse

java.lang.Object

org.springframework.ai.decision.DecisionResponse

All Implemented Interfaces:

ModelResponse<DecisionResult>

public final class DecisionResponse
extends Object
implements ModelResponse<DecisionResult>

The response of a DecisionModel: one DecisionResult per question, in the order the questions were asked, and the response metadata.

A response is built with builder(DecisionPrompt), which orders the answers by the prompt's questions and checks that each one answers its question, so a response always matches the prompt it answers.

Since:

2.1.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DecisionResponse.Builder	Builds a DecisionResponse that answers a DecisionPrompt.

Method Summary

Modifier and Type	Method	Description
static DecisionResponse.Builder	builder(DecisionPrompt prompt)	A builder for the response to the given prompt.
boolean	equals(@Nullable Object o)
DecisionAnswer	getAnswer(String name)	The answer to the given question.
<A extends DecisionAnswer> A	getAnswer(String name, Class<A> type)	The answer to the given question, as the given type.
Map<String,DecisionAnswer>	getAnswers()	The answers, keyed by question name, in the order the questions were asked.
ChoiceAnswer	getChoice(String name)
DecisionResponseMetadata	getMetadata()	Retrieves the response metadata associated with the AI model's response.
@Nullable DecisionResult	getResult()	The first result, or null when there are none.
List<DecisionResult>	getResults()	Retrieves the list of generated outputs by the AI model.
ScoreAnswer	getScore(String name)
YesNoAnswer	getYesNo(String name)
boolean	hasAnswer(String name)	Whether the question was answered, including by a refusal.
int	hashCode()
boolean	isRefused(String name)	Whether the provider refused to answer the given question.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static DecisionResponse.Builder builder(DecisionPrompt prompt)

A builder for the response to the given prompt. DecisionResponse.Builder.build() orders the answers by the prompt's questions and checks that each question is answered by an answer of the matching type.

getResults

public List<DecisionResult> getResults()

Description copied from interface: ModelResponse

Retrieves the list of generated outputs by the AI model.

Specified by:

getResults in interface ModelResponse<DecisionResult>

Returns:

the list of generated outputs

getResult

public @Nullable DecisionResult getResult()

The first result, or null when there are none.

Specified by:

getResult in interface ModelResponse<DecisionResult>

Returns:

the result generated by the AI model

getMetadata

public DecisionResponseMetadata getMetadata()

Description copied from interface: ModelResponse

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

Specified by:

getMetadata in interface ModelResponse<DecisionResult>

Returns:

the response metadata

getAnswers

public Map<String,DecisionAnswer> getAnswers()

The answers, keyed by question name, in the order the questions were asked.

hasAnswer

public boolean hasAnswer(String name)

Whether the question was answered, including by a refusal.

getAnswer

public DecisionAnswer getAnswer(String name)

The answer to the given question.

getAnswer

public <A extends DecisionAnswer> A getAnswer(String name,
 Class<A> type)

The answer to the given question, as the given type. Fails with an IllegalStateException when the provider refused to answer.

getYesNo

public YesNoAnswer getYesNo(String name)

getChoice

public ChoiceAnswer getChoice(String name)

getScore

public ScoreAnswer getScore(String name)

isRefused

public boolean isRefused(String name)

Whether the provider refused to answer the given question.

equals

public boolean equals(@Nullable 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