CosmosIndexExtensions Class

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.Cosmos.dll

Package:

Microsoft.EntityFrameworkCore.Cosmos v9.0.0

Source:

CosmosIndexExtensions.cs

Index extension methods for Azure Cosmos DB-specific metadata.

[System.Diagnostics.CodeAnalysis.Experimental("EF9103")]
public static class CosmosIndexExtensions

[<System.Diagnostics.CodeAnalysis.Experimental("EF9103")>]
type CosmosIndexExtensions = class

Public Module CosmosIndexExtensions

Inheritance

Object

CosmosIndexExtensions

Attributes

ExperimentalAttribute

Remarks

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

Methods

GetVectorIndexType(IReadOnlyIndex)	Returns the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
GetVectorIndexTypeConfigurationSource(IConventionIndex)	Returns the ConfigurationSource for whether the GetVectorIndexType(IReadOnlyIndex).
SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Boolean)	Sets the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
SetVectorIndexType(IMutableIndex, Nullable<VectorIndexType>)	Sets the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.