Package com.azure.search.documents.models

Class VectorThresholdKind

java.lang.Object

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

com.azure.search.documents.models.VectorThresholdKind

All Implemented Interfaces:

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

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

The kind of vector query being performed.

Field Summary

Fields

Modifier and Type	Field	Description
static final VectorThresholdKind	SEARCH_SCORE	The results of the vector query will filter based on the '@search.score' value.
static final VectorThresholdKind	VECTOR_SIMILARITY	The results of the vector query will be filtered based on the vector similarity metric.

Constructor Summary

Constructors

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

Method Summary

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

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

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

VECTOR_SIMILARITY

public static final VectorThresholdKind VECTOR_SIMILARITY

The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field.

SEARCH_SCORE

public static final VectorThresholdKind SEARCH_SCORE

The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score.

Constructor Details

VectorThresholdKind

@Deprecated
public VectorThresholdKind()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of VectorThresholdKind value.

Method Details

fromString

public static VectorThresholdKind fromString(String name)

Creates or finds a VectorThresholdKind from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding VectorThresholdKind.

values

public static Collection<VectorThresholdKind> values()

Gets known VectorThresholdKind values.

Returns:

known VectorThresholdKind values.