VectorThresholdKind Class

Reference

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

Maven Artifact:: com.azure:azure-search-documents:11.8.0-beta.5

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

public final class VectorThresholdKind
extends ExpandableStringEnum<VectorThresholdKind>

The kind of vector query being performed.

Field Summary

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

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

Constructor

Description

VectorThresholdKind()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of VectorThresholdKind value.

Method Summary

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

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.

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.

Constructor Details