Package org.springframework.ai.vectorstore

Class SimpleVectorStore

java.lang.Object

org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

org.springframework.ai.vectorstore.SimpleVectorStore

All Implemented Interfaces:

Consumer<List<Document>>, DocumentWriter, VectorStore

public class SimpleVectorStore
extends AbstractObservationVectorStore

SimpleVectorStore is a simple implementation of the VectorStore interface. It also provides methods to save the current state of the vectors to a file, and to load vectors from a file. For a deeper understanding of the mathematical concepts and computations involved in calculating similarity scores among vectors, refer to this [resource](https://docs.spring.io/spring-ai/reference/api/vectordbs.html#_understanding_vectors).

Author:

Raphael Yu, Dingmeng Xue, Mark Pollack, Christian Tzolov, Sebastien Deleuze, Ilayaperumal Gopinathan, Thomas Vitale, Jemin Huh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SimpleVectorStore.EmbeddingMath
static final class	SimpleVectorStore.SimpleVectorStoreBuilder

Nested classes/interfaces inherited from interface org.springframework.ai.vectorstore.VectorStore

VectorStore.Builder<T extends VectorStore.Builder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,SimpleVectorStoreContent>	store

Fields inherited from class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

batchingStrategy, embeddingModel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleVectorStore(SimpleVectorStore.SimpleVectorStoreBuilder builder)

Method Summary

Modifier and Type	Method	Description
static SimpleVectorStore.SimpleVectorStoreBuilder	builder(EmbeddingModel embeddingModel)	Creates an instance of SimpleVectorStore builder.
VectorStoreObservationContext.Builder	createObservationContextBuilder(String operationName)	Create a new VectorStoreObservationContext.Builder instance.
void	doAdd(List<Document> documents)	Perform the actual add operation.
void	doDelete(List<String> idList)	Perform the actual delete operation.
List<Document>	doSimilaritySearch(SearchRequest request)	Perform the actual similarity search operation.
void	load(File file)	Deserialize the vector store content from a file in JSON format into memory.
void	load(org.springframework.core.io.Resource resource)	Deserialize the vector store content from a resource in JSON format into memory.
void	save(File file)	Serialize the vector store content into a file in JSON format.

Methods inherited from class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

add, delete, delete, doDelete, similaritySearch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.springframework.ai.document.DocumentWriter

write

Methods inherited from interface org.springframework.ai.vectorstore.VectorStore

accept, delete, getName, getNativeClient, similaritySearch

Field Details

store

protected Map<String,SimpleVectorStoreContent> store

Constructor Details

SimpleVectorStore

protected SimpleVectorStore(SimpleVectorStore.SimpleVectorStoreBuilder builder)

Method Details

builder

public static SimpleVectorStore.SimpleVectorStoreBuilder builder(EmbeddingModel embeddingModel)

Creates an instance of SimpleVectorStore builder.

Returns:

the SimpleVectorStore builder.

doAdd

public void doAdd(List<Document> documents)

Description copied from class: AbstractObservationVectorStore

Perform the actual add operation.

Specified by:

doAdd in class AbstractObservationVectorStore

Parameters:

documents - the documents to add

doDelete

public void doDelete(List<String> idList)

Description copied from class: AbstractObservationVectorStore

Perform the actual delete operation.

Specified by:

doDelete in class AbstractObservationVectorStore

Parameters:

idList - the list of document IDs to delete

doSimilaritySearch

public List<Document> doSimilaritySearch(SearchRequest request)

Description copied from class: AbstractObservationVectorStore

Perform the actual similarity search operation.

Specified by:

doSimilaritySearch in class AbstractObservationVectorStore

Parameters:

request - the search request

Returns:

the list of documents that match the query request conditions

save

public void save(File file)

Serialize the vector store content into a file in JSON format.

Parameters:

file - the file to save the vector store content

load

public void load(File file)

Deserialize the vector store content from a file in JSON format into memory.

Parameters:

file - the file to load the vector store content

load

public void load(org.springframework.core.io.Resource resource)

Deserialize the vector store content from a resource in JSON format into memory.

Parameters:

resource - the resource to load the vector store content

createObservationContextBuilder

public VectorStoreObservationContext.Builder createObservationContextBuilder(String operationName)

Description copied from class: AbstractObservationVectorStore

Create a new VectorStoreObservationContext.Builder instance.

Specified by:

createObservationContextBuilder in class AbstractObservationVectorStore

Parameters:

operationName - the operation name

Returns:

the observation context builder