.Net: docs: rebrand Azure Cosmos DB for MongoDB vCore -> Azure DocumentDB#13968
.Net: docs: rebrand Azure Cosmos DB for MongoDB vCore -> Azure DocumentDB#13968khelanmodi wants to merge 2 commits intomicrosoft:mainfrom
Conversation
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>
There was a problem hiding this comment.
Pull request overview
Updates user-facing naming in the Cosmos MongoDB vector connector and deprecated Python memory store to reflect the rebrand from “Azure Cosmos DB for MongoDB vCore” to “Azure DocumentDB (with MongoDB compatibility)”, without changing any APIs, namespaces, or behavior.
Changes:
- Updated NuGet package metadata (Title/Description) for the CosmosMongoDB connector.
- Rebranded C# XML docs and user-visible exception messages across the CosmosMongoDB vector store/collection/mapping/DI extensions.
- Rebranded Python docstrings for the deprecated
azure_cosmosdbmemory store components.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| dotnet/src/VectorData/CosmosMongoDB/CosmosMongoDB.csproj | Updates NuGet package Title/Description to the new product name. |
| dotnet/src/VectorData/CosmosMongoDB/CosmosMongoVectorStore.cs | Updates XML docs to reference Azure DocumentDB. |
| dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollection.cs | Updates XML docs and a user-visible exception message for the new name. |
| dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.cs | Updates XML docs + NotSupportedException messages; updates documentation links. |
| dotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionSearchMapping.cs | Updates XML docs to reference Azure DocumentDB. |
| dotnet/src/VectorData/CosmosMongoDB/CosmosMongoServiceCollectionExtensions.cs | Updates XML docs for DI registration APIs to reference Azure DocumentDB. |
| python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/azure_cosmos_db_memory_store.py | Updates deprecated memory store docstring to the new product name. |
| python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/mongo_vcore_store_api.py | Updates deprecated Mongo store API docstrings to the new product name. |
Comments suppressed due to low confidence (2)
python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/azure_cosmos_db_memory_store.py:35
- The class docstring now refers to Azure DocumentDB, but the referenced documentation URL still points to the older Cosmos DB MongoDB vCore vector-search article. This mix of product names is likely to confuse readers; please either update the link to the Azure DocumentDB equivalent or adjust the surrounding text to clarify why the Cosmos DB URL is still the correct reference.
"""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.
"""
python/semantic_kernel/connectors/memory_stores/azure_cosmosdb/mongo_vcore_store_api.py:48
- The detailed parameter documentation is currently a standalone triple-quoted string literal inside the class body (separate from the class docstring and from init). This content won’t show up in generated docs or help() for the initializer; consider moving it into the init docstring (or converting it to comments) so the argument docs are discoverable.
"""
Args:
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
num_lists: This integer is the number of clusters that the
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Automated Code Review
Reviewers: 4 | Confidence: 93%
✓ Correctness
This is a purely cosmetic/documentation PR that renames 'Azure Cosmos DB for MongoDB vCore' to 'Azure DocumentDB (with MongoDB compatibility)' in doc comments, docstrings, NuGet metadata, and exception messages. All changes are string-only with no logic modifications. No tests assert on the changed exception message strings, so no test breakage is expected. The renaming is applied consistently across all changed files following the stated convention (full name on first reference, short name thereafter). No correctness issues found.
✓ Security Reliability
This PR exclusively modifies documentation strings (XML doc comments, NuGet metadata, Python docstrings) and user-facing exception messages to reflect Microsoft's rebranding from 'Azure Cosmos DB for MongoDB vCore' to 'Azure DocumentDB (with MongoDB compatibility)'. No logic, control flow, API surface, or security-relevant code is changed. The exception message string changes do not break any existing tests, as no tests assert on the specific message content that was modified. No security or reliability concerns.
✓ Test Coverage
This is a documentation-and-strings-only PR renaming 'Azure Cosmos DB for MongoDB vCore' to 'Azure DocumentDB (with MongoDB compatibility)' in XML doc comments, Python docstrings, NuGet metadata, and user-visible exception messages. No new behavior is introduced. Existing conformance tests (CosmosMongoDistanceFunctionTests.cs, CosmosMongoIndexKindTests.cs) verify that NotSupportedException is thrown for unsupported configurations but do not assert on message text, so the exception message changes are safe. No test coverage gaps were found — there is nothing new to test.
✗ Design Approach
I found one design-level issue in the docs-only rename: a few API-contract strings now describe the connector as targeting plain Azure DocumentDB, which overstates the supported backend surface. The implementation and neighboring contracts still require the MongoDB-compatible flavor, so those particular strings should keep the compatibility qualifier. I did not find other design-approach problems in the remaining rebrand-only edits.
Automated review by khelanmodi's agents
| /// <param name="connectionString">Connection string required to connect to Azure DocumentDB.</param> | ||
| /// <param name="databaseName">Database name for Azure DocumentDB.</param> |
There was a problem hiding this comment.
These contract docs now imply that any Azure DocumentDB endpoint is valid input, but this overload still creates a MongoClient and calls GetDatabase on the supplied values (CosmosMongoServiceCollectionExtensions.cs:111-113). The repo's active connector surface also remains explicitly MongoDB-specific (python/semantic_kernel/connectors/azure_cosmos_db.py:214-226), and the .NET DI tests use MongoDB connection strings here (dotnet/test/VectorData/CosmosMongoDB.ConformanceTests/CosmosMongoDependencyInjectionTests.cs:15, 43-45). For API-contract text like this, the shorthand drops an important constraint; keep the MongoDB-compatibility qualifier.
| /// <param name="connectionString">Connection string required to connect to Azure DocumentDB.</param> | |
| /// <param name="databaseName">Database name for Azure DocumentDB.</param> | |
| /// <param name="connectionString">Connection string required to connect to Azure DocumentDB (with MongoDB compatibility).</param> | |
| /// <param name="databaseName">Database name for Azure DocumentDB (with MongoDB compatibility).</param> |
Summary
Microsoft has renamed the managed MongoDB-compatible service from Azure Cosmos DB for MongoDB vCore to Azure DocumentDB (with MongoDB compatibility). The wire protocol, connection strings, drivers, and APIs are unchanged.
This PR updates user-visible references to the new product name in the
Microsoft.SemanticKernel.Connectors.CosmosMongoDBpackage and the (deprecated) Pythonazure_cosmosdbmemory store.See: https://learn.microsoft.com/azure/documentdb/
Scope (docs/strings only)
CosmosMongoDB.csproj— NuGet<Title>and<Description>CosmosMongoVectorStore,CosmosMongoCollection,CosmosMongoServiceCollectionExtensions, and the create/search mapping helpersNotSupportedExceptionmessages thrown for unsupported index kinds / distance functionsAzureCosmosDBMemoryStoreandMongoStoreApiBackward compatibility
All public type names, namespaces, assembly names, and package IDs are intentionally unchanged:
Microsoft.SemanticKernel.Connectors.CosmosMongoDBMicrosoft.SemanticKernel.Connectors.CosmosMongoDBCosmosMongoVectorStore,CosmosMongoCollection<TKey, TRecord>,CosmosMongoCollectionOptions, etc.No source or binary breakage.
Convention used
Files changed
dotnet/src/VectorData/CosmosMongoDB/CosmosMongoDB.csprojdotnet/src/VectorData/CosmosMongoDB/CosmosMongoVectorStore.csdotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollection.csdotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionCreateMapping.csdotnet/src/VectorData/CosmosMongoDB/CosmosMongoCollectionSearchMapping.csdotnet/src/VectorData/CosmosMongoDB/CosmosMongoServiceCollectionExtensions.cspython/semantic_kernel/connectors/memory_stores/azure_cosmosdb/azure_cosmos_db_memory_store.pypython/semantic_kernel/connectors/memory_stores/azure_cosmosdb/mongo_vcore_store_api.py