Package org.springframework.ai.vectorstore

Class MilvusVectorStore

java.lang.Object

org.springframework.ai.vectorstore.MilvusVectorStore

All Implemented Interfaces:

Consumer<List<Document>>, DocumentWriter, VectorStore, org.springframework.beans.factory.InitializingBean

public class MilvusVectorStore
extends Object
implements VectorStore, org.springframework.beans.factory.InitializingBean

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MilvusVectorStore.MilvusVectorStoreConfig	Configuration for the Milvus vector store.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_FIELD_NAME
static final String	DEFAULT_COLLECTION_NAME
static final String	DEFAULT_DATABASE_NAME
static final String	DISTANCE_FIELD_NAME
static final String	DOC_ID_FIELD_NAME
static final String	EMBEDDING_FIELD_NAME
final MilvusFilterExpressionConverter	filterExpressionConverter
static final int	INVALID_EMBEDDING_DIMENSION
static final String	METADATA_FIELD_NAME
static final int	OPENAI_EMBEDDING_DIMENSION_SIZE
static final List<String>	SEARCH_OUTPUT_FIELDS

Constructor Summary

Constructors

Constructor	Description
MilvusVectorStore(io.milvus.client.MilvusServiceClient milvusClient, EmbeddingClient embeddingClient)
MilvusVectorStore(io.milvus.client.MilvusServiceClient milvusClient, EmbeddingClient embeddingClient, MilvusVectorStore.MilvusVectorStoreConfig config)

Method Summary

Modifier and Type	Method	Description
void	add(List<Document> documents)	Adds list of Documents to the vector store.
void	afterPropertiesSet()
Optional<Boolean>	delete(List<String> idList)	Deletes documents from the vector store.
List<Document>	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.

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.vectorstore.VectorStore

accept, similaritySearch

Field Details

OPENAI_EMBEDDING_DIMENSION_SIZE

public static final int OPENAI_EMBEDDING_DIMENSION_SIZE

See Also:

• Constant Field Values

INVALID_EMBEDDING_DIMENSION

public static final int INVALID_EMBEDDING_DIMENSION

See Also:

• Constant Field Values

DEFAULT_DATABASE_NAME

public static final String DEFAULT_DATABASE_NAME

See Also:

• Constant Field Values

DEFAULT_COLLECTION_NAME

public static final String DEFAULT_COLLECTION_NAME

See Also:

• Constant Field Values

DOC_ID_FIELD_NAME

public static final String DOC_ID_FIELD_NAME

See Also:

• Constant Field Values

CONTENT_FIELD_NAME

public static final String CONTENT_FIELD_NAME

See Also:

• Constant Field Values

METADATA_FIELD_NAME

public static final String METADATA_FIELD_NAME

See Also:

• Constant Field Values

EMBEDDING_FIELD_NAME

public static final String EMBEDDING_FIELD_NAME

See Also:

• Constant Field Values

DISTANCE_FIELD_NAME

public static final String DISTANCE_FIELD_NAME

See Also:

• Constant Field Values

SEARCH_OUTPUT_FIELDS

public static final List<String> SEARCH_OUTPUT_FIELDS

filterExpressionConverter

public final MilvusFilterExpressionConverter filterExpressionConverter

Constructor Details

MilvusVectorStore

public MilvusVectorStore(io.milvus.client.MilvusServiceClient milvusClient,
 EmbeddingClient embeddingClient)

MilvusVectorStore

public MilvusVectorStore(io.milvus.client.MilvusServiceClient milvusClient,
 EmbeddingClient embeddingClient,
 MilvusVectorStore.MilvusVectorStoreConfig config)

Method Details

add

public void add(List<Document> documents)

Description copied from interface: VectorStore

Adds list of Documents to the vector store.

Specified by:

add in interface VectorStore

Parameters:

documents - the list of documents to store. Throws an exception if the underlying provider checks for duplicate IDs.

delete

public Optional<Boolean> delete(List<String> idList)

Description copied from interface: VectorStore

Deletes documents from the vector store.

Specified by:

delete in interface VectorStore

Parameters:

idList - list of document ids for which documents will be removed.

Returns:

similaritySearch

public List<Document> similaritySearch(SearchRequest request)

Description copied from interface: VectorStore

Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.

Specified by:

similaritySearch in interface VectorStore

Parameters:

request - Search request for set search parameters, such as the query text, topK, similarity threshold and metadata filter expressions.

Returns:

Returns documents th match the query request conditions.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception