VectorSimilarityThreshold interface

Package:

@azure/search-documents

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.

Extends

BaseVectorThreshold

Properties

kind	Polymorphic discriminator, which specifies the different types this object can be
value	The threshold will filter based on the similarity metric value. 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.

Property Details

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "vectorSimilarity"

Property Value

"vectorSimilarity"

value

The threshold will filter based on the similarity metric value. 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.

value: number

Property Value

number