From 896692881194c41134120781e7e8abd4fb56bb8c Mon Sep 17 00:00:00 2001 From: Khelan <141972056+khelanmodi@users.noreply.github.com> Date: Thu, 7 May 2026 14:10:11 -0700 Subject: [PATCH 1/2] docs: rebrand Azure Cosmos DB for MongoDB vCore -> Azure DocumentDB The managed MongoDB-compatible service has been renamed from 'Azure Cosmos DB for MongoDB vCore' to 'Azure DocumentDB (with MongoDB compatibility)'. This change is documentation/strings only: - NuGet package Title and Description (CosmosMongoDB.csproj) - Public XML doc comments and parameter descriptions - User-visible NotSupportedException messages - Python docstrings for the (deprecated) memory store All public type names, namespaces, assembly names, and package IDs are intentionally unchanged to preserve binary and source compatibility. Convention used: - First reference per file: 'Azure DocumentDB (with MongoDB compatibility)' - Subsequent references: 'Azure DocumentDB' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .../VectorData/CosmosMongoDB/CosmosMongoCollection.cs | 10 +++++----- .../CosmosMongoCollectionCreateMapping.cs | 10 +++++----- .../CosmosMongoCollectionSearchMapping.cs | 2 +- .../src/VectorData/CosmosMongoDB/CosmosMongoDB.csproj | 4 ++-- .../CosmosMongoServiceCollectionExtensions.cs | 10 +++++----- .../VectorData/CosmosMongoDB/CosmosMongoVectorStore.cs | 6 +++--- .../azure_cosmosdb/azure_cosmos_db_memory_store.py | 2 +- .../azure_cosmosdb/mongo_vcore_store_api.py | 6 +++--- 8 files changed, 25 insertions(+), 25 deletions(-) diff --git a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollection.cs b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollection.cs index 52cc3ded9a2d..5b3751a230b4 100644 --- a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollection.cs +++ b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollection.cs @@ -22,7 +22,7 @@ namespace Microsoft.SemanticKernel.Connectors.CosmosMongoDB; /// -/// Service for storing and retrieving vector records, that uses Azure CosmosDB MongoDB as the underlying storage. +/// Service for storing and retrieving vector records, that uses Azure DocumentDB (with MongoDB compatibility) as the underlying storage. /// /// The data type of the record key. Must be either . /// The data model to use for adding, updating and retrieving data from storage. @@ -44,10 +44,10 @@ public class CosmosMongoCollection : VectorStoreCollectionThe default options for vector search. private static readonly MEVD.VectorSearchOptions s_defaultVectorSearchOptions = new(); - /// that can be used to manage the collections in Azure CosmosDB MongoDB. + /// that can be used to manage the collections in Azure DocumentDB. private readonly IMongoDatabase _mongoDatabase; - /// Azure CosmosDB MongoDB collection to perform record operations. + /// Azure DocumentDB collection to perform record operations. private readonly IMongoCollection _mongoCollection; /// Interface for mapping between a storage model, and the consumer record data model. @@ -76,7 +76,7 @@ public class CosmosMongoCollection : VectorStoreCollection /// Initializes a new instance of the class. /// - /// that can be used to manage the collections in Azure CosmosDB MongoDB. + /// that can be used to manage the collections in Azure DocumentDB. /// The name of the collection that this will access. /// Optional configuration options for this class. [RequiresDynamicCode("This constructor is incompatible with NativeAOT. For dynamic mapping via Dictionary, instantiate CosmosMongoDynamicCollection instead.")] @@ -397,7 +397,7 @@ _ when vectorProperty.EmbeddingGenerationDispatcher is not null itemsAmount, filter), _ => throw new InvalidOperationException( - $"Index kind '{vectorProperty.IndexKind}' on {nameof(VectorStoreVectorProperty)} '{vectorProperty.StorageName}' is not supported by the Azure CosmosDB for MongoDB VectorStore. " + + $"Index kind '{vectorProperty.IndexKind}' on {nameof(VectorStoreVectorProperty)} '{vectorProperty.StorageName}' is not supported by the Azure DocumentDB VectorStore. " + $"Supported index kinds are: {string.Join(", ", [IndexKind.Hnsw, IndexKind.IvfFlat])}") }; diff --git a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs index 08ab4c859e7e..5ddcf976c2d2 100644 --- a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs +++ b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs @@ -9,7 +9,7 @@ namespace Microsoft.SemanticKernel.Connectors.CosmosMongoDB; /// -/// Contains mapping helpers to use when creating a collection in Azure CosmosDB MongoDB. +/// Contains mapping helpers to use when creating a collection in Azure DocumentDB (with MongoDB compatibility). /// internal static class CosmosMongoCollectionCreateMapping { @@ -105,18 +105,18 @@ public static BsonArray GetFilterableDataIndexes( } /// - /// More information about Azure CosmosDB for MongoDB index kinds here: . + /// More information about Azure DocumentDB index kinds here: . /// private static string GetIndexKind(string? indexKind, string vectorPropertyName) => CosmosMongoCollectionSearchMapping.GetVectorPropertyIndexKind(indexKind) switch { IndexKind.Hnsw => "vector-hnsw", IndexKind.IvfFlat => "vector-ivf", - _ => throw new NotSupportedException($"Index kind '{indexKind}' on {nameof(VectorStoreVectorProperty)} '{vectorPropertyName}' is not supported by the Azure CosmosDB for MongoDB VectorStore.") + _ => throw new NotSupportedException($"Index kind '{indexKind}' on {nameof(VectorStoreVectorProperty)} '{vectorPropertyName}' is not supported by the Azure DocumentDB VectorStore.") }; /// - /// More information about Azure CosmosDB for MongoDB distance functions here: . + /// More information about Azure DocumentDB distance functions here: . /// private static string GetDistanceFunction(string? distanceFunction, string vectorPropertyName) => CosmosMongoCollectionSearchMapping.GetVectorPropertyDistanceFunction(distanceFunction) switch @@ -124,6 +124,6 @@ private static string GetDistanceFunction(string? distanceFunction, string vecto DistanceFunction.CosineDistance => "COS", DistanceFunction.DotProductSimilarity => "IP", DistanceFunction.EuclideanDistance => "L2", - _ => throw new NotSupportedException($"Distance function '{distanceFunction}' for {nameof(VectorStoreVectorProperty)} '{vectorPropertyName}' is not supported by the Azure CosmosDB for MongoDB VectorStore.") + _ => throw new NotSupportedException($"Distance function '{distanceFunction}' for {nameof(VectorStoreVectorProperty)} '{vectorPropertyName}' is not supported by the Azure DocumentDB VectorStore.") }; } diff --git a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionSearchMapping.cs b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionSearchMapping.cs index 91aae21f8bb8..41a5fa027ab7 100644 --- a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionSearchMapping.cs +++ b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionSearchMapping.cs @@ -7,7 +7,7 @@ namespace Microsoft.SemanticKernel.Connectors.CosmosMongoDB; /// -/// Contains mapping helpers to use when searching for documents using Azure CosmosDB MongoDB. +/// Contains mapping helpers to use when searching for documents using Azure DocumentDB (with MongoDB compatibility). /// internal static class CosmosMongoCollectionSearchMapping { diff --git a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoDB.csproj b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoDB.csproj index 6cfc45fc2881..50e7689c5da1 100644 --- a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoDB.csproj +++ b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoDB.csproj @@ -19,8 +19,8 @@ - Azure CosmosDB MongoDB vCore provider for Microsoft.Extensions.VectorData - Azure CosmosDB MongoDB vCore provider for Microsoft.Extensions.VectorData by Semantic Kernel + Azure DocumentDB (with MongoDB compatibility) provider for Microsoft.Extensions.VectorData + Azure DocumentDB (with MongoDB compatibility) provider for Microsoft.Extensions.VectorData by Semantic Kernel VECTORDATA-CONNECTORS-NUGET.md diff --git a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoServiceCollectionExtensions.cs b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoServiceCollectionExtensions.cs index 76b1e5b34bf0..f0e797967e6e 100644 --- a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoServiceCollectionExtensions.cs +++ b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoServiceCollectionExtensions.cs @@ -12,7 +12,7 @@ namespace Microsoft.Extensions.DependencyInjection; /// -/// Extension methods to register Azure CosmosDB MongoDB instances on an . +/// Extension methods to register Azure DocumentDB (with MongoDB compatibility) instances on an . /// public static class CosmosMongoServiceCollectionExtensions { @@ -86,8 +86,8 @@ public static IServiceCollection AddCosmosMongoVectorStore( /// /// The to register the on. /// The key with which to associate the vector store. - /// Connection string required to connect to Azure CosmosDB MongoDB. - /// Database name for Azure CosmosDB MongoDB. + /// Connection string required to connect to Azure DocumentDB. + /// Database name for Azure DocumentDB. /// Optional options to further configure the . /// The service lifetime for the store. Defaults to . /// Service collection. @@ -197,8 +197,8 @@ public static IServiceCollection AddCosmosMongoCollection( /// The to register the on. /// The key with which to associate the collection. /// The name of the collection. - /// Connection string required to connect to Azure CosmosDB MongoDB. - /// Database name for Azure CosmosDB MongoDB. + /// Connection string required to connect to Azure DocumentDB. + /// Database name for Azure DocumentDB. /// Optional options to further configure the . /// The service lifetime for the store. Defaults to . /// Service collection. diff --git a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoVectorStore.cs b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoVectorStore.cs index f829dc459206..bcc7daad88eb 100644 --- a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoVectorStore.cs +++ b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoVectorStore.cs @@ -15,7 +15,7 @@ namespace Microsoft.SemanticKernel.Connectors.CosmosMongoDB; /// -/// Class for accessing the list of collections in a Azure CosmosDB MongoDB vector store. +/// Class for accessing the list of collections in an Azure DocumentDB (with MongoDB compatibility) vector store. /// /// /// This class can be used with collections of any schema type, but requires you to provide schema information when getting a collection. @@ -25,7 +25,7 @@ public sealed class CosmosMongoVectorStore : VectorStore /// Metadata about vector store. private readonly VectorStoreMetadata _metadata; - /// that can be used to manage the collections in Azure CosmosDB MongoDB. + /// that can be used to manage the collections in Azure DocumentDB. private readonly IMongoDatabase _mongoDatabase; /// A general purpose definition that can be used to construct a collection when needing to proxy schema agnostic operations. @@ -36,7 +36,7 @@ public sealed class CosmosMongoVectorStore : VectorStore /// /// Initializes a new instance of the class. /// - /// that can be used to manage the collections in Azure CosmosDB MongoDB. + /// that can be used to manage the collections in Azure DocumentDB. /// Optional configuration options for this class. public CosmosMongoVectorStore(IMongoDatabase mongoDatabase, CosmosMongoVectorStoreOptions? options = default) { diff --git a/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/azure_cosmos_db_memory_store.py b/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/azure_cosmos_db_memory_store.py index e64189111704..3e26075d9ecf 100644 --- a/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/azure_cosmos_db_memory_store.py +++ b/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/azure_cosmos_db_memory_store.py @@ -28,7 +28,7 @@ @deprecated("This class will be removed in a future release, use AzureCosmosDBforMongoDBStore and Collection instead.") class AzureCosmosDBMemoryStore(MemoryStoreBase): - """A memory store that uses AzureCosmosDB for MongoDB vCore. + """A memory store that uses Azure DocumentDB (with MongoDB compatibility). To perform vector similarity search on a fully managed MongoDB compatible database service. https://learn.microsoft.com/en-us/azure/cosmos-db/mongodb/vcore/vector-search. diff --git a/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/mongo_vcore_store_api.py b/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/mongo_vcore_store_api.py index 0c64ed6f4972..ae8ad67de5f0 100644 --- a/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/mongo_vcore_store_api.py +++ b/python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/mongo_vcore_store_api.py @@ -25,7 +25,7 @@ @deprecated("This class will be removed in a future release.") class MongoStoreApi(AzureCosmosDBStoreApi): - """MongoStoreApi class for the Azure Cosmos DB Mongo store.""" + """MongoStoreApi class for the Azure DocumentDB (with MongoDB compatibility) store.""" database = None collection_name: str @@ -41,7 +41,7 @@ class MongoStoreApi(AzureCosmosDBStoreApi): """ Args: - collection_name: Name of the collection for the azure cosmos db mongo store + collection_name: Name of the collection for the Azure DocumentDB store index_name: Index for the collection vector_dimensions: Number of dimensions for vector similarity. The maximum number of supported dimensions is 2000 @@ -74,7 +74,7 @@ class MongoStoreApi(AzureCosmosDBStoreApi): ef_construction has to be at least 2 * m ef_search: The size of the dynamic candidate list for search (40 by default). A higher value provides better recall at the cost of speed. - database: The Mongo Database object of the azure cosmos db mongo store + database: The Mongo Database object of the Azure DocumentDB store """ def __init__( From ac631bea8161baf8e64648f5c421e651e32b0e4e Mon Sep 17 00:00:00 2001 From: Khelan Modi <141972056+khelanmodi@users.noreply.github.com> Date: Thu, 7 May 2026 14:34:11 -0700 Subject: [PATCH 2/2] Update documentation link for Azure DocumentDB index kinds --- .../CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs index 5ddcf976c2d2..5d5b9634dbc8 100644 --- a/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs +++ b/dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs @@ -105,7 +105,7 @@ public static BsonArray GetFilterableDataIndexes( } /// - /// More information about Azure DocumentDB index kinds here: . + /// More information about Azure DocumentDB index kinds here: . /// private static string GetIndexKind(string? indexKind, string vectorPropertyName) => CosmosMongoCollectionSearchMapping.GetVectorPropertyIndexKind(indexKind) switch