Package com.hazelcast.vector

Interface SearchOptions

@Beta
public interface SearchOptions

Vector search options

Since:

5.5

Method Summary

Modifier and Type	Method	Description
static SearchOptionsBuilder	builder()
Map<String,String>	getHints()
int	getLimit()
VectorValues	getVectors()
boolean	isIncludeValue()
boolean	isIncludeVectors()
static SearchOptions	of(float[] vector, int limit, boolean includeValue, boolean includeVectors)
static SearchOptions	of(Map<String,float[]> vectors, int limit, boolean includeValue, boolean includeVectors)

Method Details

getVectors

VectorValues getVectors()

Returns:

one or more search vectors, mapped to the associated index name.

isIncludeValue

boolean isIncludeValue()

Returns:

true if search results should include the user-supplied value or false if only keys should be returned.

isIncludeVectors

boolean isIncludeVectors()

Returns:

true if search results should include the vectors associated with each search result, false otherwise.

getLimit

int getLimit()

Returns:

the number of search results to return

getHints

Map<String,String> getHints()

Returns:

hints for search execution

builder

static SearchOptionsBuilder builder()

Returns:

builder of SearchOptions

of

static SearchOptions of(float[] vector,
 int limit,
 boolean includeValue,
 boolean includeVectors)

of

static SearchOptions of(Map<String,float[]> vectors,
 int limit,
 boolean includeValue,
 boolean includeVectors)