Skip to content

Commit d0352eb

Browse files
Meghana-PalaparthiMeghana-Palaparthi
authored
[VectorIndexPath]: Refactors IndexingSearchListSize and VectorIndexShardKey access levels for GA Contract (#5462)
## Description Make `IndexingSearchListSize` and `VectorIndexShardKey` parameters in `VectorIndexPath` as public for GA contract. ## Type of change Please delete options that are not relevant. - [] Bug fix (non-breaking change which fixes an issue) - [] New feature (non-breaking change which adds functionality) - [] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [] This change requires a documentation update ## Closing issues To automatically close an issue: closes #4840
1 parent 6dbd53c commit d0352eb

3 files changed

Lines changed: 40 additions & 50 deletions

File tree

‎Microsoft.Azure.Cosmos/src/Resource/Settings/VectorIndexPath.cs‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,7 @@ int QuantizationByteSize
9191
/// The allowed range for this parameter is between 25 and 500.
9292
/// </summary>
9393
[JsonIgnore]
94-
#if PREVIEW
95-
public
96-
#else
97-
internal
98-
#endif
99-
int IndexingSearchListSize
94+
public int IndexingSearchListSize
10095
{
10196
get => this.indexingSearchListSizeInternal == null ? 0 : this.indexingSearchListSizeInternal.Value;
10297
set => this.indexingSearchListSizeInternal = value;
@@ -106,12 +101,7 @@ int IndexingSearchListSize
106101
/// Gets or sets the vector index shard key for the vector index path. This is only applicable for the quantizedFlat and diskann vector index types.
107102
/// </summary>
108103
[JsonProperty(PropertyName = "vectorIndexShardKey", NullValueHandling = NullValueHandling.Ignore)]
109-
#if PREVIEW
110-
public
111-
#else
112-
internal
113-
#endif
114-
string[] VectorIndexShardKey { get; set; }
104+
public string[] VectorIndexShardKey { get; set; }
115105

116106
/// <summary>
117107
/// This contains additional values for scenarios where the SDK is not aware of new fields.

‎Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/Contracts/DotNetPreviewSDKAPI.net6.json‎

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1354,60 +1354,22 @@
13541354
"Microsoft.Azure.Cosmos.VectorIndexPath;System.Object;IsAbstract:False;IsSealed:True;IsInterface:False;IsEnum:False;IsClass:True;IsValueType:False;IsNested:False;IsGenericType:False;IsSerializable:False": {
13551355
"Subclasses": {},
13561356
"Members": {
1357-
"Int32 get_IndexingSearchListSize()": {
1358-
"Type": "Method",
1359-
"Attributes": [],
1360-
"MethodInfo": "Int32 get_IndexingSearchListSize();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1361-
},
13621357
"Int32 get_QuantizationByteSize()": {
13631358
"Type": "Method",
13641359
"Attributes": [],
13651360
"MethodInfo": "Int32 get_QuantizationByteSize();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13661361
},
1367-
"Int32 IndexingSearchListSize[Newtonsoft.Json.JsonIgnoreAttribute()]": {
1368-
"Type": "Property",
1369-
"Attributes": [
1370-
"JsonIgnoreAttribute"
1371-
],
1372-
"MethodInfo": "Int32 IndexingSearchListSize;CanRead:True;CanWrite:True;Int32 get_IndexingSearchListSize();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_IndexingSearchListSize(Int32);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1373-
},
13741362
"Int32 QuantizationByteSize[Newtonsoft.Json.JsonIgnoreAttribute()]": {
13751363
"Type": "Property",
13761364
"Attributes": [
13771365
"JsonIgnoreAttribute"
13781366
],
13791367
"MethodInfo": "Int32 QuantizationByteSize;CanRead:True;CanWrite:True;Int32 get_QuantizationByteSize();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_QuantizationByteSize(Int32);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13801368
},
1381-
"System.String[] get_VectorIndexShardKey()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
1382-
"Type": "Method",
1383-
"Attributes": [
1384-
"CompilerGeneratedAttribute"
1385-
],
1386-
"MethodInfo": "System.String[] get_VectorIndexShardKey();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1387-
},
1388-
"System.String[] VectorIndexShardKey[Newtonsoft.Json.JsonPropertyAttribute(NullValueHandling = NullValueHandling.Ignore = 1, PropertyName = \"vectorIndexShardKey\")]": {
1389-
"Type": "Property",
1390-
"Attributes": [
1391-
"JsonPropertyAttribute"
1392-
],
1393-
"MethodInfo": "System.String[] VectorIndexShardKey;CanRead:True;CanWrite:True;System.String[] get_VectorIndexShardKey();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_VectorIndexShardKey(System.String[]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1394-
},
1395-
"Void set_IndexingSearchListSize(Int32)": {
1396-
"Type": "Method",
1397-
"Attributes": [],
1398-
"MethodInfo": "Void set_IndexingSearchListSize(Int32);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1399-
},
14001369
"Void set_QuantizationByteSize(Int32)": {
14011370
"Type": "Method",
14021371
"Attributes": [],
14031372
"MethodInfo": "Void set_QuantizationByteSize(Int32);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1404-
},
1405-
"Void set_VectorIndexShardKey(System.String[])[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
1406-
"Type": "Method",
1407-
"Attributes": [
1408-
"CompilerGeneratedAttribute"
1409-
],
1410-
"MethodInfo": "Void set_VectorIndexShardKey(System.String[]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
14111373
}
14121374
},
14131375
"NestedTypes": {}

‎Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/Contracts/DotNetSDKAPI.net6.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13117,6 +13117,18 @@
1311713117
"Microsoft.Azure.Cosmos.VectorIndexPath;System.Object;IsAbstract:False;IsSealed:True;IsInterface:False;IsEnum:False;IsClass:True;IsValueType:False;IsNested:False;IsGenericType:False;IsSerializable:False": {
1311813118
"Subclasses": {},
1311913119
"Members": {
13120+
"Int32 get_IndexingSearchListSize()": {
13121+
"Type": "Method",
13122+
"Attributes": [],
13123+
"MethodInfo": "Int32 get_IndexingSearchListSize();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13124+
},
13125+
"Int32 IndexingSearchListSize[Newtonsoft.Json.JsonIgnoreAttribute()]": {
13126+
"Type": "Property",
13127+
"Attributes": [
13128+
"JsonIgnoreAttribute"
13129+
],
13130+
"MethodInfo": "Int32 IndexingSearchListSize;CanRead:True;CanWrite:True;Int32 get_IndexingSearchListSize();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_IndexingSearchListSize(Int32);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13131+
},
1312013132
"Microsoft.Azure.Cosmos.VectorIndexType get_Type()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
1312113133
"Type": "Method",
1312213134
"Attributes": [
@@ -13146,11 +13158,30 @@
1314613158
],
1314713159
"MethodInfo": "System.String Path;CanRead:True;CanWrite:True;System.String get_Path();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_Path(System.String);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1314813160
},
13161+
"System.String[] get_VectorIndexShardKey()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
13162+
"Type": "Method",
13163+
"Attributes": [
13164+
"CompilerGeneratedAttribute"
13165+
],
13166+
"MethodInfo": "System.String[] get_VectorIndexShardKey();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13167+
},
13168+
"System.String[] VectorIndexShardKey[Newtonsoft.Json.JsonPropertyAttribute(NullValueHandling = NullValueHandling.Ignore = 1, PropertyName = \"vectorIndexShardKey\")]": {
13169+
"Type": "Property",
13170+
"Attributes": [
13171+
"JsonPropertyAttribute"
13172+
],
13173+
"MethodInfo": "System.String[] VectorIndexShardKey;CanRead:True;CanWrite:True;System.String[] get_VectorIndexShardKey();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_VectorIndexShardKey(System.String[]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13174+
},
1314913175
"Void .ctor()": {
1315013176
"Type": "Constructor",
1315113177
"Attributes": [],
1315213178
"MethodInfo": "Void .ctor()"
1315313179
},
13180+
"Void set_IndexingSearchListSize(Int32)": {
13181+
"Type": "Method",
13182+
"Attributes": [],
13183+
"MethodInfo": "Void set_IndexingSearchListSize(Int32);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13184+
},
1315413185
"Void set_Path(System.String)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
1315513186
"Type": "Method",
1315613187
"Attributes": [
@@ -13164,6 +13195,13 @@
1316413195
"CompilerGeneratedAttribute"
1316513196
],
1316613197
"MethodInfo": "Void set_Type(Microsoft.Azure.Cosmos.VectorIndexType);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
13198+
},
13199+
"Void set_VectorIndexShardKey(System.String[])[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
13200+
"Type": "Method",
13201+
"Attributes": [
13202+
"CompilerGeneratedAttribute"
13203+
],
13204+
"MethodInfo": "Void set_VectorIndexShardKey(System.String[]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
1316713205
}
1316813206
},
1316913207
"NestedTypes": {}

0 commit comments

Comments
 (0)