Package org.springframework.ai.vectorstore

Class MilvusVectorStore

java.lang.Object

org.springframework.ai.vectorstore.MilvusVectorStore

All Implemented Interfaces:

VectorStore, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class MilvusVectorStore
extends Object
implements VectorStore, org.springframework.context.SmartLifecycle

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
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

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

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 Documents to the vector store.
Optional<Boolean>	delete(List<String> idList)
boolean	isAutoStartup()
boolean	isRunning()
List<Document>	similaritySearch(String query)
List<Document>	similaritySearch(String query, int topK)
List<Document>	similaritySearch(String query, int topK, double similarityThreshold)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, stop

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

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 Documents to the vector store.

Specified by:

add in interface VectorStore

Parameters:

documents - the list of documents to store Will throw an exception if the underlying provider checks for duplicate IDs on add

delete

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

Specified by:

delete in interface VectorStore

similaritySearch

public List<Document> similaritySearch(String query)

Specified by:

similaritySearch in interface VectorStore

similaritySearch

public List<Document> similaritySearch(String query,
 int topK)

Specified by:

similaritySearch in interface VectorStore

similaritySearch

public List<Document> similaritySearch(String query,
 int topK,
 double similarityThreshold)

Specified by:

similaritySearch in interface VectorStore

Parameters:

query - The query to send, it will be converted to an embedding based on the configuration of the vector store.

topK - the top 'k' similar results

similarityThreshold - the lower bound of the similarity score

Returns:

similar documents

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle