Class ChoiceQuestion

java.lang.Object

dev.langchain4j.model.decision.request.ChoiceQuestion

All Implemented Interfaces:

Question

@Experimental
public final class ChoiceQuestion
extends Object
implements Question

A question that selects exactly one option out of a named set, answered with the chosen option and the probability of each option (see ChoiceAnswer).

Each option has a name and a description of when it applies. For options whose name says it all, such as sentiments, the name is used as the description (ChoiceQuestion.from("What is the sentiment?", List.of("positive", "negative", "neutral"))):

ChoiceQuestion team = ChoiceQuestion.builder()
        .text("Which team should handle this ticket?")
        .option("billing", "Payments, invoices, refunds")
        .option("support", "Problems using the product. Not for questions about invoices")
        .build();

Since:

1.21.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ChoiceQuestion.Builder

Method Summary

Modifier and Type	Method	Description
static ChoiceQuestion.Builder	builder()
boolean	equals(Object o)
static ChoiceQuestion	from(String text, List<String> options)	Creates a choice question with the given text and options whose names say it all: each name is also used as the description.
static ChoiceQuestion	from(String text, Map<String,String> options)	Creates a choice question with the given text and the descriptions of the options, keyed by option name.
int	hashCode()
static ChoiceQuestion	of(String text, List<String> options)	Deprecated, for removal: This API element is subject to removal in a future version. use from(String, List) instead
static ChoiceQuestion	of(String text, Map<String,String> options)	Deprecated, for removal: This API element is subject to removal in a future version. use from(String, Map) instead
Map<String,String>	options()	The descriptions of the options, keyed by option name, in the order they were added.
String	text()	What the model should evaluate, for example "Which team should handle this ticket?".
String	toString()

Methods inherited from class Object

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

Method Details

text

public String text()

Description copied from interface: Question

What the model should evaluate, for example "Which team should handle this ticket?".

Specified by:

text in interface Question

options

public Map<String,String> options()

The descriptions of the options, keyed by option name, in the order they were added. For an option added without a description, the description is its name.

from

public static ChoiceQuestion from(String text,
 Map<String,String> options)

Creates a choice question with the given text and the descriptions of the options, keyed by option name.

Since:

1.23.0

from

public static ChoiceQuestion from(String text,
 List<String> options)

Creates a choice question with the given text and options whose names say it all: each name is also used as the description.

Since:

1.23.0

of

@Deprecated(since="1.23.0",
            forRemoval=true)
public static ChoiceQuestion of(String text,
 Map<String,String> options)

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

use from(String, Map) instead

Creates a choice question with the given text and the descriptions of the options, keyed by option name.

of

@Deprecated(since="1.23.0",
            forRemoval=true)
public static ChoiceQuestion of(String text,
 List<String> options)

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

use from(String, List) instead

Creates a choice question with the given text and options whose names say it all: each name is also used as the description.

builder

public static ChoiceQuestion.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