Share via


SqlServerDbFunctionsExtensions.VectorDistance<T> Method

Definition

Calculates the distance between two vectors using a specified distance metric.

public static double VectorDistance<T>(this Microsoft.EntityFrameworkCore.DbFunctions _, string distanceMetric, Microsoft.Data.SqlTypes.SqlVector<T> vector1, Microsoft.Data.SqlTypes.SqlVector<T> vector2) where T : struct;
static member VectorDistance : Microsoft.EntityFrameworkCore.DbFunctions * string * Microsoft.Data.SqlTypes.SqlVector<'T (requires 'T : struct)> * Microsoft.Data.SqlTypes.SqlVector<'T (requires 'T : struct)> -> double (requires 'T : struct)
<Extension()>
Public Function VectorDistance(Of T As Structure) (_ As DbFunctions, distanceMetric As String, vector1 As SqlVector(Of T), vector2 As SqlVector(Of T)) As Double

Type Parameters

T

Parameters

_
DbFunctions

The DbFunctions instance.

distanceMetric
String

A string with the name of the distance metric to use to calculate the distance between the two given vectors. The following distance metrics are supported: cosine, euclidean or dot.

vector1
SqlVector<T>

The first vector.

vector2
SqlVector<T>

The second vector.

Returns

Remarks

Vector distance is always exact and doesn't use any vector index, even if available.

Applies to