VectorIndex Policy[No Release]: Adds Support for QuantizerType in IndexingPolicy by aavasthy · Pull Request #5502 · Azure/azure-cosmos-dotnet-v3

aavasthy · 2025-11-17T23:02:04Z

Pull Request Template

Description

Updated direct package version as this PR needed some code references from shared files.
Add a new field "quantizerType": "product/spherical" to vector index definition in indexing policy.

Example:

    "vectorIndexes": [
      {
        "path": "/vector1",
        "type": "diskANN",
        "quantizerType": "product"
        "quantizationByteSize": 4,
        "indexingSearchListSize": 50
      }
    ],

Type of change

Testing against a live account that has Vector Search for NoSQL API feature enabled:

Ran e2e test and created a container with

      Collection<Cosmos.VectorIndexPath> vectorIndexes = new Collection<Cosmos.VectorIndexPath>
{
   new Cosmos.VectorIndexPath
   {
       Path = "/embedding",
           Type = Cosmos.VectorIndexType.DiskANN,
       QuantizerType = Cosmos.QuantizerType.Product
   }
};
       properties.IndexingPolicy.VectorIndexes = vectorIndexes;

Checked in portal and it has the quantizer type value getting reflected as product:

And checked with quantizer type as Spherical

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)

Closing issues

To automatically close an issue: closes #IssueNumber

kundadebdatta · 2025-12-08T13:14:26Z

Can you add the tracking item for this @aavasthy ?

kundadebdatta

LGTM. Please mention the tracking item for this ASK.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

## Version Changes | Property | Old | New | |---|---|---| | `ClientOfficialVersion` | 3.57.0 | **3.58.0** | | `ClientPreviewVersion` | 3.58.0 | **3.59.0** | | `ClientPreviewSuffixVersion` | preview.0 | **preview.0** | ## Changelog ### 3.59.0-preview.0 (Preview) #### Added - [#5502](#5502) VectorIndex Policy: Adds Support for QuantizerType in IndexingPolicy - [#5634](#5634) Semantic Reranking: Adds response body in semantic reranking error responses - [#5685](#5685) Read Consistency Strategy: Adds Read Consistency Strategy option for read requests ### 3.58.0 (GA) #### Added - [#5447](#5447) Per Partition Automatic Failover: Adds Hub Region Processing Only While Routing Requests Failed with 404/1002 for single master accounts - [#5551](#5551) HPK: Adds internal CosmosClientOptions flag UseLengthAwareRangeComparer for length aware range comparer rollout - [#5582](#5582) Query: Adds ability to choose global vs local/focused statistics for FullTextScore - [5610](#5610) Refactors N-Region Synchronous Commit feature to use IServiceConfigurationReaderVNext interface. - [#5693](#5693) ThinClient Integration: Adds Enable Multiple Http2 connection on SocketsHttpHandler - [#5614](#5614) ThinClient Integration: Adds support for QueryPlan in thinclient mode #### Fixed - [#5597](#5597) CosmosClient: Fixes ObjectDisposedException message when client is disposed during request - [#5613](#5613) CrossRegionHedgingAvailabilityStrategy: Fixes ArgumentNullException race condition in hedging cancellation - [#5650](#5650) Batch: Fixes null ErrorMessage when promoting status from MultiStatus response - [#5651](#5651) Serializer: Fixes unsafe stream cast in FromStream<T> - [#5697](#5697) ResourceThrottleRetryPolicy: Fixes cumulativeRetryDelay tracking when x-ms-retry-after-ms header is absent ### API Contract Diff (GA) ```diff diff --git "a/Microsoft.Azure.Cosmos\\contracts\\API_3.57.0.txt" "b/Microsoft.Azure.Cosmos\\contracts\\API_3.58.0.txt" index a1fa19e..1b74a69 100644 --- "a/Microsoft.Azure.Cosmos\\contracts\\API_3.57.0.txt" +++ "b/Microsoft.Azure.Cosmos\\contracts\\API_3.58.0.txt" @@ -639,6 +639,11 @@ namespace Microsoft.Azure.Cosmos public string DefaultLanguage { get; set; } public Collection<FullTextPath> FullTextPaths { get; set; } } + public enum FullTextScoreScope + { + Global = 0, + Local = 1, + } public sealed class GeospatialConfig { public GeospatialConfig(); @@ -869,6 +874,7 @@ namespace Microsoft.Azure.Cosmos public Nullable<bool> EnableLowPrecisionOrderBy { get; set; } public bool EnableOptimisticDirectExecution { get; set; } public Nullable<bool> EnableScanInQuery { get; set; } + public FullTextScoreScope FullTextScoreScope { get; set; } public Nullable<int> MaxBufferedItemCount { get; set; } public Nullable<int> MaxConcurrency { get; set; } public Nullable<int> MaxItemCount { get; set; } ``` ### API Contract Diff (Preview) ```diff diff --git "a/Microsoft.Azure.Cosmos\\contracts\\API_3.58.0-preview.0.txt" "b/Microsoft.Azure.Cosmos\\contracts\\API_3.59.0-preview.0.txt" index af57dd8..1ae52c0 100644 --- "a/Microsoft.Azure.Cosmos\\contracts\\API_3.58.0-preview.0.txt" +++ "b/Microsoft.Azure.Cosmos\\contracts\\API_3.59.0-preview.0.txt" @@ -128,6 +128,7 @@ namespace Microsoft.Azure.Cosmos public new string IfMatchEtag { get; set; } public new string IfNoneMatchEtag { get; set; } public Nullable<int> PageSizeHint { get; set; } + public Nullable<ReadConsistencyStrategy> ReadConsistencyStrategy { get; set; } } public abstract class ChangeFeedStartFrom { @@ -414,6 +415,7 @@ namespace Microsoft.Azure.Cosmos public Nullable<TimeSpan> OpenTcpConnectionTimeout { get; set; } public Nullable<PortReuseMode> PortReuseMode { get; set; } public Nullable<PriorityLevel> PriorityLevel { get; set; } + public Nullable<ReadConsistencyStrategy> ReadConsistencyStrategy { get; set; } public TimeSpan RequestTimeout { get; set; } public CosmosSerializer Serializer { get; set; } public CosmosSerializationOptions SerializerOptions { get; set; } @@ -746,6 +748,11 @@ namespace Microsoft.Azure.Cosmos public string DefaultLanguage { get; set; } public Collection<FullTextPath> FullTextPaths { get; set; } } + public enum FullTextScoreScope + { + Global = 0, + Local = 1, + } public sealed class GeospatialConfig { public GeospatialConfig(); @@ -825,6 +832,7 @@ namespace Microsoft.Azure.Cosmos public Nullable<IndexingDirective> IndexingDirective { get; set; } public IEnumerable<string> PostTriggers { get; set; } public IEnumerable<string> PreTriggers { get; set; } + public Nullable<ReadConsistencyStrategy> ReadConsistencyStrategy { get; set; } public string SessionToken { get; set; } } public class ItemResponse<T> : Response<T> @@ -972,6 +980,11 @@ namespace Microsoft.Azure.Cosmos High = 1, Low = 2, } + public enum QuantizerType + { + Product = 0, + Spherical = 1, + } public class QueryDefinition { public QueryDefinition(string query); @@ -988,6 +1001,7 @@ namespace Microsoft.Azure.Cosmos public Nullable<bool> EnableLowPrecisionOrderBy { get; set; } public bool EnableOptimisticDirectExecution { get; set; } public Nullable<bool> EnableScanInQuery { get; set; } + public FullTextScoreScope FullTextScoreScope { get; set; } public Nullable<int> MaxBufferedItemCount { get; set; } public Nullable<int> MaxConcurrency { get; set; } public Nullable<int> MaxItemCount { get; set; } @@ -995,6 +1009,7 @@ namespace Microsoft.Azure.Cosmos public Nullable<bool> PopulateIndexMetrics { get; set; } public Nullable<bool> PopulateQueryAdvice { get; set; } public QueryTextMode QueryTextMode { get; set; } + public Nullable<ReadConsistencyStrategy> ReadConsistencyStrategy { get; set; } public Nullable<int> ResponseContinuationTokenLimitInKb { get; set; } public string SessionToken { get; set; } } @@ -1004,10 +1019,18 @@ namespace Microsoft.Azure.Cosmos None = 0, ParameterizedOnly = 1, } + public enum ReadConsistencyStrategy + { + Eventual = 1, + GlobalStrong = 4, + LatestCommitted = 3, + Session = 2, + } public class ReadManyRequestOptions : RequestOptions { public ReadManyRequestOptions(); public Nullable<ConsistencyLevel> ConsistencyLevel { get; set; } + public Nullable<ReadConsistencyStrategy> ReadConsistencyStrategy { get; set; } public string SessionToken { get; set; } } public static class Regions @@ -1383,6 +1406,7 @@ namespace Microsoft.Azure.Cosmos public int IndexingSearchListSize { get; set; } public string Path { get; set; } public int QuantizationByteSize { get; set; } + public Nullable<QuantizerType> QuantizerType { get; set; } public VectorIndexType Type { get; set; } public string[] VectorIndexShardKey { get; set; } } @@ -1482,6 +1506,7 @@ namespace Microsoft.Azure.Cosmos.Fluent public CosmosClientBuilder WithHttpClientFactory(Func<HttpClient> httpClientFactory); public CosmosClientBuilder WithLimitToEndpoint(bool limitToEndpoint); public CosmosClientBuilder WithPriorityLevel(PriorityLevel priorityLevel); + public CosmosClientBuilder WithReadConsistencyStrategy(ReadConsistencyStrategy readConsistencyStrategy); public CosmosClientBuilder WithRequestTimeout(TimeSpan requestTimeout); public CosmosClientBuilder WithSerializerOptions(CosmosSerializationOptions cosmosSerializerOptions); public CosmosClientBuilder WithSystemTextJsonSerializerOptions(JsonSerializerOptions serializerOptions); @@ -1540,6 +1565,7 @@ namespace Microsoft.Azure.Cosmos.Fluent public VectorIndexDefinition<T> Path(string path, VectorIndexType indexType); public VectorIndexDefinition<T> WithIndexingSearchListSize(int indexingSearchListSize); public VectorIndexDefinition<T> WithQuantizationByteSize(int quantizationByteSize); + public VectorIndexDefinition<T> WithQuantizerType(QuantizerType quantizerType); public VectorIndexDefinition<T> WithVectorIndexShardKey(string[] vectorIndexShardKey); } } ``` ## Checklist - [ ] Changelog review by team - [ ] Email `azurecosmossdkdotnet@microsoft.com` for preview API review - [ ] API contract diff approval (Kiran & Kirill) - [ ] Kiran sign-off (required) - [ ] Determine if "Recommended Version" needs further updating --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add quantizertype to vector index

fef2f31

aavasthy self-assigned this Nov 17, 2025

aavasthy requested review from adityasa, khdang, neildsh and sboshra as code owners November 17, 2025 23:02

aavasthy added this to Azure Cosmos SDKs Nov 17, 2025

aavasthy requested review from FabianMeiswinkel, Pilchie, kirankumarkolli and kirillg as code owners November 17, 2025 23:02

aavasthy added 3 commits November 17, 2025 15:05

Resolve merge conflicts.

f1e50b6

Update reference for QuantizerType

446447e

Fix comments

8a2c3c6

kirankumarkolli reviewed Nov 19, 2025

View reviewed changes

Comment thread Microsoft.Azure.Cosmos/src/Resource/Settings/QuantizerType.cs

aavasthy and others added 2 commits November 19, 2025 07:50

Update contracts file

e789a6c

Merge branch 'master' into users/aavasthy/vector_quantizertype

2120237

kirankumarkolli approved these changes Nov 24, 2025

View reviewed changes

aavasthy added the auto-merge Enables automation to merge PRs label Dec 4, 2025

microsoft-github-policy-service Bot enabled auto-merge (squash) December 4, 2025 17:23

NaluTripician reviewed Dec 4, 2025

View reviewed changes

Comment thread Directory.Build.props

NaluTripician approved these changes Dec 4, 2025

View reviewed changes

Merge branch 'master' into users/aavasthy/vector_quantizertype

88d500c

aavasthy removed the auto-merge Enables automation to merge PRs label Dec 4, 2025

microsoft-github-policy-service Bot disabled auto-merge December 4, 2025 17:42

aavasthy and others added 2 commits December 5, 2025 10:44

Merge branch 'master' into users/aavasthy/vector_quantizertype

b2faa3c

Merge branch 'master' into users/aavasthy/vector_quantizertype

c869bd8

kundadebdatta added auto-merge Enables automation to merge PRs vector-similarity labels Dec 8, 2025

microsoft-github-policy-service Bot enabled auto-merge (squash) December 8, 2025 13:12

kundadebdatta approved these changes Dec 8, 2025

View reviewed changes

microsoft-github-policy-service Bot merged commit dee3eb9 into master Dec 8, 2025
32 checks passed

microsoft-github-policy-service Bot deleted the users/aavasthy/vector_quantizertype branch December 8, 2025 14:27

github-project-automation Bot moved this to Done in Azure Cosmos SDKs Dec 8, 2025

Copilot AI mentioned this pull request Dec 12, 2025

Add vector quantization support (quantizerType) for Cosmos DB vector indexes Azure/azure-sdk-for-js#36871

Open

3 tasks

aavasthy changed the title ~~VectorIndex Policy: Adds Support for QuantizerType in IndexingPolicy~~ VectorIndex Policy[No Release]: Adds Support for QuantizerType in IndexingPolicy Dec 17, 2025

aavasthy added a commit that referenced this pull request Mar 17, 2026

Changelog: Adds PR #5502 (QuantizerType) to 3.59.0-preview.0 changelog

2e31f01

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

This was referenced Mar 17, 2026

Release: Adds version 3.58.0 #5696

Closed

Release: Adds version 3.58.0 #5698

Closed

Copilot AI mentioned this pull request Mar 18, 2026

Release: Adds version 3.58.0 #5700

Closed

4 tasks

aavasthy mentioned this pull request Mar 19, 2026

3.58.0: Adds Version Update and contracts #5717

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

VectorIndex Policy[No Release]: Adds Support for QuantizerType in IndexingPolicy#5502

VectorIndex Policy[No Release]: Adds Support for QuantizerType in IndexingPolicy#5502
microsoft-github-policy-service[bot] merged 9 commits intomasterfrom
users/aavasthy/vector_quantizertype

aavasthy commented Nov 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

kundadebdatta commented Dec 8, 2025

Uh oh!

kundadebdatta left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

aavasthy commented Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Template

Description

Type of change

Closing issues

Uh oh!

Uh oh!

Uh oh!

kundadebdatta commented Dec 8, 2025

Uh oh!

kundadebdatta left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aavasthy commented Nov 17, 2025 •

edited

Loading