CosmosPropertyBuilderExtensions.IsVector Method

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.Cosmos.dll

Package:

Microsoft.EntityFrameworkCore.Cosmos v9.0.0

Overloads

IsVector(PropertyBuilder, DistanceFunction, Int32)	Configures the property as a vector for Azure Cosmos DB.
IsVector(IConventionPropertyBuilder, DistanceFunction, Int32, Boolean)	Configures the property as a vector for Azure Cosmos DB.
IsVector<TProperty>(PropertyBuilder<TProperty>, DistanceFunction, Int32)	Configures the property as a vector for Azure Cosmos DB.

IsVector(PropertyBuilder, DistanceFunction, Int32)

Source:

CosmosPropertyBuilderExtensions.cs

Configures the property as a vector for Azure Cosmos DB.

[System.Diagnostics.CodeAnalysis.Experimental("EF9103")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder IsVector (this Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder propertyBuilder, Microsoft.Azure.Cosmos.DistanceFunction distanceFunction, int dimensions);

[<System.Diagnostics.CodeAnalysis.Experimental("EF9103")>]
static member IsVector : Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder * Microsoft.Azure.Cosmos.DistanceFunction * int -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder

<Extension()>
Public Function IsVector (propertyBuilder As PropertyBuilder, distanceFunction As DistanceFunction, dimensions As Integer) As PropertyBuilder

Parameters

propertyBuilder

PropertyBuilder

The builder for the property being configured.

distanceFunction

DistanceFunction

The distance function for a vector comparisons.

dimensions

Int32

The number of dimensions in the vector.

Returns

PropertyBuilder

The same builder instance so that multiple calls can be chained.

Attributes

ExperimentalAttribute

Remarks

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.

IsVector(IConventionPropertyBuilder, DistanceFunction, Int32, Boolean)

Source:

CosmosPropertyBuilderExtensions.cs

Configures the property as a vector for Azure Cosmos DB.

[System.Diagnostics.CodeAnalysis.Experimental("EF9103")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder? IsVector (this Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder propertyBuilder, Microsoft.Azure.Cosmos.DistanceFunction distanceFunction, int dimensions, bool fromDataAnnotation = false);

[<System.Diagnostics.CodeAnalysis.Experimental("EF9103")>]
static member IsVector : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder * Microsoft.Azure.Cosmos.DistanceFunction * int * bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder

<Extension()>
Public Function IsVector (propertyBuilder As IConventionPropertyBuilder, distanceFunction As DistanceFunction, dimensions As Integer, Optional fromDataAnnotation As Boolean = false) As IConventionPropertyBuilder

Parameters

propertyBuilder

IConventionPropertyBuilder

The builder for the property being configured.

distanceFunction

DistanceFunction

The distance function for a vector comparisons.

dimensions

Int32

The number of dimensions in the vector.

fromDataAnnotation

Boolean

Indicates whether the configuration was specified using a data annotation.

Returns

IConventionPropertyBuilder

The same builder instance if the configuration was applied, null otherwise.

Attributes

ExperimentalAttribute

Remarks

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.

IsVector<TProperty>(PropertyBuilder<TProperty>, DistanceFunction, Int32)

Source:

CosmosPropertyBuilderExtensions.cs

Configures the property as a vector for Azure Cosmos DB.

[System.Diagnostics.CodeAnalysis.Experimental("EF9103")]
public static Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder<TProperty> IsVector<TProperty> (this Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder<TProperty> propertyBuilder, Microsoft.Azure.Cosmos.DistanceFunction distanceFunction, int dimensions);

[<System.Diagnostics.CodeAnalysis.Experimental("EF9103")>]
static member IsVector : Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder<'Property> * Microsoft.Azure.Cosmos.DistanceFunction * int -> Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder<'Property>

<Extension()>
Public Function IsVector(Of TProperty) (propertyBuilder As PropertyBuilder(Of TProperty), distanceFunction As DistanceFunction, dimensions As Integer) As PropertyBuilder(Of TProperty)

Type Parameters

TProperty

The type of the property being configured.

Parameters

propertyBuilder

PropertyBuilder<TProperty>

The builder for the property being configured.

distanceFunction

DistanceFunction

The distance function for a vector comparisons.

dimensions

Int32

The number of dimensions in the vector.

Returns

PropertyBuilder<TProperty>

The same builder instance so that multiple calls can be chained.

Attributes

ExperimentalAttribute

Remarks

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.