dev.langchain4j.data.document

Class Document

java.lang.Object

dev.langchain4j.data.document.Document

public class Document
extends Object

Represents an unstructured piece of text that usually corresponds to a content of a single file. This text could originate from various sources such as a text file, PDF, DOCX, or a web page (HTML). Each document may have associated metadata including its source, owner, creation date, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABSOLUTE_DIRECTORY_PATH Common metadata key for the absolute path of the directory from which the document was loaded.
static String	FILE_NAME Common metadata key for the name of the file from which the document was loaded.
static String	URL Common metadata key for the URL from which the document was loaded.

Constructor Summary

Constructors

Constructor and Description
Document(String text) Creates a new Document from the given text.
Document(String text, Metadata metadata) Creates a new Document from the given text.

Method Summary

Modifier and Type	Method and Description
static Document	document(String text) Creates a new Document from the given text.
static Document	document(String text, Metadata metadata) Creates a new Document from the given text.
boolean	equals(Object o)
static Document	from(String text) Creates a new Document from the given text.
static Document	from(String text, Metadata metadata) Creates a new Document from the given text.
int	hashCode()
Metadata	metadata() Returns the metadata associated with this document.
String	metadata(String key) Looks up the metadata value for the given key.
String	text() Returns the text of this document.
String	toString()
TextSegment	toTextSegment() Builds a TextSegment from this document.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_NAME

public static final String FILE_NAME

Common metadata key for the name of the file from which the document was loaded.

See Also:

Constant Field Values

ABSOLUTE_DIRECTORY_PATH

public static final String ABSOLUTE_DIRECTORY_PATH

Common metadata key for the absolute path of the directory from which the document was loaded.

See Also:

Constant Field Values

URL

public static final String URL

Common metadata key for the URL from which the document was loaded.

See Also:

Constant Field Values

Constructor Detail

Document

public Document(String text)

Creates a new Document from the given text.

The created document will have empty metadata.

Parameters:

text - the text of the document.

Document

public Document(String text,
                Metadata metadata)

Creates a new Document from the given text.

Parameters:

text - the text of the document.

metadata - the metadata of the document.

Method Detail

text

public String text()

Returns the text of this document.

Returns:

the text.

metadata

public Metadata metadata()

Returns the metadata associated with this document.

Returns:

the metadata.

metadata

public String metadata(String key)

Looks up the metadata value for the given key.

Parameters:

key - the key to look up.

Returns:

the metadata value for the given key, or null if the key is not present.

toTextSegment

public TextSegment toTextSegment()

Builds a TextSegment from this document.

Returns:

a TextSegment.

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 Document from(String text)

Creates a new Document from the given text.

The created document will have empty metadata.

Parameters:

text - the text of the document.

Returns:

a new Document.

from

public static Document from(String text,
                            Metadata metadata)

Creates a new Document from the given text.

Parameters:

text - the text of the document.

metadata - the metadata of the document.

Returns:

a new Document.

document

public static Document document(String text)

Creates a new Document from the given text.

The created document will have empty metadata.

Parameters:

text - the text of the document.

Returns:

a new Document.

document

public static Document document(String text,
                                Metadata metadata)

Creates a new Document from the given text.

Parameters:

text - the text of the document.

metadata - the metadata of the document.

Returns:

a new Document.