dev.langchain4j.data.document

Class Metadata

java.lang.Object

dev.langchain4j.data.document.Metadata

public class Metadata
extends Object

Represents metadata of a Document or a TextSegment. The metadata is stored in a key-value map, where both keys and values are strings. For a Document, the metadata could include information such as the source, creation date, owner, or any other relevant details. For a TextSegment, in addition to metadata copied from a document, it can also include segment-specific information, such as the page number, the position of the segment within the document, chapter, etc.

Constructor Summary

Constructors

Constructor and Description
Metadata()
Metadata(Map<String,String> metadata)

Method Summary

Modifier and Type	Method and Description
Metadata	add(String key, Object value) Deprecated.
Metadata	add(String key, String value)
Map<String,String>	asMap()
Metadata	copy()
boolean	equals(Object o)
static Metadata	from(Map<String,String> metadata)
static Metadata	from(String key, Object value) Deprecated.
static Metadata	from(String key, String value)
String	get(String key)
int	hashCode()
static Metadata	metadata(String key, Object value) Deprecated.
static Metadata	metadata(String key, String value)
Metadata	remove(String key)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata

public Metadata()

Metadata

public Metadata(Map<String,String> metadata)

Method Detail

get

public String get(String key)

add

public Metadata add(String key,
                    String value)

add

@Deprecated
public Metadata add(String key,
                                 Object value)

Deprecated.

Use add(String, String) instead

remove

public Metadata remove(String key)

copy

public Metadata copy()

asMap

public Map<String,String> asMap()

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(String key,
                            String value)

from

@Deprecated
public static Metadata from(String key,
                                         Object value)

Deprecated.

Use from(String, String) instead

from

public static Metadata from(Map<String,String> metadata)

metadata

public static Metadata metadata(String key,
                                String value)

metadata

@Deprecated
public static Metadata metadata(String key,
                                             Object value)

Deprecated.

Use metadata(String, String) instead