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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Metadata.Builder

Constructor Summary

Constructors

Constructor	Description
Metadata(ChatMessage chatMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
Metadata(Metadata.Builder builder)

Method Summary

Modifier and Type	Method	Description
static Metadata.Builder	builder()
List<ChatMessage>	chatMemory()
Object	chatMemoryId()
ChatMessage	chatMessage()
boolean	equals(Object o)
static Metadata	from(ChatMessage chatMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
int	hashCode()
InvocationContext	invocationContext()
InvocationParameters	invocationParameters()
String	toString()

Methods inherited from class Object

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

Constructor Details

Metadata

public Metadata(Metadata.Builder builder)

Metadata

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

Method Details

chatMessage

public ChatMessage chatMessage()

Returns:

an original ChatMessage passed to the RetrievalAugmentor.augment(AugmentationRequest).

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.

invocationContext

public InvocationContext invocationContext()

Since:

1.6.0

invocationParameters

public InvocationParameters invocationParameters()

Since:

1.6.0

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(ChatMessage chatMessage,
 Object chatMemoryId,
 List<ChatMessage> chatMemory)

builder

public static Metadata.Builder builder()