Package org.springframework.ai.document

Enum Class DocumentMetadata

java.lang.Object

java.lang.Enum<DocumentMetadata>

org.springframework.ai.document.DocumentMetadata

All Implemented Interfaces:

Serializable, Comparable<DocumentMetadata>, Constable

public enum DocumentMetadata
extends Enum<DocumentMetadata>

Common set of metadata keys used in Documents by DocumentReaders and VectorStores.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISTANCE	Measure of distance between the document embedding and the query vector.

Method Summary

Modifier and Type	Method	Description
String	toString()
String	value()
static DocumentMetadata	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DocumentMetadata[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISTANCE

public static final DocumentMetadata DISTANCE

Measure of distance between the document embedding and the query vector. The lower the distance, the more they are similar. It's the opposite of the similarity score.

Method Details

values

public static DocumentMetadata[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DocumentMetadata valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

toString

public String toString()

Overrides:

toString in class Enum<DocumentMetadata>