Class VectorFilterMode

java.lang.Object

com.azure.core.util.ExpandableStringEnum<VectorFilterMode>

com.azure.search.documents.models.VectorFilterMode

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class VectorFilterMode
extends com.azure.core.util.ExpandableStringEnum<VectorFilterMode>

Determines whether or not filters are applied before or after the vector search is performed.

Field Summary

Fields

Modifier and Type	Field	Description
static final VectorFilterMode	POST_FILTER	The filter will be applied after the candidate set of vector results is returned.
static final VectorFilterMode	PRE_FILTER	The filter will be applied before the search query.
static final VectorFilterMode	STRICT_POST_FILTER	The filter will be applied after the global top-k candidate set of vector results is returned.

Constructor Summary

Constructors

Constructor	Description
VectorFilterMode()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static VectorFilterMode	fromString(String name)	Creates or finds a VectorFilterMode from its string representation.
static Collection<VectorFilterMode>	values()	Gets known VectorFilterMode values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class Object

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

Field Details

POST_FILTER

public static final VectorFilterMode POST_FILTER

The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'.

PRE_FILTER

public static final VectorFilterMode PRE_FILTER

The filter will be applied before the search query.

STRICT_POST_FILTER

public static final VectorFilterMode STRICT_POST_FILTER

The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'.

Constructor Details

VectorFilterMode

@Deprecated
public VectorFilterMode()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of VectorFilterMode value.

Method Details

fromString

public static VectorFilterMode fromString(String name)

Creates or finds a VectorFilterMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding VectorFilterMode.

values

public static Collection<VectorFilterMode> values()

Gets known VectorFilterMode values.

Returns:

known VectorFilterMode values.