Class DecisionModelToolSearchStrategy.Builder

java.lang.Object

dev.langchain4j.service.tool.search.decision.DecisionModelToolSearchStrategy.Builder

Enclosing class:

DecisionModelToolSearchStrategy

public static class DecisionModelToolSearchStrategy.Builder
extends Object

Since:

1.21.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DecisionModelToolSearchStrategy	build()
DecisionModelToolSearchStrategy.Builder	decisionModel(DecisionModel decisionModel)	Sets the decision model that decides which tools match the query.
DecisionModelToolSearchStrategy.Builder	maxResults(Integer maxResults)	Sets the maximum number of tools returned by a search.
DecisionModelToolSearchStrategy.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.
DecisionModelToolSearchStrategy.Builder	minProbability(Double minProbability)	Sets the minimum probability of "yes" for a tool to be returned.
DecisionModelToolSearchStrategy.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).
DecisionModelToolSearchStrategy.Builder	throwToolArgumentsExceptions(Boolean throwToolArgumentsExceptions)	Controls which exception type is thrown when the tool arguments are missing or cannot be parsed: ToolArgumentsException if true, ToolExecutionException otherwise.
DecisionModelToolSearchStrategy.Builder	toolArgumentDescription(String toolArgumentDescription)	Sets the description of the tool argument that contains the search query.
DecisionModelToolSearchStrategy.Builder	toolArgumentName(String toolArgumentName)	Sets the name of the tool argument that contains the search query.
DecisionModelToolSearchStrategy.Builder	toolDescription(String toolDescription)	Sets the description of the tool that performs the tool search.
DecisionModelToolSearchStrategy.Builder	toolName(String toolName)	Sets the name of the tool that performs the tool search.
DecisionModelToolSearchStrategy.Builder	toolResultMessageTextProvider(Function<List<String>, String> toolResultMessageTextProvider)	Sets the function that creates the text of the tool result message from the names of the found tools.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

decisionModel

public DecisionModelToolSearchStrategy.Builder decisionModel(DecisionModel decisionModel)

Sets the decision model that decides which tools match the query. Required.

questionTemplate

public DecisionModelToolSearchStrategy.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 DecisionModelToolSearchStrategy.DEFAULT_QUESTION_TEMPLATE.

maxResults

public DecisionModelToolSearchStrategy.Builder maxResults(Integer maxResults)

Sets the maximum number of tools returned by a search.

Default value is 5.

minProbability

public DecisionModelToolSearchStrategy.Builder minProbability(Double minProbability)

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

Default value is 0.5.

maxToolsPerDecisionRequest

public DecisionModelToolSearchStrategy.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).

toolName

public DecisionModelToolSearchStrategy.Builder toolName(String toolName)

Sets the name of the tool that performs the tool search.

Default value is "tool_search_tool".

toolDescription

public DecisionModelToolSearchStrategy.Builder toolDescription(String toolDescription)

Sets the description of the tool that performs the tool search.

Default value is "Finds available tools that can help with a task".

toolArgumentName

public DecisionModelToolSearchStrategy.Builder toolArgumentName(String toolArgumentName)

Sets the name of the tool argument that contains the search query.

Default value is "query".

toolArgumentDescription

public DecisionModelToolSearchStrategy.Builder toolArgumentDescription(String toolArgumentDescription)

Sets the description of the tool argument that contains the search query.

Default value is "Natural language description of the task".

throwToolArgumentsExceptions

public DecisionModelToolSearchStrategy.Builder throwToolArgumentsExceptions(Boolean throwToolArgumentsExceptions)

Controls which exception type is thrown when the tool arguments are missing or cannot be parsed: ToolArgumentsException if true, ToolExecutionException otherwise.

Default value is false.

toolResultMessageTextProvider

public DecisionModelToolSearchStrategy.Builder toolResultMessageTextProvider(Function<List<String>, String> toolResultMessageTextProvider)

Sets the function that creates the text of the tool result message from the names of the found tools.

By default, the text lists the names of the found tools, or says that no matching tools were found.

build

public DecisionModelToolSearchStrategy build()