Class VectorToolSearchStrategy

java.lang.Object

dev.langchain4j.service.tool.search.vector.VectorToolSearchStrategy

All Implemented Interfaces:

ToolSearchStrategy

@Experimental
public class VectorToolSearchStrategy
extends Object
implements ToolSearchStrategy

A ToolSearchStrategy that uses vector similarity search to find relevant tools based on the semantic meaning of their names and descriptions.

NOTE: It is important that the tool description (ToolSpecification.description()) is present and comprehensive to ensure that vector search performs effectively.

NOTE: By default, embeddings of tool descriptions are cached (since they rarely change). You can disable this by setting VectorToolSearchStrategy.Builder.cacheEmbeddings(Boolean) to false. The embedding of a query is never cached. To simplify the implementation, the cache is not cleared automatically because the risk of a memory leak is minimal. The number of tools in an application is typically limited and does not increase over time. The cache can be cleared manually by calling clearEmbeddingsCache().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorToolSearchStrategy.Builder

Constructor Summary

Constructors

Constructor	Description
VectorToolSearchStrategy(EmbeddingModel embeddingModel)
VectorToolSearchStrategy(VectorToolSearchStrategy.Builder builder)

Method Summary

Modifier and Type	Method	Description
static VectorToolSearchStrategy.Builder	builder()
void	clearEmbeddingsCache()
protected String	format(ToolSpecification tool)
List<ToolSpecification>	getToolSearchTools(InvocationContext context)	Returns one or more tool specifications that are exposed to the LLM and are used to perform tool searches.
ToolSearchResult	search(ToolSearchRequest request)	Executes a tool search request generated by the LLM and matching it against searchable tools.

Methods inherited from class Object

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

Constructor Details

VectorToolSearchStrategy

public VectorToolSearchStrategy(EmbeddingModel embeddingModel)

VectorToolSearchStrategy

public VectorToolSearchStrategy(VectorToolSearchStrategy.Builder builder)

Method Details

getToolSearchTools

public List<ToolSpecification> getToolSearchTools(InvocationContext context)

Description copied from interface: ToolSearchStrategy

Returns one or more tool specifications that are exposed to the LLM and are used to perform tool searches.

Specified by:

getToolSearchTools in interface ToolSearchStrategy

Parameters:

context - the AI Service invocation context

Returns:

list containing one or more tool search tools

search

public ToolSearchResult search(ToolSearchRequest request)

Description copied from interface: ToolSearchStrategy

Executes a tool search request generated by the LLM and matching it against searchable tools.

Specified by:

search in interface ToolSearchStrategy

Parameters:

request - the tool search request

Returns:

the search result containing matching tool names

format

protected String format(ToolSpecification tool)

clearEmbeddingsCache

public void clearEmbeddingsCache()

builder

public static VectorToolSearchStrategy.Builder builder()