Package org.springframework.ai.vectorstore

Class SearchRequest

java.lang.Object

org.springframework.ai.vectorstore.SearchRequest

public final class SearchRequest
extends Object

Similarity search request. Use the builder() to create the instance of a SearchRequest.

Author:

Christian Tzolov, Thomas Vitale, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchRequest.Builder	SearchRequest Builder.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_TOP_K	Default value for the top 'k' similar results to return.
static final double	SIMILARITY_THRESHOLD_ACCEPT_ALL	Similarity threshold that accepts all search scores.

Constructor Summary

Constructors

Constructor	Description
SearchRequest()

Method Summary

Modifier and Type	Method	Description
static SearchRequest.Builder	builder()	Builder for creating the SearchRequest instance.
static SearchRequest.Builder	defaults()	Deprecated, for removal: This API element is subject to removal in a future version. use builder() instead.
boolean	equals(Object o)
static SearchRequest.Builder	from(SearchRequest originalSearchRequest)	Copy an existing SearchRequest.Builder instance.
Filter.Expression	getFilterExpression()
String	getQuery()
double	getSimilarityThreshold()
int	getTopK()
boolean	hasFilterExpression()
int	hashCode()
static SearchRequest	query(String query)	Deprecated, for removal: This API element is subject to removal in a future version. use SearchRequest.Builder.query(String) instead.
String	toString()
SearchRequest	withFilterExpression(String textExpression)	Deprecated, for removal: This API element is subject to removal in a future version. use SearchRequest.Builder.filterExpression(String) instead.
SearchRequest	withFilterExpression(Filter.Expression expression)	Deprecated, for removal: This API element is subject to removal in a future version. use SearchRequest.Builder.filterExpression(Filter.Expression) instead.
SearchRequest	withQuery(String query)	Deprecated, for removal: This API element is subject to removal in a future version. use SearchRequest.Builder.query(String) instead.
SearchRequest	withSimilarityThreshold(double threshold)	Deprecated, for removal: This API element is subject to removal in a future version. use SearchRequest.Builder.similarityThreshold(double) instead.
SearchRequest	withSimilarityThresholdAll()	Deprecated, for removal: This API element is subject to removal in a future version. use SearchRequest.Builder.similarityThresholdAll() instead.
SearchRequest	withTopK(int topK)	Deprecated, for removal: This API element is subject to removal in a future version. use SearchRequest.Builder.topK(int) instead.

Methods inherited from class java.lang.Object

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

Field Details

SIMILARITY_THRESHOLD_ACCEPT_ALL

public static final double SIMILARITY_THRESHOLD_ACCEPT_ALL

Similarity threshold that accepts all search scores. A threshold value of 0.0 means any similarity is accepted or disable the similarity threshold filtering. A threshold value of 1.0 means an exact match is required.

See Also:

• Constant Field Values

DEFAULT_TOP_K

public static final int DEFAULT_TOP_K

Default value for the top 'k' similar results to return.

See Also:

• Constant Field Values

Constructor Details

SearchRequest

public SearchRequest()

Method Details

from

public static SearchRequest.Builder from(SearchRequest originalSearchRequest)

Copy an existing SearchRequest.Builder instance.

Parameters:

originalSearchRequest - SearchRequest instance to copy.

Returns:

Returns new SearchRequest.Builder instance.

query

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public static SearchRequest query(String query)

Deprecated, for removal: This API element is subject to removal in a future version.

use SearchRequest.Builder.query(String) instead.

defaults

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public static SearchRequest.Builder defaults()

Deprecated, for removal: This API element is subject to removal in a future version.

use builder() instead.

Create a new SearchRequest builder instance with an empty embedding query string. Use the SearchRequest.Builder.query(String query) to set/update the embedding query text.

Returns:

Returns new SearchRequest builder instance.

builder

public static SearchRequest.Builder builder()

Builder for creating the SearchRequest instance.

Returns:

the builder.

withQuery

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public SearchRequest withQuery(String query)

Deprecated, for removal: This API element is subject to removal in a future version.

use SearchRequest.Builder.query(String) instead.

withTopK

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public SearchRequest withTopK(int topK)

Deprecated, for removal: This API element is subject to removal in a future version.

use SearchRequest.Builder.topK(int) instead.

withSimilarityThreshold

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public SearchRequest withSimilarityThreshold(double threshold)

Deprecated, for removal: This API element is subject to removal in a future version.

use SearchRequest.Builder.similarityThreshold(double) instead.

withSimilarityThresholdAll

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public SearchRequest withSimilarityThresholdAll()

Deprecated, for removal: This API element is subject to removal in a future version.

use SearchRequest.Builder.similarityThresholdAll() instead.

withFilterExpression

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public SearchRequest withFilterExpression(@Nullable
 Filter.Expression expression)

Deprecated, for removal: This API element is subject to removal in a future version.

use SearchRequest.Builder.filterExpression(Filter.Expression) instead.

withFilterExpression

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public SearchRequest withFilterExpression(@Nullable
 String textExpression)

Deprecated, for removal: This API element is subject to removal in a future version.

use SearchRequest.Builder.filterExpression(String) instead.

getQuery

public String getQuery()

getTopK

public int getTopK()

getSimilarityThreshold

public double getSimilarityThreshold()

getFilterExpression

@Nullable
public Filter.Expression getFilterExpression()

hasFilterExpression

public boolean hasFilterExpression()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object