Interface RetrievalAugmentedEvent

All Superinterfaces:

AiServiceEvent

All Known Implementing Classes:

DefaultRetrievalAugmentedEvent

@Experimental
public interface RetrievalAugmentedEvent
extends AiServiceEvent

Invoked once per invocation of an AI Service that uses retrieval-augmented generation (RAG), configured with contentRetriever(...) or retrievalAugmentor(...), after the contents to add to the user message were retrieved, also when nothing was retrieved. It carries the user message that was used for the retrieval (the chat message given to the RetrievalAugmentor) and the final contents, after all queries, retrievers, aggregation and re-ranking. To observe each ContentRetriever call separately, with the query it received, use a ContentRetrieverListener.

Since:

1.23.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RetrievalAugmentedEvent.RetrievalAugmentedEventBuilder	Builder for RetrievalAugmentedEvent instances.

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Method Summary

Modifier and Type	Method	Description
static RetrievalAugmentedEvent.RetrievalAugmentedEventBuilder	builder()
ChatMessage	chatMessage()	Returns the chat message given to the RetrievalAugmentor (see AugmentationRequest.chatMessage()), before the retrieved contents were added to it.
List<Content>	contents()	Returns the retrieved contents: the same contents that an AI Service method returning Result<...> gives as its sources.
default Class<RetrievalAugmentedEvent>	eventClass()	Retrieves the class type of the event, representing the specific category of the AI Service invocation event.
default RetrievalAugmentedEvent.RetrievalAugmentedEventBuilder	toBuilder()	Creates a new builder instance initialized with the properties of this AiServiceEvent.

Methods inherited from interface AiServiceEvent

invocationContext

Method Details

chatMessage

ChatMessage chatMessage()

Returns the chat message given to the RetrievalAugmentor (see AugmentationRequest.chatMessage()), before the retrieved contents were added to it. In AI Services this is the user message. It is the input of retrieval, not the queries sent to the content retrievers: the retrieval augmentor can transform it into one or more different queries first.

Returns:

the chat message given to the retrieval augmentor, never null

contents

List<Content> contents()

Returns the retrieved contents: the same contents that an AI Service method returning Result<...> gives as its sources.

Returns:

the retrieved contents, empty if nothing was retrieved, never null

eventClass

default Class<RetrievalAugmentedEvent> eventClass()

Description copied from interface: AiServiceEvent

Retrieves the class type of the event, representing the specific category of the AI Service invocation event.

Specified by:

eventClass in interface AiServiceEvent

toBuilder

default RetrievalAugmentedEvent.RetrievalAugmentedEventBuilder toBuilder()

Description copied from interface: AiServiceEvent

Creates a new builder instance initialized with the properties of this AiServiceEvent. This allows modification of the existing properties and reconstruction of the event.

Specified by:

toBuilder in interface AiServiceEvent

builder

static RetrievalAugmentedEvent.RetrievalAugmentedEventBuilder builder()