Class DefaultQueryRouter

java.lang.Object

dev.langchain4j.rag.query.router.DefaultQueryRouter

All Implemented Interfaces:

QueryRouter

public class DefaultQueryRouter
extends Object
implements QueryRouter

Default implementation of QueryRouter intended to be suitable for the majority of use cases.

It's important to note that while efforts will be made to avoid breaking changes, the default behavior of this class may be updated in the future if it's found that the current behavior does not adequately serve the majority of use cases. Such changes would be made to benefit both current and future users.

This implementation always routes all Querys to one or multiple ContentRetrievers provided in the constructor.

See Also:

• LanguageModelQueryRouter

Constructor Summary

Constructors

Constructor	Description
DefaultQueryRouter(ContentRetriever... contentRetrievers)
DefaultQueryRouter(Collection<ContentRetriever> contentRetrievers)

Method Summary

Modifier and Type	Method	Description
Collection<ContentRetriever>	route(Query query)	Routes the given Query to one or multiple ContentRetrievers.
CompletableFuture<Collection<ContentRetriever>>	routeAsync(Query query)	Non-blocking counterpart of QueryRouter.route(Query), invoked by the asynchronous (CompletableFuture/CompletionStage) and reactive (Flow.Publisher) AI Service modes when RAG is configured.

Methods inherited from class Object

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

Constructor Details

DefaultQueryRouter

public DefaultQueryRouter(ContentRetriever... contentRetrievers)

DefaultQueryRouter

public DefaultQueryRouter(Collection<ContentRetriever> contentRetrievers)

Method Details

route

public Collection<ContentRetriever> route(Query query)

Description copied from interface: QueryRouter

Routes the given Query to one or multiple ContentRetrievers.

Specified by:

route in interface QueryRouter

Parameters:

query - The Query to be routed.

Returns:

A collection of one or more ContentRetrievers to which the Query should be routed.

routeAsync

public CompletableFuture<Collection<ContentRetriever>> routeAsync(Query query)

Description copied from interface: QueryRouter

Non-blocking counterpart of QueryRouter.route(Query), invoked by the asynchronous (CompletableFuture/CompletionStage) and reactive (Flow.Publisher) AI Service modes when RAG is configured.

The default implementation returns a failed future carrying AsyncNotSupportedException: a router backed by a blocking LLM call (e.g. LanguageModelQueryRouter) must opt in by overriding this method to stay off the calling thread. A router that cannot be made non-blocking is still usable from these modes via DefaultRetrievalAugmentor, which offloads the blocking QueryRouter.route(Query) to its executor.

Specified by:

routeAsync in interface QueryRouter

Parameters:

query - The Query to be routed.

Returns:

A CompletableFuture of one or more ContentRetrievers to route the Query to.