Class DecisionModelFilteringToolProvider.Builder

java.lang.Object

dev.langchain4j.service.tool.DecisionModelFilteringToolProvider.Builder

Enclosing class:

DecisionModelFilteringToolProvider

public static class DecisionModelFilteringToolProvider.Builder
extends Object

Since:

1.21.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DecisionModelFilteringToolProvider.Builder	alwaysInclude(String... toolNames)	Sets tools that are always passed on, without asking the decision model.
DecisionModelFilteringToolProvider.Builder	alwaysInclude(Collection<String> toolNames)	Sets tools that are always passed on, without asking the decision model.
DecisionModelFilteringToolProvider	build()
DecisionModelFilteringToolProvider.Builder	decisionModel(DecisionModel decisionModel)	Sets the decision model that decides which tools are relevant.
DecisionModelFilteringToolProvider.Builder	fallbackStrategy(DecisionModelFilteringToolProvider.FallbackStrategy fallbackStrategy)	Sets what happens when the decision model fails.
DecisionModelFilteringToolProvider.Builder	maxMessages(Integer maxMessages)	Sets how many of the last messages of the conversation (user and assistant messages with text, the last one being the user message) the decision model receives.
DecisionModelFilteringToolProvider.Builder	maxResults(Integer maxResults)	Sets the maximum number of selected tools, in addition to the always included ones.
DecisionModelFilteringToolProvider.Builder	maxToolsPerDecisionRequest(Integer maxToolsPerDecisionRequest)	Sets the maximum number of tools evaluated in a single request to the decision model, for when the tools together exceed the input size accepted by the decision model.
DecisionModelFilteringToolProvider.Builder	minProbability(Double minProbability)	Sets the minimum probability of "yes" for a tool to be selected.
DecisionModelFilteringToolProvider.Builder	questionTemplate(PromptTemplate questionTemplate)	Sets the template of the yes/no question asked for each tool, which must contain the {{name}} variable (the name of the tool) and can contain {{description}} (its description, empty if it has none).
DecisionModelFilteringToolProvider.Builder	toolProvider(ToolProvider toolProvider)	Sets the tool provider whose tools are filtered.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

toolProvider

public DecisionModelFilteringToolProvider.Builder toolProvider(ToolProvider toolProvider)

Sets the tool provider whose tools are filtered. Required.

decisionModel

public DecisionModelFilteringToolProvider.Builder decisionModel(DecisionModel decisionModel)

Sets the decision model that decides which tools are relevant. Required.

questionTemplate

public DecisionModelFilteringToolProvider.Builder questionTemplate(PromptTemplate questionTemplate)

Sets the template of the yes/no question asked for each tool, which must contain the {{name}} variable (the name of the tool) and can contain {{description}} (its description, empty if it has none).

Default value is DecisionModelFilteringToolProvider.DEFAULT_QUESTION_TEMPLATE.

maxResults

public DecisionModelFilteringToolProvider.Builder maxResults(Integer maxResults)

Sets the maximum number of selected tools, in addition to the always included ones. The tools with the highest probabilities are kept.

By default, there is no limit: every tool whose probability reaches the minimum probability is passed on, since a tool that is not passed on cannot be used at all in this request.

minProbability

public DecisionModelFilteringToolProvider.Builder minProbability(Double minProbability)

Sets the minimum probability of "yes" for a tool to be selected.

Default value is 0.5.

maxToolsPerDecisionRequest

public DecisionModelFilteringToolProvider.Builder maxToolsPerDecisionRequest(Integer maxToolsPerDecisionRequest)

Sets the maximum number of tools evaluated in a single request to the decision model, for when the tools together exceed the input size accepted by the decision model.

By default, all tools are evaluated in a single request. This does not limit the number of tools passed on to the LLM, see maxResults(Integer).

alwaysInclude

public DecisionModelFilteringToolProvider.Builder alwaysInclude(String... toolNames)

Sets tools that are always passed on, without asking the decision model. Replaces the previously set tools.

alwaysInclude

public DecisionModelFilteringToolProvider.Builder alwaysInclude(Collection<String> toolNames)

Sets tools that are always passed on, without asking the decision model. Replaces the previously set tools.

maxMessages

public DecisionModelFilteringToolProvider.Builder maxMessages(Integer maxMessages)

Sets how many of the last messages of the conversation (user and assistant messages with text, the last one being the user message) the decision model receives. System messages, tool calls and tool results are never sent, and do not count.

Default value is 3. More messages can make an older topic of the conversation outweigh the user message. Previous messages are only available if the AI Service passes them in ToolProviderRequest.messages().

fallbackStrategy

public DecisionModelFilteringToolProvider.Builder fallbackStrategy(DecisionModelFilteringToolProvider.FallbackStrategy fallbackStrategy)

Sets what happens when the decision model fails.

Default value is DecisionModelFilteringToolProvider.FallbackStrategy.ALL_TOOLS.

build

public DecisionModelFilteringToolProvider build()