Package org.springframework.ai.document

Class Document

java.lang.Object

org.springframework.ai.document.Document

All Implemented Interfaces:

Content, MediaContent

public class Document
extends Object
implements MediaContent

A document is a container for the content and metadata of a document. It also contains the document's unique ID and an optional embedding.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Document.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ContentFormatter	DEFAULT_CONTENT_FORMATTER
static final String	EMPTY_TEXT

Constructor Summary

Constructors

Constructor	Description
Document(String content)
Document(String id, String content, Collection<Media> media, Map<String,Object> metadata)
Document(String id, String content, Map<String,Object> metadata)
Document(String content, Collection<Media> media, Map<String,Object> metadata)
Document(String content, Map<String,Object> metadata)
Document(String content, Map<String,Object> metadata, IdGenerator idGenerator)

Method Summary

Modifier and Type	Method	Description
static Document.Builder	builder()
boolean	equals(Object obj)
String	getContent()	Get the content of the message.
ContentFormatter	getContentFormatter()	Deprecated. We are considering getting rid of this, please comment on https://github.com/spring-projects/spring-ai/issues/1782
float[]	getEmbedding()	Deprecated. We are considering getting rid of this, please comment on https://github.com/spring-projects/spring-ai/issues/1781
String	getFormattedContent()
String	getFormattedContent(ContentFormatter formatter, MetadataMode metadataMode)	Helper content extractor that uses and external ContentFormatter.
String	getFormattedContent(MetadataMode metadataMode)
String	getId()
Collection<Media>	getMedia()	Get the media associated with the content.
Map<String,Object>	getMetadata()	Get the metadata associated with the content.
int	hashCode()
void	setContentFormatter(ContentFormatter contentFormatter)	Replace the document's ContentFormatter.
void	setEmbedding(float[] embedding)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CONTENT_FORMATTER

public static final ContentFormatter DEFAULT_CONTENT_FORMATTER

EMPTY_TEXT

public static final String EMPTY_TEXT

See Also:

• Constant Field Values

Constructor Details

Document

public Document(String content)

Document

public Document(String content,
 Map<String,Object> metadata)

Document

public Document(String content,
 Collection<Media> media,
 Map<String,Object> metadata)

Document

public Document(String content,
 Map<String,Object> metadata,
 IdGenerator idGenerator)

Document

public Document(String id,
 String content,
 Map<String,Object> metadata)

Document

public Document(String id,
 String content,
 Collection<Media> media,
 Map<String,Object> metadata)

Method Details

builder

public static Document.Builder builder()

getId

public String getId()

getContent

public String getContent()

Description copied from interface: Content

Get the content of the message.

Specified by:

getContent in interface Content

Returns:

the content of the message

getMedia

public Collection<Media> getMedia()

Description copied from interface: MediaContent

Get the media associated with the content.

Specified by:

getMedia in interface MediaContent

getFormattedContent

public String getFormattedContent()

getFormattedContent

public String getFormattedContent(MetadataMode metadataMode)

getFormattedContent

public String getFormattedContent(ContentFormatter formatter,
 MetadataMode metadataMode)

Helper content extractor that uses and external ContentFormatter.

getMetadata

public Map<String,Object> getMetadata()

Description copied from interface: Content

Get the metadata associated with the content.

Specified by:

getMetadata in interface Content

Returns:

the metadata associated with the content

getEmbedding

@Deprecated(since="1.0.0-M4")
public float[] getEmbedding()

Deprecated.

We are considering getting rid of this, please comment on https://github.com/spring-projects/spring-ai/issues/1781

Return the embedding that were calculated.

Returns:

the embeddings

setEmbedding

public void setEmbedding(float[] embedding)

getContentFormatter

public ContentFormatter getContentFormatter()

Deprecated.

We are considering getting rid of this, please comment on https://github.com/spring-projects/spring-ai/issues/1782

Returns the content formatter associated with this document.

Returns:

the current ContentFormatter instance used for formatting the document content.

setContentFormatter

public void setContentFormatter(ContentFormatter contentFormatter)

Replace the document's ContentFormatter.

Parameters:

contentFormatter - new formatter to use.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object