RetrievalAugmentor

All Implemented Interfaces:
```
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`AugmentationResult`	`augment(AugmentationRequest augmentationRequest)`	Augments the ChatMessage provided in the AugmentationRequest with retrieved Contents.
`abstract UserMessage`	`augment(UserMessage userMessage, Metadata metadata)`	Augments the provided UserMessage with retrieved content.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - augment
```
 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() abstract UserMessage augment(UserMessage userMessage, Metadata metadata)
```
    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.