Share via

VectorSearchOptions Class

Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:11.8.0
  • java.lang.Object
    • com.azure.search.documents.models.VectorSearchOptions

public final class VectorSearchOptions

Parameters for performing vector searches.

Constructor Summary

Constructor Description
VectorSearchOptions()

Creates a new instance of VectorSearchOptions.

Method Summary

Modifier and Type Method and Description
VectorFilterMode getFilterMode()

Gets the filter mode to apply to vector queries.
List<VectorQuery> getQueries()

Gets the list of vector queries to perform.
VectorSearchOptions setFilterMode(VectorFilterMode filterMode)

Sets the filter mode to apply to vector queries.
VectorSearchOptions setQueries(List<VectorQuery> queries)

Sets the list of vector queries to perform.
VectorSearchOptions setQueries(VectorQuery[] queries)

Sets the list of vector queries to perform.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VectorSearchOptions

public VectorSearchOptions()

Creates a new instance of VectorSearchOptions.

Method Details

getFilterMode

public VectorFilterMode getFilterMode()

Gets the filter mode to apply to vector queries.

Returns:

The filter mode to apply to vector queries.

getQueries

public List<VectorQuery> getQueries()

Gets the list of vector queries to perform.

Returns:

The list of vector queries to perform.

setFilterMode

public VectorSearchOptions setFilterMode(VectorFilterMode filterMode)

Sets the filter mode to apply to vector queries.

Parameters:

filterMode - The filter mode to apply to vector queries.

Returns:

The VectorSearchOptions object itself.

setQueries

public VectorSearchOptions setQueries(List<VectorQuery> queries)

Sets the list of vector queries to perform.

Parameters:

queries - The list of vector queries to perform.

Returns:

The VectorSearchOptions object itself.

setQueries

public VectorSearchOptions setQueries(VectorQuery[] queries)

Sets the list of vector queries to perform.

Parameters:

queries - The list of vector queries to perform.

Returns:

The VectorSearchOptions object itself.

Applies to