Package org.springframework.ai.model.tool

Interface ToolCallConfirmationPolicy

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ToolCallConfirmationPolicy

Decides which tool calls a person must confirm before they run. DefaultToolCallingManager refuses to run such a call without a decision, and the tool-calling loop pauses on it; see ToolCallDecisions. A custom ToolCallingManager has to check it itself.

Since:

2.1.0

Author:

Christian Tzolov

Method Summary

Modifier and Type	Method	Description
static ToolCallConfirmationPolicy	forTools(String... toolNames)	The calls of the named tools.
static ToolCallConfirmationPolicy	fromToolMetadata()	The calls of tools whose metadata says so (ToolMetadata.requiresConfirmation(), @Tool(requiresConfirmation = true)).
static ToolCallConfirmationPolicy	none()	No call needs confirmation.
default ToolCallConfirmationPolicy	or(ToolCallConfirmationPolicy other)	A call needs confirmation when either policy says so.
boolean	requiresConfirmation(AssistantMessage.ToolCall toolCall, @Nullable ToolMetadata toolMetadata)	Whether the tool call needs a confirmation before it runs.

Method Details

requiresConfirmation

boolean requiresConfirmation(AssistantMessage.ToolCall toolCall,
 @Nullable ToolMetadata toolMetadata)

Whether the tool call needs a confirmation before it runs.

Parameters:

toolCall - the call the model asked for

toolMetadata - the metadata of the tool the call names, or null when the manager finds no tool for the call

or

default ToolCallConfirmationPolicy or(ToolCallConfirmationPolicy other)

A call needs confirmation when either policy says so.

none

static ToolCallConfirmationPolicy none()

No call needs confirmation.

fromToolMetadata

static ToolCallConfirmationPolicy fromToolMetadata()

The calls of tools whose metadata says so (ToolMetadata.requiresConfirmation(), @Tool(requiresConfirmation = true)). The default of DefaultToolCallingManager.

forTools

static ToolCallConfirmationPolicy forTools(String... toolNames)

The calls of the named tools.