dev.langchain4j.rag.query

Class Metadata

java.lang.Object

dev.langchain4j.rag.query.Metadata

public class Metadata
extends Object

Represents metadata that may be useful or necessary for retrieval or augmentation purposes.

Constructor Summary

Constructors

Constructor and Description
Metadata(UserMessage userMessage, Object chatMemoryId, List<ChatMessage> chatMemory)

Method Summary

Modifier and Type	Method and Description
List<ChatMessage>	chatMemory()
Object	chatMemoryId()
boolean	equals(Object o)
static Metadata	from(UserMessage userMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
int	hashCode()
String	toString()
UserMessage	userMessage()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Metadata

public Metadata(UserMessage userMessage,
                Object chatMemoryId,
                List<ChatMessage> chatMemory)

Method Detail

userMessage

public UserMessage userMessage()

Returns:

an original UserMessage passed to the RetrievalAugmentor.augment(UserMessage, Metadata).

chatMemoryId

public Object chatMemoryId()

Returns:

a chat memory ID. Present when ChatMemory is used. Can be used to distinguish between users. See @dev.langchain4j.service.MemoryId annotation from a dev.langchain4j:langchain4j module.

chatMemory

public List<ChatMessage> chatMemory()

Returns:

previous messages in the ChatMemory. Present when ChatMemory is used. Can be used to get more details about the context (conversation) in which the Query originated.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static Metadata from(UserMessage userMessage,
                            Object chatMemoryId,
                            List<ChatMessage> chatMemory)