Share via


VectorSimilarityThreshold Class

Definition

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.

public class VectorSimilarityThreshold : Azure.Search.Documents.Models.VectorThreshold, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Models.VectorSimilarityThreshold>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Models.VectorSimilarityThreshold>
type VectorSimilarityThreshold = class
    inherit VectorThreshold
    interface IJsonModel<VectorSimilarityThreshold>
    interface IPersistableModel<VectorSimilarityThreshold>
Public Class VectorSimilarityThreshold
Inherits VectorThreshold
Implements IJsonModel(Of VectorSimilarityThreshold), IPersistableModel(Of VectorSimilarityThreshold)
Inheritance
VectorSimilarityThreshold
Implements

Constructors

VectorSimilarityThreshold(Double)

Initializes a new instance of VectorSimilarityThreshold.

Properties

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.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<VectorSimilarityThreshold>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<VectorSimilarityThreshold>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<VectorThreshold>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from VectorThreshold)
IJsonModel<VectorThreshold>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from VectorThreshold)
IPersistableModel<VectorSimilarityThreshold>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<VectorSimilarityThreshold>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<VectorSimilarityThreshold>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<VectorThreshold>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from VectorThreshold)
IPersistableModel<VectorThreshold>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from VectorThreshold)
IPersistableModel<VectorThreshold>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from VectorThreshold)

Applies to