Struct VectorSearchAlgorithmMetric

The similarity metric to use for vector comparisons.

Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Search.Documents.dll
Syntax
public struct VectorSearchAlgorithmMetric : IEquatable<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric>

Constructors

VectorSearchAlgorithmMetric(String)

Initializes a new instance of VectorSearchAlgorithmMetric.

Declaration
public VectorSearchAlgorithmMetric (string value);
Parameters
System.String value

Exceptions
System.ArgumentNullException

value is null.

Properties

Cosine

cosine.

Declaration
public static Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric Cosine { get; }
Property Value
VectorSearchAlgorithmMetric

DotProduct

dotProduct.

Declaration
public static Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric DotProduct { get; }
Property Value
VectorSearchAlgorithmMetric

Euclidean

euclidean.

Declaration
public static Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric Euclidean { get; }
Property Value
VectorSearchAlgorithmMetric

Methods

Equals(VectorSearchAlgorithmMetric)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals (Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric other);
Parameters
VectorSearchAlgorithmMetric other

An object to compare with this object.
Returns
System.Boolean

true if the current object is equal to the other parameter; otherwise, false.

Equals(Object)

Indicates whether this instance and a specified object are equal.

Declaration
[System.ComponentModel.EditorBrowsable]
public override bool Equals (object obj);
Parameters
System.Object obj

The object to compare with the current instance.
Returns
System.Boolean

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

Declaration
[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();
Returns
System.Int32

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

Declaration
public override string ToString ();
Returns
System.String

The fully qualified type name.

Operators

Equality(VectorSearchAlgorithmMetric, VectorSearchAlgorithmMetric)

Determines if two VectorSearchAlgorithmMetric values are the same.

Declaration
public static bool operator == (Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric left, Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric right);
Parameters
VectorSearchAlgorithmMetric left

VectorSearchAlgorithmMetric right

Returns
System.Boolean

Implicit(String to VectorSearchAlgorithmMetric)

Converts a string to a VectorSearchAlgorithmMetric.

Declaration
public static implicit operator Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric (string value);
Parameters
System.String value

Returns
VectorSearchAlgorithmMetric

Inequality(VectorSearchAlgorithmMetric, VectorSearchAlgorithmMetric)

Determines if two VectorSearchAlgorithmMetric values are not the same.

Declaration
public static bool operator != (Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric left, Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric right);
Parameters
VectorSearchAlgorithmMetric left

VectorSearchAlgorithmMetric right

Returns
System.Boolean