Uses of Class
org.springframework.ai.document.Document

Packages that use Document

Package	Description
org.springframework.ai.azure.openai
org.springframework.ai.bedrock.cohere
org.springframework.ai.bedrock.titan
org.springframework.ai.document
org.springframework.ai.embedding
org.springframework.ai.minimax
org.springframework.ai.mistralai
org.springframework.ai.oci
org.springframework.ai.ollama
org.springframework.ai.openai
org.springframework.ai.postgresml
org.springframework.ai.qianfan
org.springframework.ai.rag.generation.augmentation	RAG Sub-Module: Query Augmentation.
org.springframework.ai.rag.postretrieval.compression	RAG Sub-Module: Document Compression.
org.springframework.ai.rag.postretrieval.ranking	RAG Sub-Module: Document Ranking.
org.springframework.ai.rag.postretrieval.selection	RAG Sub-Module: Document Selection.
org.springframework.ai.rag.retrieval.join	RAG Sub-Module: Document Join.
org.springframework.ai.rag.retrieval.search	RAG Sub-Module: Document Search.
org.springframework.ai.reader
org.springframework.ai.reader.markdown
org.springframework.ai.reader.pdf
org.springframework.ai.reader.tika
org.springframework.ai.transformer
org.springframework.ai.transformer.splitter
org.springframework.ai.transformers
org.springframework.ai.vectorstore
org.springframework.ai.vectorstore.azure
org.springframework.ai.vectorstore.observation	Provides classes for observing and storing vector data.
org.springframework.ai.vectorstore.qdrant
org.springframework.ai.vertexai.embedding.text
org.springframework.ai.watsonx
org.springframework.ai.writer
org.springframework.ai.zhipuai

Uses of Document in org.springframework.ai.azure.openai

Methods in org.springframework.ai.azure.openai with parameters of type Document

Modifier and Type	Method	Description
float[]	AzureOpenAiEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.bedrock.cohere

Methods in org.springframework.ai.bedrock.cohere with parameters of type Document

Modifier and Type	Method	Description
float[]	BedrockCohereEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.bedrock.titan

Methods in org.springframework.ai.bedrock.titan with parameters of type Document

Modifier and Type	Method	Description
float[]	BedrockTitanEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.document

Methods in org.springframework.ai.document that return Document

Modifier and Type	Method	Description
Document	Document.Builder.build()

Methods in org.springframework.ai.document that return types with arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentReader.read()
default List<Document>	DocumentTransformer.transform(List<Document> transform)

Methods in org.springframework.ai.document with parameters of type Document

Modifier and Type	Method	Description
String	ContentFormatter.format(Document document, MetadataMode mode)
String	DefaultContentFormatter.format(Document document, MetadataMode metadataMode)

Method parameters in org.springframework.ai.document with type arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentTransformer.transform(List<Document> transform)
default void	DocumentWriter.write(List<Document> documents)

Uses of Document in org.springframework.ai.embedding

Methods in org.springframework.ai.embedding that return types with arguments of type Document

Modifier and Type	Method	Description
List<List<Document>>	BatchingStrategy.batch(List<Document> documents)	EmbeddingModel implementations can call this method to optimize embedding tokens.
List<List<Document>>	TokenCountBatchingStrategy.batch(List<Document> documents)
List<Document>	DocumentEmbeddingRequest.getInstructions()

Methods in org.springframework.ai.embedding with parameters of type Document

Modifier and Type	Method	Description
float[]	EmbeddingModel.embed(Document document)	Embeds the given document's content into a vector.

Method parameters in org.springframework.ai.embedding with type arguments of type Document

Modifier and Type	Method	Description
List<List<Document>>	BatchingStrategy.batch(List<Document> documents)	EmbeddingModel implementations can call this method to optimize embedding tokens.
List<List<Document>>	TokenCountBatchingStrategy.batch(List<Document> documents)
default List<float[]>	EmbeddingModel.embed(List<Document> documents, EmbeddingOptions options, BatchingStrategy batchingStrategy)	Embeds a batch of Documents into vectors based on a BatchingStrategy.

Constructors in org.springframework.ai.embedding with parameters of type Document

Modifier	Constructor	Description
	DocumentEmbeddingRequest(Document... inputs)

Constructor parameters in org.springframework.ai.embedding with type arguments of type Document

Modifier	Constructor	Description
	DocumentEmbeddingRequest(List<Document> inputs)
	DocumentEmbeddingRequest(List<Document> inputs, EmbeddingOptions options)

Uses of Document in org.springframework.ai.minimax

Methods in org.springframework.ai.minimax with parameters of type Document

Modifier and Type	Method	Description
float[]	MiniMaxEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.mistralai

Methods in org.springframework.ai.mistralai with parameters of type Document

Modifier and Type	Method	Description
float[]	MistralAiEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.oci

Methods in org.springframework.ai.oci with parameters of type Document

Modifier and Type	Method	Description
float[]	OCIEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.ollama

Methods in org.springframework.ai.ollama with parameters of type Document

Modifier and Type	Method	Description
float[]	OllamaEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.openai

Methods in org.springframework.ai.openai with parameters of type Document

Modifier and Type	Method	Description
float[]	OpenAiEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.postgresml

Methods in org.springframework.ai.postgresml with parameters of type Document

Modifier and Type	Method	Description
float[]	PostgresMlEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.qianfan

Methods in org.springframework.ai.qianfan with parameters of type Document

Modifier and Type	Method	Description
float[]	QianFanEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.rag.generation.augmentation

Method parameters in org.springframework.ai.rag.generation.augmentation with type arguments of type Document

Modifier and Type	Method	Description
default Query	QueryAugmenter.apply(Query query, List<Document> documents)
Query	ContextualQueryAugmenter.augment(Query query, List<Document> documents)
Query	QueryAugmenter.augment(Query query, List<Document> documents)	Augments the user query with contextual data.

Uses of Document in org.springframework.ai.rag.postretrieval.compression

Methods in org.springframework.ai.rag.postretrieval.compression that return types with arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentCompressor.apply(Query query, List<Document> documents)
List<Document>	DocumentCompressor.compress(Query query, List<Document> documents)	Compresses the content of each document.

Method parameters in org.springframework.ai.rag.postretrieval.compression with type arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentCompressor.apply(Query query, List<Document> documents)
List<Document>	DocumentCompressor.compress(Query query, List<Document> documents)	Compresses the content of each document.

Uses of Document in org.springframework.ai.rag.postretrieval.ranking

Methods in org.springframework.ai.rag.postretrieval.ranking that return types with arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentRanker.apply(Query query, List<Document> documents)
List<Document>	DocumentRanker.rank(Query query, List<Document> documents)	Ranks documents based on their relevance to the given query.

Method parameters in org.springframework.ai.rag.postretrieval.ranking with type arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentRanker.apply(Query query, List<Document> documents)
List<Document>	DocumentRanker.rank(Query query, List<Document> documents)	Ranks documents based on their relevance to the given query.

Uses of Document in org.springframework.ai.rag.postretrieval.selection

Methods in org.springframework.ai.rag.postretrieval.selection that return types with arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentSelector.apply(Query query, List<Document> documents)
List<Document>	DocumentSelector.select(Query query, List<Document> documents)	Removes irrelevant or redundant documents from a list of retrieved documents.

Method parameters in org.springframework.ai.rag.postretrieval.selection with type arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentSelector.apply(Query query, List<Document> documents)
List<Document>	DocumentSelector.select(Query query, List<Document> documents)	Removes irrelevant or redundant documents from a list of retrieved documents.

Uses of Document in org.springframework.ai.rag.retrieval.join

Methods in org.springframework.ai.rag.retrieval.join that return types with arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentJoiner.apply(Map<Query,List<List<Document>>> documentsForQuery)
List<Document>	ConcatenationDocumentJoiner.join(Map<Query,List<List<Document>>> documentsForQuery)
List<Document>	DocumentJoiner.join(Map<Query,List<List<Document>>> documentsForQuery)	Joins documents retrieved across multiple queries and daa sources.

Method parameters in org.springframework.ai.rag.retrieval.join with type arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentJoiner.apply(Map<Query,List<List<Document>>> documentsForQuery)
List<Document>	ConcatenationDocumentJoiner.join(Map<Query,List<List<Document>>> documentsForQuery)
List<Document>	DocumentJoiner.join(Map<Query,List<List<Document>>> documentsForQuery)	Joins documents retrieved across multiple queries and daa sources.

Uses of Document in org.springframework.ai.rag.retrieval.search

Methods in org.springframework.ai.rag.retrieval.search that return types with arguments of type Document

Modifier and Type	Method	Description
default List<Document>	DocumentRetriever.apply(Query query)
List<Document>	DocumentRetriever.retrieve(Query query)	Retrieves relevant documents from an underlying data source based on the given query.
List<Document>	VectorStoreDocumentRetriever.retrieve(Query query)

Uses of Document in org.springframework.ai.reader

Methods in org.springframework.ai.reader that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	JsonReader.get()
protected List<Document>	JsonReader.get(com.fasterxml.jackson.databind.JsonNode rootNode)
List<Document>	JsonReader.get(String pointer)	Retrieves documents from the JSON resource using a JSON Pointer.
List<Document>	TextReader.get()

Uses of Document in org.springframework.ai.reader.markdown

Methods in org.springframework.ai.reader.markdown that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	MarkdownDocumentReader.get()	Extracts and returns a list of documents from the resource.

Uses of Document in org.springframework.ai.reader.pdf

Methods in org.springframework.ai.reader.pdf that return Document

Modifier and Type	Method	Description
protected Document	PagePdfDocumentReader.toDocument(org.apache.pdfbox.pdmodel.PDPage page, String docText, int startPageNumber, int endPageNumber)
protected Document	ParagraphPdfDocumentReader.toDocument(ParagraphManager.Paragraph from, ParagraphManager.Paragraph to)

Methods in org.springframework.ai.reader.pdf that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	PagePdfDocumentReader.get()
List<Document>	ParagraphPdfDocumentReader.get()	Reads and processes the PDF document to extract paragraphs.

Methods in org.springframework.ai.reader.pdf with parameters of type Document

Modifier and Type	Method	Description
protected void	ParagraphPdfDocumentReader.addMetadata(ParagraphManager.Paragraph from, ParagraphManager.Paragraph to, Document document)

Uses of Document in org.springframework.ai.reader.tika

Methods in org.springframework.ai.reader.tika that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	TikaDocumentReader.get()	Extracts and returns the list of documents from the resource.

Uses of Document in org.springframework.ai.transformer

Methods in org.springframework.ai.transformer that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	ContentFormatTransformer.apply(List<Document> documents)	Post process documents chunked from loader.
List<Document>	KeywordMetadataEnricher.apply(List<Document> documents)
List<Document>	SummaryMetadataEnricher.apply(List<Document> documents)

Method parameters in org.springframework.ai.transformer with type arguments of type Document

Modifier and Type	Method	Description
List<Document>	ContentFormatTransformer.apply(List<Document> documents)	Post process documents chunked from loader.
List<Document>	KeywordMetadataEnricher.apply(List<Document> documents)
List<Document>	SummaryMetadataEnricher.apply(List<Document> documents)

Uses of Document in org.springframework.ai.transformer.splitter

Methods in org.springframework.ai.transformer.splitter that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	TextSplitter.apply(List<Document> documents)
List<Document>	TextSplitter.split(List<Document> documents)
List<Document>	TextSplitter.split(Document document)

Methods in org.springframework.ai.transformer.splitter with parameters of type Document

Modifier and Type	Method	Description
List<Document>	TextSplitter.split(Document document)

Method parameters in org.springframework.ai.transformer.splitter with type arguments of type Document

Modifier and Type	Method	Description
List<Document>	TextSplitter.apply(List<Document> documents)
List<Document>	TextSplitter.split(List<Document> documents)

Uses of Document in org.springframework.ai.transformers

Methods in org.springframework.ai.transformers with parameters of type Document

Modifier and Type	Method	Description
float[]	TransformersEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.vectorstore

Fields in org.springframework.ai.vectorstore with type parameters of type Document

Modifier and Type	Field	Description
protected Map<String,Document>	SimpleVectorStore.store

Methods in org.springframework.ai.vectorstore that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	CassandraVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	ChromaVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	CosmosDBVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	ElasticsearchVectorStore.doSimilaritySearch(SearchRequest searchRequest)
List<Document>	GemFireVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	HanaCloudVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	MilvusVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	MongoDBAtlasVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	Neo4jVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	OpenSearchVectorStore.doSimilaritySearch(SearchRequest searchRequest)
List<Document>	OracleVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	PgVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	PineconeVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	RedisVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	SimpleVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	TypesenseVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	WeaviateVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	CoherenceVectorStore.similaritySearch(SearchRequest request)
List<Document>	CosmosDBVectorStore.similaritySearch(String query)
List<Document>	HanaCloudVectorStore.similaritySearch(String query)
List<Document>	MongoDBAtlasVectorStore.similaritySearch(String query)
List<Document>	OpenSearchVectorStore.similaritySearch(float[] embedding, int topK, double similarityThreshold, Filter.Expression filterExpression)
List<Document>	PineconeVectorStore.similaritySearch(SearchRequest request, String namespace)
default List<Document>	VectorStore.similaritySearch(String query)	Retrieves documents by query embedding similarity using the default SearchRequest's' search criteria.
List<Document>	VectorStore.similaritySearch(SearchRequest request)	Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.

Method parameters in org.springframework.ai.vectorstore with type arguments of type Document

Modifier and Type	Method	Description
default void	VectorStore.accept(List<Document> documents)
void	CoherenceVectorStore.add(List<Document> documents)
void	PineconeVectorStore.add(List<Document> documents, String namespace)	Adds a list of documents to the vector store based on the namespace.
void	VectorStore.add(List<Document> documents)	Adds list of Documents to the vector store.
void	CassandraVectorStore.doAdd(List<Document> documents)
void	ChromaVectorStore.doAdd(List<Document> documents)
void	CosmosDBVectorStore.doAdd(List<Document> documents)
void	ElasticsearchVectorStore.doAdd(List<Document> documents)
void	GemFireVectorStore.doAdd(List<Document> documents)
void	HanaCloudVectorStore.doAdd(List<Document> documents)
void	MilvusVectorStore.doAdd(List<Document> documents)
void	MongoDBAtlasVectorStore.doAdd(List<Document> documents)
void	Neo4jVectorStore.doAdd(List<Document> documents)
void	OpenSearchVectorStore.doAdd(List<Document> documents)
void	OracleVectorStore.doAdd(List<Document> documents)
void	PgVectorStore.doAdd(List<Document> documents)
void	PineconeVectorStore.doAdd(List<Document> documents)	Adds a list of documents to the vector store.
void	RedisVectorStore.doAdd(List<Document> documents)
void	SimpleVectorStore.doAdd(List<Document> documents)
void	TypesenseVectorStore.doAdd(List<Document> documents)
void	WeaviateVectorStore.doAdd(List<Document> documents)

Uses of Document in org.springframework.ai.vectorstore.azure

Methods in org.springframework.ai.vectorstore.azure that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	AzureVectorStore.doSimilaritySearch(SearchRequest request)
List<Document>	AzureVectorStore.similaritySearch(String query)

Method parameters in org.springframework.ai.vectorstore.azure with type arguments of type Document

Modifier and Type	Method	Description
void	AzureVectorStore.doAdd(List<Document> documents)

Uses of Document in org.springframework.ai.vectorstore.observation

Methods in org.springframework.ai.vectorstore.observation that return types with arguments of type Document

Modifier and Type	Method	Description
abstract List<Document>	AbstractObservationVectorStore.doSimilaritySearch(SearchRequest request)	Perform the actual similarity search operation.
List<Document>	VectorStoreObservationContext.getQueryResponse()
List<Document>	AbstractObservationVectorStore.similaritySearch(SearchRequest request)

Method parameters in org.springframework.ai.vectorstore.observation with type arguments of type Document

Modifier and Type	Method	Description
void	AbstractObservationVectorStore.add(List<Document> documents)	Create a new AbstractObservationVectorStore instance.
abstract void	AbstractObservationVectorStore.doAdd(List<Document> documents)	Perform the actual add operation.
void	VectorStoreObservationContext.setQueryResponse(List<Document> queryResponse)
VectorStoreObservationContext.Builder	VectorStoreObservationContext.Builder.withQueryResponse(List<Document> documents)

Uses of Document in org.springframework.ai.vectorstore.qdrant

Methods in org.springframework.ai.vectorstore.qdrant that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	QdrantVectorStore.doSimilaritySearch(SearchRequest request)	Performs a similarity search on the vector store.

Method parameters in org.springframework.ai.vectorstore.qdrant with type arguments of type Document

Modifier and Type	Method	Description
void	QdrantVectorStore.doAdd(List<Document> documents)	Adds a list of documents to the vector store.

Uses of Document in org.springframework.ai.vertexai.embedding.text

Methods in org.springframework.ai.vertexai.embedding.text with parameters of type Document

Modifier and Type	Method	Description
float[]	VertexAiTextEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.watsonx

Methods in org.springframework.ai.watsonx with parameters of type Document

Modifier and Type	Method	Description
float[]	WatsonxAiEmbeddingModel.embed(Document document)

Uses of Document in org.springframework.ai.writer

Method parameters in org.springframework.ai.writer with type arguments of type Document

Modifier and Type	Method	Description
void	FileDocumentWriter.accept(List<Document> docs)

Uses of Document in org.springframework.ai.zhipuai

Methods in org.springframework.ai.zhipuai with parameters of type Document

Modifier and Type	Method	Description
float[]	ZhiPuAiEmbeddingModel.embed(Document document)