Class DecisionResponse

java.lang.Object

dev.langchain4j.model.decision.response.DecisionResponse

@Experimental
public final class DecisionResponse
extends Object

The response of a DecisionModel: one DecisionAnswer per question of the request, keyed by question name, together with the DecisionResponseMetadata (model name, token usage).

DecisionResponse response = decisionModel.decide(request);

ChoiceAnswer team = response.choice("team");
YesNoAnswer urgent = response.yesNo("urgent");

if (urgent.probability() > 0.8) {
    escalate(team.value());
}

A question that the model refused to answer has a RefusalAnswer: check isRefused(String) before reading its answer, since the typed accessors throw a ContentFilteredException for it.

Since:

1.21.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DecisionResponse.Builder

Method Summary

Modifier and Type	Method	Description
<A extends DecisionAnswer> A	answer(String name, Class<A> type)	Returns the answer with the given name, as the given answer type.
Map<String, DecisionAnswer>	answers()	The answers, keyed by the names of the questions they answer.
static DecisionResponse.Builder	builder()
ChoiceAnswer	choice(String name)	Returns the answer to the ChoiceQuestion with the given name.
boolean	equals(Object o)
int	hashCode()
boolean	isRefused(String name)	Whether the model refused to answer the question with the given name, for example because the input or the question goes against the usage policies of the provider (see RefusalAnswer).
DecisionResponseMetadata	metadata()
String	modelName()	The name of the model that produced the answers, or null if the model did not report it.
ScaleAnswer	scale(String name)	Returns the answer to the ScaleQuestion with the given name.
TokenUsage	tokenUsage()	The token usage of the call, or null if the model did not report it.
String	toString()
YesNoAnswer	yesNo(String name)	Returns the answer to the YesNoQuestion with the given name.

Methods inherited from class Object

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

Method Details

answers

public Map<String, DecisionAnswer> answers()

The answers, keyed by the names of the questions they answer. The answer to a question that the model refused to answer is a RefusalAnswer.

yesNo

public YesNoAnswer yesNo(String name)

Returns the answer to the YesNoQuestion with the given name.

Throws:

IllegalArgumentException - if there is no answer with this name, or it is not a YesNoAnswer.

ContentFilteredException - if the model refused to answer the question (see isRefused(String)).

choice

public ChoiceAnswer choice(String name)

Returns the answer to the ChoiceQuestion with the given name.

Throws:

IllegalArgumentException - if there is no answer with this name, or it is not a ChoiceAnswer.

ContentFilteredException - if the model refused to answer the question (see isRefused(String)).

scale

public ScaleAnswer scale(String name)

Returns the answer to the ScaleQuestion with the given name.

Throws:

IllegalArgumentException - if there is no answer with this name, or it is not a ScaleAnswer.

ContentFilteredException - if the model refused to answer the question (see isRefused(String)).

answer

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

Returns the answer with the given name, as the given answer type. Useful for answer types defined by integrations.

Throws:

IllegalArgumentException - if there is no answer with this name, or it is not of the given type.

ContentFilteredException - if the model refused to answer the question (see isRefused(String)) and the given type is neither RefusalAnswer nor DecisionAnswer.

isRefused

public boolean isRefused(String name)

Whether the model refused to answer the question with the given name, for example because the input or the question goes against the usage policies of the provider (see RefusalAnswer). When the decision is used as a safety check, treat a refused answer as a failed check rather than as a "no".

Throws:

IllegalArgumentException - if there is no answer with this name.

Since:

1.22.0

metadata

public DecisionResponseMetadata metadata()

modelName

public String modelName()

The name of the model that produced the answers, or null if the model did not report it.

tokenUsage

public TokenUsage tokenUsage()

The token usage of the call, or null if the model did not report it.

builder

public static DecisionResponse.Builder builder()

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