Package dev.langchain4j.rag.query.transformer

Class CompressingQueryTransformer

java.lang.Object

dev.langchain4j.rag.query.transformer.CompressingQueryTransformer

All Implemented Interfaces:

QueryTransformer

public class CompressingQueryTransformer
extends Object
implements QueryTransformer

A QueryTransformer that leverages a ChatLanguageModel to condense a given Query along with a chat memory (previous conversation history) into a concise Query. This is applicable only when a ChatMemory is in use. Refer to DEFAULT_PROMPT_TEMPLATE and implementation for more details.

Configurable parameters (optional):
- promptTemplate: The prompt template used to instruct the LLM to compress the specified Query.

See Also:

• DefaultQueryTransformer
• ExpandingQueryTransformer

Field Summary

Fields

Modifier and Type	Field	Description
protected final ChatLanguageModel	chatLanguageModel
static final PromptTemplate	DEFAULT_PROMPT_TEMPLATE
protected final PromptTemplate	promptTemplate

Constructor Summary

Constructors

Constructor	Description
CompressingQueryTransformer(ChatLanguageModel chatLanguageModel)
CompressingQueryTransformer(ChatLanguageModel chatLanguageModel, PromptTemplate promptTemplate)

Method Summary

Modifier and Type	Method	Description
protected Prompt	createPrompt(Query query, String chatMemory)
protected String	format(ChatMessage message)
protected String	format(List<ChatMessage> chatMemory)
Collection<Query>	transform(Query query)	Transforms the given Query into one or multiple Querys.

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

promptTemplate

protected final PromptTemplate promptTemplate

chatLanguageModel

protected final ChatLanguageModel chatLanguageModel

Constructor Details

CompressingQueryTransformer

public CompressingQueryTransformer(ChatLanguageModel chatLanguageModel)

CompressingQueryTransformer

public CompressingQueryTransformer(ChatLanguageModel chatLanguageModel,
 PromptTemplate promptTemplate)

Method Details

transform

public Collection<Query> transform(Query query)

Description copied from interface: QueryTransformer

Transforms the given Query into one or multiple Querys.

Specified by:

transform in interface QueryTransformer

Parameters:

query - The Query to be transformed.

Returns:

A collection of one or more Querys derived from the original Query.

format

protected String format(List<ChatMessage> chatMemory)

format

protected String format(ChatMessage message)

createPrompt

protected Prompt createPrompt(Query query,
 String chatMemory)