Package dev.langchain4j.rag

Interface RetrievalAugmentor

All Known Implementing Classes:

DefaultRetrievalAugmentor

public interface RetrievalAugmentor

Augments the provided ChatMessage with retrieved Contents.
This serves as an entry point into the RAG flow in LangChain4j.
You are free to use the default implementation (DefaultRetrievalAugmentor) or to implement a custom one.

See Also:

• DefaultRetrievalAugmentor

Method Summary

Modifier and Type	Method	Description
UserMessage	augment(UserMessage userMessage, Metadata metadata)	Deprecated. Use/implement augment(AugmentationRequest) instead.
default AugmentationResult	augment(AugmentationRequest augmentationRequest)	Augments the ChatMessage provided in the AugmentationRequest with retrieved Contents.

Method Details

augment

default AugmentationResult augment(AugmentationRequest augmentationRequest)

Augments the ChatMessage provided in the AugmentationRequest with retrieved Contents.
This method has a default implementation in order to temporarily support current custom implementations of RetrievalAugmentor. The default implementation will be removed soon.

Parameters:

augmentationRequest - The AugmentationRequest containing the ChatMessage to augment.

Returns:

The AugmentationResult containing the augmented ChatMessage.

augment

@Deprecated
UserMessage augment(UserMessage userMessage,
 Metadata metadata)

Deprecated.

Use/implement augment(AugmentationRequest) instead.

Augments the provided UserMessage with retrieved content.

Parameters:

userMessage - The UserMessage to be augmented.

metadata - The Metadata that may be useful or necessary for retrieval and augmentation.

Returns:

The augmented UserMessage.