CosmosDbFunctionsExtensions.VectorDistance Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| VectorDistance(DbFunctions, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>, Nullable<Boolean>, VectorDistanceOptions) |
Returns the distance between two vectors, given a distance function (aka similarity measure). |
| VectorDistance(DbFunctions, ReadOnlyMemory<SByte>, ReadOnlyMemory<SByte>, Nullable<Boolean>, VectorDistanceOptions) |
Returns the distance between two vectors, given a distance function (aka similarity measure). |
| VectorDistance(DbFunctions, ReadOnlyMemory<Single>, ReadOnlyMemory<Single>, Nullable<Boolean>, VectorDistanceOptions) |
Returns the distance between two vectors, given a distance function (aka similarity measure). |
VectorDistance(DbFunctions, ReadOnlyMemory<Byte>, ReadOnlyMemory<Byte>, Nullable<Boolean>, VectorDistanceOptions)
Returns the distance between two vectors, given a distance function (aka similarity measure).
public static double VectorDistance(this Microsoft.EntityFrameworkCore.DbFunctions _, ReadOnlyMemory<byte> vector1, ReadOnlyMemory<byte> vector2, bool? useBruteForce = default, Microsoft.EntityFrameworkCore.VectorDistanceOptions? options = default);static member VectorDistance : Microsoft.EntityFrameworkCore.DbFunctions * ReadOnlyMemory<byte> * ReadOnlyMemory<byte> * Nullable<bool> * Microsoft.EntityFrameworkCore.VectorDistanceOptions -> double<Extension()>
Public Function VectorDistance (_ As DbFunctions, vector1 As ReadOnlyMemory(Of Byte), vector2 As ReadOnlyMemory(Of Byte), Optional useBruteForce As Nullable(Of Boolean) = Nothing, Optional options As VectorDistanceOptions = Nothing) As DoubleParameters
The DbFunctions instance.
- vector1
- ReadOnlyMemory<Byte>
The first vector.
- vector2
- ReadOnlyMemory<Byte>
The second vector.
An optional boolean specifying how the computed value is used in an ORDER BY expression.
If true, then brute force is used. A value of false uses any index defined on the vector
property, if it exists. Default value is false.
- options
- VectorDistanceOptions
An optional object used to specify options for the vector distance calculation.
Returns
Applies to
VectorDistance(DbFunctions, ReadOnlyMemory<SByte>, ReadOnlyMemory<SByte>, Nullable<Boolean>, VectorDistanceOptions)
Returns the distance between two vectors, given a distance function (aka similarity measure).
public static double VectorDistance(this Microsoft.EntityFrameworkCore.DbFunctions _, ReadOnlyMemory<sbyte> vector1, ReadOnlyMemory<sbyte> vector2, bool? useBruteForce = default, Microsoft.EntityFrameworkCore.VectorDistanceOptions? options = default);static member VectorDistance : Microsoft.EntityFrameworkCore.DbFunctions * ReadOnlyMemory<sbyte> * ReadOnlyMemory<sbyte> * Nullable<bool> * Microsoft.EntityFrameworkCore.VectorDistanceOptions -> double<Extension()>
Public Function VectorDistance (_ As DbFunctions, vector1 As ReadOnlyMemory(Of SByte), vector2 As ReadOnlyMemory(Of SByte), Optional useBruteForce As Nullable(Of Boolean) = Nothing, Optional options As VectorDistanceOptions = Nothing) As DoubleParameters
The DbFunctions instance.
- vector1
- ReadOnlyMemory<SByte>
The first vector.
- vector2
- ReadOnlyMemory<SByte>
The second vector.
An optional boolean specifying how the computed value is used in an ORDER BY expression.
If true, then brute force is used. A value of false uses any index defined on the vector
property, if it exists. Default value is false.
- options
- VectorDistanceOptions
An optional object used to specify options for the vector distance calculation.
Returns
Applies to
VectorDistance(DbFunctions, ReadOnlyMemory<Single>, ReadOnlyMemory<Single>, Nullable<Boolean>, VectorDistanceOptions)
Returns the distance between two vectors, given a distance function (aka similarity measure).
public static double VectorDistance(this Microsoft.EntityFrameworkCore.DbFunctions _, ReadOnlyMemory<float> vector1, ReadOnlyMemory<float> vector2, bool? useBruteForce = default, Microsoft.EntityFrameworkCore.VectorDistanceOptions? options = default);static member VectorDistance : Microsoft.EntityFrameworkCore.DbFunctions * ReadOnlyMemory<single> * ReadOnlyMemory<single> * Nullable<bool> * Microsoft.EntityFrameworkCore.VectorDistanceOptions -> double<Extension()>
Public Function VectorDistance (_ As DbFunctions, vector1 As ReadOnlyMemory(Of Single), vector2 As ReadOnlyMemory(Of Single), Optional useBruteForce As Nullable(Of Boolean) = Nothing, Optional options As VectorDistanceOptions = Nothing) As DoubleParameters
The DbFunctions instance.
- vector1
- ReadOnlyMemory<Single>
The first vector.
- vector2
- ReadOnlyMemory<Single>
The second vector.
An optional boolean specifying how the computed value is used in an ORDER BY expression.
If true, then brute force is used. A value of false uses any index defined on the vector
property, if it exists. Default value is false.
- options
- VectorDistanceOptions
An optional object used to specify options for the vector distance calculation.
