VectorFilterMode Class

Package:: com.azure.search.documents.models

Maven Artifact:: com.azure:azure-search-documents:11.9.0-beta.1

java.lang.Object
- com.azure.core.util.ExpandableStringEnum<T>
- - com.azure.search.documents.models.VectorFilterMode

public final class VectorFilterMode
extends ExpandableStringEnum<VectorFilterMode>

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

Field Summary

Modifier and Type	Field and 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

Constructor	Description
VectorFilterMode()	Deprecated Use the fromString(String name) factory method. Creates a new instance of VectorFilterMode value.

Constructor

Description

VectorFilterMode()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of VectorFilterMode value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.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