Package dev.langchain4j.rag.query.router

Class LanguageModelQueryRouter

java.lang.Object

dev.langchain4j.rag.query.router.LanguageModelQueryRouter

All Implemented Interfaces:

QueryRouter

public class LanguageModelQueryRouter
extends Object
implements QueryRouter

A QueryRouter that utilizes a ChatLanguageModel to make a routing decision.
Each ContentRetriever provided in the constructor should be accompanied by a description which should help the LLM to decide where to route a Query.
Refer to DEFAULT_PROMPT_TEMPLATE and implementation for more details.

Configurable parameters (optional):
- promptTemplate: The prompt template used to ask the LLM for routing decisions.
- fallbackStrategy: The strategy applied if the call to the LLM fails of if LLM does not return a valid response. Please check LanguageModelQueryRouter.FallbackStrategy for more details. Default value: LanguageModelQueryRouter.FallbackStrategy.DO_NOT_ROUTE

See Also:

• DefaultQueryRouter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LanguageModelQueryRouter.FallbackStrategy	Strategy applied if the call to the LLM fails of if LLM does not return a valid response.
static class	LanguageModelQueryRouter.LanguageModelQueryRouterBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected final ChatLanguageModel	chatLanguageModel
static final PromptTemplate	DEFAULT_PROMPT_TEMPLATE
protected final LanguageModelQueryRouter.FallbackStrategy	fallbackStrategy
protected final Map<Integer,ContentRetriever>	idToRetriever
protected final String	options
protected final PromptTemplate	promptTemplate

Constructor Summary

Constructors

Constructor	Description
LanguageModelQueryRouter(ChatLanguageModel chatLanguageModel, Map<ContentRetriever,String> retrieverToDescription)
LanguageModelQueryRouter(ChatLanguageModel chatLanguageModel, Map<ContentRetriever,String> retrieverToDescription, PromptTemplate promptTemplate, LanguageModelQueryRouter.FallbackStrategy fallbackStrategy)

Method Summary

Modifier and Type	Method	Description
static LanguageModelQueryRouter.LanguageModelQueryRouterBuilder	builder()
protected Prompt	createPrompt(Query query)
protected Collection<ContentRetriever>	fallback(Query query, Exception e)
protected Collection<ContentRetriever>	parse(String choices)
Collection<ContentRetriever>	route(Query query)	Routes the given Query to one or multiple ContentRetrievers.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PROMPT_TEMPLATE

public static final PromptTemplate DEFAULT_PROMPT_TEMPLATE

chatLanguageModel

protected final ChatLanguageModel chatLanguageModel

promptTemplate

protected final PromptTemplate promptTemplate

options

protected final String options

idToRetriever

protected final Map<Integer,ContentRetriever> idToRetriever

fallbackStrategy

protected final LanguageModelQueryRouter.FallbackStrategy fallbackStrategy

Constructor Details

LanguageModelQueryRouter

public LanguageModelQueryRouter(ChatLanguageModel chatLanguageModel,
 Map<ContentRetriever,String> retrieverToDescription)

LanguageModelQueryRouter

public LanguageModelQueryRouter(ChatLanguageModel chatLanguageModel,
 Map<ContentRetriever,String> retrieverToDescription,
 PromptTemplate promptTemplate,
 LanguageModelQueryRouter.FallbackStrategy fallbackStrategy)

Method Details

builder

public static LanguageModelQueryRouter.LanguageModelQueryRouterBuilder builder()

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.

fallback

protected Collection<ContentRetriever> fallback(Query query,
 Exception e)

createPrompt

protected Prompt createPrompt(Query query)

parse

protected Collection<ContentRetriever> parse(String choices)