Package org.springframework.ai.model.tool

Class DefaultToolCallingManager.Builder

java.lang.Object

org.springframework.ai.model.tool.DefaultToolCallingManager.Builder

Enclosing class:

DefaultToolCallingManager

public static final class DefaultToolCallingManager.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DefaultToolCallingManager	build()
DefaultToolCallingManager.Builder	excludeToolFromLimit(String toolName)	Exempt the named tool from the per-tool call limit, so it can be called an unlimited number of times regardless of maxCallsPerTool(int) or a prior maxCallsPerTool(String, int) override for that tool.
DefaultToolCallingManager.Builder	maxCallsPerTool(int maxCallsPerTool)	Default maximum number of times any single tool can be called within a turn, unless overridden for a specific tool name via maxCallsPerTool(String, int) or exempted via excludeToolFromLimit(String).
DefaultToolCallingManager.Builder	maxCallsPerTool(String toolName, int maxCallsPerTool)	Maximum number of times the named tool can be called within a turn, overriding the default set via maxCallsPerTool(int) for that tool only.
DefaultToolCallingManager.Builder	maxTotalToolCalls(int maxTotalToolCalls)	Maximum number of tool calls, across all tools combined, allowed within a turn.
DefaultToolCallingManager.Builder	observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)
DefaultToolCallingManager.Builder	onLimitExceeded(ToolCallLimitBehavior onLimitExceeded)	What to do when a configured limit is exceeded.
DefaultToolCallingManager.Builder	resolutionFallbackEnabled(boolean resolutionFallbackEnabled)	Whether a call to a tool that is not part of the request's tool callbacks may still be executed by resolving it through the ToolCallbackResolver.
DefaultToolCallingManager.Builder	toolCallbackResolver(ToolCallbackResolver toolCallbackResolver)
DefaultToolCallingManager.Builder	toolExecutionExceptionProcessor(ToolExecutionExceptionProcessor toolExecutionExceptionProcessor)
DefaultToolCallingManager.Builder	unlimitedCallsPerTool()	Disable the per-tool call limit entirely, undoing maxCallsPerTool(int) (or the DefaultToolCallingManager.DEFAULT_MAX_CALLS_PER_TOOL default), so that, absent a specific maxCallsPerTool(String, int) override, any tool can be called an unlimited number of times.
DefaultToolCallingManager.Builder	unlimitedTotalToolCalls()	Disable the total tool call limit entirely, undoing maxTotalToolCalls(int) (or the DefaultToolCallingManager.DEFAULT_MAX_TOTAL_TOOL_CALLS default).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

observationRegistry

public DefaultToolCallingManager.Builder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

toolCallbackResolver

public DefaultToolCallingManager.Builder toolCallbackResolver(ToolCallbackResolver toolCallbackResolver)

toolExecutionExceptionProcessor

public DefaultToolCallingManager.Builder toolExecutionExceptionProcessor(ToolExecutionExceptionProcessor toolExecutionExceptionProcessor)

maxCallsPerTool

public DefaultToolCallingManager.Builder maxCallsPerTool(int maxCallsPerTool)

Default maximum number of times any single tool can be called within a turn, unless overridden for a specific tool name via maxCallsPerTool(String, int) or exempted via excludeToolFromLimit(String). Defaults to DefaultToolCallingManager.DEFAULT_MAX_CALLS_PER_TOOL; call unlimitedCallsPerTool() to disable this limit entirely.

unlimitedCallsPerTool

public DefaultToolCallingManager.Builder unlimitedCallsPerTool()

Disable the per-tool call limit entirely, undoing maxCallsPerTool(int) (or the DefaultToolCallingManager.DEFAULT_MAX_CALLS_PER_TOOL default), so that, absent a specific maxCallsPerTool(String, int) override, any tool can be called an unlimited number of times.

maxCallsPerTool

public DefaultToolCallingManager.Builder maxCallsPerTool(String toolName,
 int maxCallsPerTool)

Maximum number of times the named tool can be called within a turn, overriding the default set via maxCallsPerTool(int) for that tool only.

excludeToolFromLimit

public DefaultToolCallingManager.Builder excludeToolFromLimit(String toolName)

Exempt the named tool from the per-tool call limit, so it can be called an unlimited number of times regardless of maxCallsPerTool(int) or a prior maxCallsPerTool(String, int) override for that tool. Calls to this tool still count toward maxTotalToolCalls(int).

maxTotalToolCalls

public DefaultToolCallingManager.Builder maxTotalToolCalls(int maxTotalToolCalls)

Maximum number of tool calls, across all tools combined, allowed within a turn. Defaults to DefaultToolCallingManager.DEFAULT_MAX_TOTAL_TOOL_CALLS; call unlimitedTotalToolCalls() to disable this limit entirely.

unlimitedTotalToolCalls

public DefaultToolCallingManager.Builder unlimitedTotalToolCalls()

Disable the total tool call limit entirely, undoing maxTotalToolCalls(int) (or the DefaultToolCallingManager.DEFAULT_MAX_TOTAL_TOOL_CALLS default).

onLimitExceeded

public DefaultToolCallingManager.Builder onLimitExceeded(ToolCallLimitBehavior onLimitExceeded)

What to do when a configured limit is exceeded. Defaults to ToolCallLimitBehavior.THROW.

resolutionFallbackEnabled

public DefaultToolCallingManager.Builder resolutionFallbackEnabled(boolean resolutionFallbackEnabled)

Whether a call to a tool that is not part of the request's tool callbacks may still be executed by resolving it through the ToolCallbackResolver. Defaults to false, so that the tools attached to a request bound what can be executed for that request.

Parameters:

resolutionFallbackEnabled - true to allow name-based resolution of tools absent from the request via the resolver

Since:

2.0.1

build

public DefaultToolCallingManager build()