Package org.springframework.ai.vectorstore.milvus

Class MilvusSearchRequest

java.lang.Object

org.springframework.ai.vectorstore.SearchRequest

org.springframework.ai.vectorstore.milvus.MilvusSearchRequest

public final class MilvusSearchRequest
extends SearchRequest

A specialized SearchRequest for Milvus vector search, extending the base request with Milvus-specific parameters.

This class introduces two additional fields:

• nativeExpression - A native Milvus filter expression (e.g., "city LIKE 'New%'").
• searchParamsJson - A JSON string containing search parameters (e.g., "{\"nprobe\":128}").

Use the MilvusSearchRequest.MilvusBuilder to construct instances of this class.

Author:

waileong

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MilvusSearchRequest.MilvusBuilder	Builder class for constructing instances of MilvusSearchRequest.

Nested classes/interfaces inherited from class org.springframework.ai.vectorstore.SearchRequest

SearchRequest.Builder

Field Summary

Fields inherited from class org.springframework.ai.vectorstore.SearchRequest

DEFAULT_TOP_K, SIMILARITY_THRESHOLD_ACCEPT_ALL

Method Summary

Modifier and Type	Method	Description
String	getNativeExpression()	Retrieves the native Milvus filter expression.
String	getSearchParamsJson()	Retrieves the JSON-encoded search parameters.
static MilvusSearchRequest.MilvusBuilder	milvusBuilder()	Creates a new MilvusSearchRequest.MilvusBuilder for constructing a MilvusSearchRequest.

Methods inherited from class org.springframework.ai.vectorstore.SearchRequest

builder, equals, from, getFilterExpression, getQuery, getSimilarityThreshold, getTopK, hasFilterExpression, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Details

getNativeExpression

@Nullable
public String getNativeExpression()

Retrieves the native Milvus filter expression.

Returns:

A string representing the native Milvus expression, or null if not set.

getSearchParamsJson

@Nullable
public String getSearchParamsJson()

Retrieves the JSON-encoded search parameters.

Returns:

A JSON string containing search parameters, or null if not set.

milvusBuilder

public static MilvusSearchRequest.MilvusBuilder milvusBuilder()

Creates a new MilvusSearchRequest.MilvusBuilder for constructing a MilvusSearchRequest.

Returns:

A new MilvusSearchRequest.MilvusBuilder instance.