Package org.springframework.ai.rag.generation.augmentation

Class ContextualQueryAugmenter

java.lang.Object

org.springframework.ai.rag.generation.augmentation.ContextualQueryAugmenter

All Implemented Interfaces:

BiFunction<Query,List<org.springframework.ai.document.Document>,Query>, QueryAugmenter

public final class ContextualQueryAugmenter
extends Object
implements QueryAugmenter

Augments the user query with contextual data from the content of the provided documents.

Example usage:

 QueryAugmenter augmenter = ContextualQueryAugmenter.builder()
    .allowEmptyContext(false)
    .build();
 Query augmentedQuery = augmenter.augment(query, documents);
 

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContextualQueryAugmenter.Builder

Constructor Summary

Constructors

Constructor	Description
ContextualQueryAugmenter(org.springframework.ai.chat.prompt.PromptTemplate promptTemplate, org.springframework.ai.chat.prompt.PromptTemplate emptyContextPromptTemplate, Boolean allowEmptyContext, Function<List<org.springframework.ai.document.Document>,String> documentFormatter)

Method Summary

Modifier and Type	Method	Description
Query	augment(Query query, List<org.springframework.ai.document.Document> documents)	Augments the user query with contextual data.
static ContextualQueryAugmenter.Builder	builder()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface org.springframework.ai.rag.generation.augmentation.QueryAugmenter

apply

Constructor Details

ContextualQueryAugmenter

public ContextualQueryAugmenter(@Nullable
 org.springframework.ai.chat.prompt.PromptTemplate promptTemplate,
 @Nullable
 org.springframework.ai.chat.prompt.PromptTemplate emptyContextPromptTemplate,
 @Nullable
 Boolean allowEmptyContext,
 @Nullable
 Function<List<org.springframework.ai.document.Document>,String> documentFormatter)

Method Details

augment

public Query augment(Query query,
 List<org.springframework.ai.document.Document> documents)

Description copied from interface: QueryAugmenter

Augments the user query with contextual data.

Specified by:

augment in interface QueryAugmenter

Parameters:

query - The user query to augment

documents - The contextual data to use for augmentation

Returns:

The augmented query

builder

public static ContextualQueryAugmenter.Builder builder()