Package dev.langchain4j.model.chat.request

Enum Class ToolChoice

java.lang.Object

java.lang.Enum<ToolChoice>

dev.langchain4j.model.chat.request.ToolChoice

All Implemented Interfaces:

Serializable, Comparable<ToolChoice>, Constable

public enum ToolChoice
extends Enum<ToolChoice>

Specifies how ChatModel should use tools.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	The chat model can choose whether to use tools, which ones to use, and how many.
REQUIRED	The chat model is required to use one or more tools.

Method Summary

Modifier and Type	Method	Description
static ToolChoice	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ToolChoice[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final ToolChoice AUTO

The chat model can choose whether to use tools, which ones to use, and how many.

REQUIRED

public static final ToolChoice REQUIRED

The chat model is required to use one or more tools.

Method Details

values

public static ToolChoice[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ToolChoice valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null