Package com.hazelcast.vector

Class SearchOptionsBuilder

java.lang.Object

com.hazelcast.vector.SearchOptionsBuilder

@Beta
public class SearchOptionsBuilder
extends Object

Vector search options builder

Since:

5.5

Constructor Summary

Constructors

Constructor	Description
SearchOptionsBuilder()

Method Summary

Modifier and Type	Method	Description
SearchOptions	build()	Creates SearchOptions
<T> SearchOptionsBuilder	hint(Hint<T> hint, T value)	Adds search hint.
<T> SearchOptionsBuilder	hint(String hintName, T value)	Adds search hint.
SearchOptionsBuilder	hints(Map<String,String> hints)	Sets search hints.
SearchOptionsBuilder	includeValue()	Includes the user-supplied value in search results.
SearchOptionsBuilder	includeVectors()	Includes the vectors associated with each search result in search results.
SearchOptionsBuilder	limit(int limit)	Sets the number of search results to return.
SearchOptionsBuilder	setIncludeValue(boolean includeValue)	Includes or excludes the user-supplied value in search results.
SearchOptionsBuilder	setIncludeVectors(boolean includeVectors)	Includes or excludes the vectors associated with each search result in search results.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchOptionsBuilder

public SearchOptionsBuilder()

Method Details

includeValue

public SearchOptionsBuilder includeValue()

Includes the user-supplied value in search results.

Returns:

this builder instance

See Also:

• SearchOptions.isIncludeValue()

setIncludeValue

public SearchOptionsBuilder setIncludeValue(boolean includeValue)

Includes or excludes the user-supplied value in search results.

Parameters:

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

Returns:

this builder instance

See Also:

• SearchOptions.isIncludeValue()

includeVectors

public SearchOptionsBuilder includeVectors()

Includes the vectors associated with each search result in search results.

Returns:

this builder instance

See Also:

• SearchOptions.isIncludeVectors()

setIncludeVectors

public SearchOptionsBuilder setIncludeVectors(boolean includeVectors)

Includes or excludes the vectors associated with each search result in search results.

Parameters:

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

Returns:

this builder instance

See Also:

• SearchOptions.isIncludeVectors()

limit

public SearchOptionsBuilder limit(int limit)

Sets the number of search results to return.

Parameters:

limit - the number of search results to return. Must be positive.

Returns:

this builder instance

See Also:

• SearchOptions.getLimit()

hint

public <T> SearchOptionsBuilder hint(@Nonnull
 String hintName,
 @Nonnull
 T value)

Adds search hint. Hints allow fine-tuning of the query execution.

Type Parameters:

T - type of hint value

Parameters:

hintName - name of the hint

value - value of the hint

Returns:

this builder instance

See Also:

• SearchOptions.getHints()

hint

public <T> SearchOptionsBuilder hint(@Nonnull
 Hint<T> hint,
 @Nonnull
 T value)

Adds search hint. Hints allow fine-tuning of the query execution.

Type Parameters:

T - type of hint value

Parameters:

hint - hint definition

value - value of the hint

Returns:

this builder instance

See Also:

• SearchOptions.getHints()

hints

public SearchOptionsBuilder hints(@Nonnull
 Map<String,String> hints)

Sets search hints. Hints allow fine-tuning of the query execution.

Parameters:

hints - map of hint names and values

Returns:

this builder instance

See Also:

• SearchOptions.getHints()

build

public SearchOptions build()

Creates SearchOptions

Returns:

SearchOptions instance