Metadata

All Implemented Interfaces:
```
public class Metadata

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

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

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

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

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

- Constructor Detail
  - Metadata
```
Metadata(UserMessage userMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
```
- Method Detail
  - userMessage
```
 UserMessage userMessage()
```
    Returns:
    
    an original UserMessage passed to the augment.
  - chatMemoryId
```
 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
```
 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
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```
  - toString
```
 String toString()
```
  - from
```
 static Metadata from(UserMessage userMessage, Object chatMemoryId, List<ChatMessage> chatMemory)
```