Package org.springframework.ai.model.tool

Enum Class ToolCallLimitBehavior

java.lang.Object

java.lang.Enum<ToolCallLimitBehavior>

org.springframework.ai.model.tool.ToolCallLimitBehavior

All Implemented Interfaces:

Serializable, Comparable<ToolCallLimitBehavior>, Constable

public enum ToolCallLimitBehavior
extends Enum<ToolCallLimitBehavior>

Determines what DefaultToolCallingManager does when a configured tool call limit (per tool name or total per turn) is exceeded.

Since:

2.0.1

Author:

Christian Tzolov

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
RETURN_ERROR_RESPONSE	Skip invoking the tool callback and instead return a ToolResponseMessage.ToolResponse explaining that the limit was reached, letting the model see the rejection and decide how to proceed.
THROW	Throw a ToolCallLimitExceededException carrying the tool calls executed so far, aborting the current batch of tool calls immediately.

Method Summary

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

THROW

public static final ToolCallLimitBehavior THROW

Throw a ToolCallLimitExceededException carrying the tool calls executed so far, aborting the current batch of tool calls immediately.

RETURN_ERROR_RESPONSE

public static final ToolCallLimitBehavior RETURN_ERROR_RESPONSE

Skip invoking the tool callback and instead return a ToolResponseMessage.ToolResponse explaining that the limit was reached, letting the model see the rejection and decide how to proceed.

Method Details

values

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