Package dev.langchain4j.agent.tool

Enum Class ReturnBehavior

java.lang.Object

java.lang.Enum<ReturnBehavior>

dev.langchain4j.agent.tool.ReturnBehavior

All Implemented Interfaces:

Serializable, Comparable<ReturnBehavior>, Constable

@Experimental
public enum ReturnBehavior
extends Enum<ReturnBehavior>

Defines the behavior of a tool's return value when called by a language model.

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
IMMEDIATE	Returns immediately to the caller the value returned by the tool without allowing the LLM to further process it.
TO_LLM	The value returned by the tool is sent back to the LLM for further processing.

Method Summary

Modifier and Type	Method	Description
static ReturnBehavior	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReturnBehavior[]	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

TO_LLM

public static final ReturnBehavior TO_LLM

The value returned by the tool is sent back to the LLM for further processing. This is the default behavior.

IMMEDIATE

public static final ReturnBehavior IMMEDIATE

Returns immediately to the caller the value returned by the tool without allowing the LLM to further process it. Immediate return is only allowed on AI services returning dev.langchain4j.service.Result, while a RuntimeException will be thrown attempting to use a tool with immediate return with an AI service having a different return type.

Method Details

values

public static ReturnBehavior[] 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 ReturnBehavior 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