Skip to content

Commit 2050ec6

Browse files
xiangyan99xiangyan99
authored
Update API versions (Azure#39927)
* renamed AIStudioModelCatalogName to AIFoundryModelCatalogName * update * Update API version * update * update * update changelog
1 parent 656b89f commit 2050ec6

29 files changed

+456
-94
lines changed

‎sdk/search/azure-search-documents/CHANGELOG.md‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# Release History
22

3-
## 11.6.0b10 (Unreleased)
3+
## 11.6.0b10 (2025-03-11)
44

55
### Features Added
66

7+
- Added `SearchIndexClient.list_index_stats_summary`.
8+
- Added `SearchIndexerCache.id`.
9+
- Added new model `azure.search.documents.indexes.models.IndexStatisticsSummary`.
10+
711
### Breaking Changes
812

9-
### Bugs Fixed
13+
> These changes do not impact the API of stable versions such as 11.5.0.
14+
> Only code written against a beta version such as 11.6.0b9 may be affected.
15+
- Renamed `azure.search.documents.indexes.models.AIStudioModelCatalogName` to `azure.search.documents.indexes.models.AIFoundryModelCatalogName`.
1016

1117
### Other Changes
1218

19+
- Updated the API version to "2025-03-01-preview"
20+
1321
## 11.6.0b9 (2025-01-14)
1422

1523
### Bugs Fixed
@@ -79,6 +87,11 @@
7987
### Other Changes
8088

8189
- Updated the API version to "2024-09-01-preview"
90+
91+
### Breaking changes
92+
93+
> These changes do not impact the API of stable versions such as 11.5.0.
94+
> Only code written against a beta version such as 11.6.0b4 may be affected.
8295
- Below models were renamed
8396
- `azure.search.documents.indexes.models.SearchIndexerIndexProjections` -> `azure.search.documents.indexes.models.SearchIndexerIndexProjection`
8497
- `azure.search.documents.indexes.models.LineEnding` -> `azure.search.documents.indexes.models.OrcLineEnding`

‎sdk/search/azure-search-documents/assets.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
"AssetsRepo": "Azure/azure-sdk-assets",
33
"AssetsRepoPrefixPath": "python",
44
"TagPrefix": "python/search/azure-search-documents",
5-
"Tag": "python/search/azure-search-documents_f24a21be28"
5+
"Tag": "python/search/azure-search-documents_687dda5785"
66
}

‎sdk/search/azure-search-documents/azure/search/documents/_api_versions.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta):
1111
V2020_06_30 = "2020-06-30"
1212
V2023_11_01 = "2023-11-01"
1313
V2024_07_01 = "2024-07-01"
14-
V2024_11_01_PREVIEW = "2024-11-01-preview"
14+
V2025_03_01_PREVIEW = "2025-03-01-preview"
1515

1616

17-
DEFAULT_VERSION = ApiVersion.V2024_11_01_PREVIEW
17+
DEFAULT_VERSION = ApiVersion.V2025_03_01_PREVIEW

‎sdk/search/azure-search-documents/azure/search/documents/_generated/_configuration.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ class SearchIndexClientConfiguration: # pylint: disable=too-many-instance-attri
2121
:type endpoint: str
2222
:param index_name: The name of the index. Required.
2323
:type index_name: str
24-
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
24+
:keyword api_version: Api Version. Default value is "2025-03-01-preview". Note that overriding
2525
this default value may result in unsupported behavior.
2626
:paramtype api_version: str
2727
"""
2828

2929
def __init__(self, endpoint: str, index_name: str, **kwargs: Any) -> None:
30-
api_version: str = kwargs.pop("api_version", "2024-11-01-preview")
30+
api_version: str = kwargs.pop("api_version", "2025-03-01-preview")
3131

3232
if endpoint is None:
3333
raise ValueError("Parameter 'endpoint' must not be None.")

‎sdk/search/azure-search-documents/azure/search/documents/_generated/_search_index_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class SearchIndexClient:
2727
:type endpoint: str
2828
:param index_name: The name of the index. Required.
2929
:type index_name: str
30-
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
30+
:keyword api_version: Api Version. Default value is "2025-03-01-preview". Note that overriding
3131
this default value may result in unsupported behavior.
3232
:paramtype api_version: str
3333
"""

‎sdk/search/azure-search-documents/azure/search/documents/_generated/aio/_configuration.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ class SearchIndexClientConfiguration: # pylint: disable=too-many-instance-attri
2121
:type endpoint: str
2222
:param index_name: The name of the index. Required.
2323
:type index_name: str
24-
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
24+
:keyword api_version: Api Version. Default value is "2025-03-01-preview". Note that overriding
2525
this default value may result in unsupported behavior.
2626
:paramtype api_version: str
2727
"""
2828

2929
def __init__(self, endpoint: str, index_name: str, **kwargs: Any) -> None:
30-
api_version: str = kwargs.pop("api_version", "2024-11-01-preview")
30+
api_version: str = kwargs.pop("api_version", "2025-03-01-preview")
3131

3232
if endpoint is None:
3333
raise ValueError("Parameter 'endpoint' must not be None.")

‎sdk/search/azure-search-documents/azure/search/documents/_generated/aio/_search_index_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class SearchIndexClient:
2727
:type endpoint: str
2828
:param index_name: The name of the index. Required.
2929
:type index_name: str
30-
:keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
30+
:keyword api_version: Api Version. Default value is "2025-03-01-preview". Note that overriding
3131
this default value may result in unsupported behavior.
3232
:paramtype api_version: str
3333
"""

‎sdk/search/azure-search-documents/azure/search/documents/_generated/models/_models_py3.py‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -458,6 +458,8 @@ class FacetResult(_serialization.Model):
458458
:ivar count: The approximate count of documents falling within the bucket described by this
459459
facet.
460460
:vartype count: int
461+
:ivar sum: The resulting total sum for the facet when a sum metric is requested.
462+
:vartype sum: float
461463
:ivar facets: The nested facet query results for the search operation, organized as a
462464
collection of buckets for each faceted field; null if the query did not contain any nested
463465
facets.
@@ -466,12 +468,14 @@ class FacetResult(_serialization.Model):
466468

467469
_validation = {
468470
"count": {"readonly": True},
471+
"sum": {"readonly": True},
469472
"facets": {"readonly": True},
470473
}
471474

472475
_attribute_map = {
473476
"additional_properties": {"key": "", "type": "{object}"},
474477
"count": {"key": "count", "type": "int"},
478+
"sum": {"key": "sum", "type": "float"},
475479
"facets": {"key": "@search\\.facets", "type": "{[FacetResult]}"},
476480
}
477481

@@ -484,6 +488,7 @@ def __init__(self, *, additional_properties: Optional[Dict[str, Any]] = None, **
484488
super().__init__(**kwargs)
485489
self.additional_properties = additional_properties
486490
self.count: Optional[int] = None
491+
self.sum: Optional[float] = None
487492
self.facets: Optional[Dict[str, List["_models.FacetResult"]]] = None
488493

489494

@@ -956,8 +961,8 @@ class SearchDocumentsResult(_serialization.Model):
956961
:ivar answers: The answers query results for the search operation; null if the answers query
957962
parameter was not specified or set to 'none'.
958963
:vartype answers: list[~azure.search.documents.models.QueryAnswerResult]
959-
:ivar debug: Debug information that applies to the search results as a whole.
960-
:vartype debug: ~azure.search.documents.models.DebugInfo
964+
:ivar debug_info: Debug information that applies to the search results as a whole.
965+
:vartype debug_info: ~azure.search.documents.models.DebugInfo
961966
:ivar next_page_parameters: Continuation JSON payload returned when the query can't return all
962967
the requested results in a single response. You can use this JSON along with @odata.nextLink to
963968
formulate another POST Search request to get the next part of the search response.
@@ -989,7 +994,7 @@ class SearchDocumentsResult(_serialization.Model):
989994
"coverage": {"readonly": True},
990995
"facets": {"readonly": True},
991996
"answers": {"readonly": True},
992-
"debug": {"readonly": True},
997+
"debug_info": {"readonly": True},
993998
"next_page_parameters": {"readonly": True},
994999
"results": {"required": True, "readonly": True},
9951000
"next_link": {"readonly": True},
@@ -1003,7 +1008,7 @@ class SearchDocumentsResult(_serialization.Model):
10031008
"coverage": {"key": "@search\\.coverage", "type": "float"},
10041009
"facets": {"key": "@search\\.facets", "type": "{[FacetResult]}"},
10051010
"answers": {"key": "@search\\.answers", "type": "[QueryAnswerResult]"},
1006-
"debug": {"key": "@search\\.debug", "type": "DebugInfo"},
1011+
"debug_info": {"key": "@search\\.debug", "type": "DebugInfo"},
10071012
"next_page_parameters": {"key": "@search\\.nextPageParameters", "type": "SearchRequest"},
10081013
"results": {"key": "value", "type": "[SearchResult]"},
10091014
"next_link": {"key": "@odata\\.nextLink", "type": "str"},
@@ -1019,7 +1024,7 @@ def __init__(self, **kwargs: Any) -> None:
10191024
self.coverage: Optional[float] = None
10201025
self.facets: Optional[Dict[str, List["_models.FacetResult"]]] = None
10211026
self.answers: Optional[List["_models.QueryAnswerResult"]] = None
1022-
self.debug: Optional["_models.DebugInfo"] = None
1027+
self.debug_info: Optional["_models.DebugInfo"] = None
10231028
self.next_page_parameters: Optional["_models.SearchRequest"] = None
10241029
self.results: Optional[List["_models.SearchResult"]] = None
10251030
self.next_link: Optional[str] = None

‎sdk/search/azure-search-documents/azure/search/documents/_generated/operations/_documents_operations.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def build_count_request(*, x_ms_client_request_id: Optional[str] = None, **kwarg
4141
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
4242
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
4343

44-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
44+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
4545
accept = _headers.pop("Accept", "application/json")
4646

4747
# Construct URL
@@ -96,7 +96,7 @@ def build_search_get_request(
9696
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
9797
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
9898

99-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
99+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
100100
accept = _headers.pop("Accept", "application/json")
101101

102102
# Construct URL
@@ -181,7 +181,7 @@ def build_search_post_request(*, x_ms_client_request_id: Optional[str] = None, *
181181
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
182182
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
183183

184-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
184+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
185185
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
186186
accept = _headers.pop("Accept", "application/json")
187187

@@ -211,7 +211,7 @@ def build_get_request(
211211
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
212212
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
213213

214-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
214+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
215215
accept = _headers.pop("Accept", "application/json")
216216

217217
# Construct URL
@@ -254,7 +254,7 @@ def build_suggest_get_request(
254254
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
255255
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
256256

257-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
257+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
258258
accept = _headers.pop("Accept", "application/json")
259259

260260
# Construct URL
@@ -295,7 +295,7 @@ def build_suggest_post_request(*, x_ms_client_request_id: Optional[str] = None,
295295
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
296296
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
297297

298-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
298+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
299299
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
300300
accept = _headers.pop("Accept", "application/json")
301301

@@ -319,7 +319,7 @@ def build_index_request(*, x_ms_client_request_id: Optional[str] = None, **kwarg
319319
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
320320
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
321321

322-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
322+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
323323
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
324324
accept = _headers.pop("Accept", "application/json")
325325

@@ -357,7 +357,7 @@ def build_autocomplete_get_request(
357357
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
358358
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
359359

360-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
360+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
361361
accept = _headers.pop("Accept", "application/json")
362362

363363
# Construct URL
@@ -396,7 +396,7 @@ def build_autocomplete_post_request(*, x_ms_client_request_id: Optional[str] = N
396396
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
397397
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
398398

399-
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2024-11-01-preview"))
399+
api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-03-01-preview"))
400400
content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
401401
accept = _headers.pop("Accept", "application/json")
402402

‎sdk/search/azure-search-documents/azure/search/documents/_paging.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,4 +178,4 @@ def get_answers(self) -> Optional[List[QueryAnswerResult]]:
178178
def get_debug_info(self) -> DebugInfo:
179179
self.continuation_token = None
180180
response = cast(SearchDocumentsResult, self._response)
181-
return cast(DebugInfo, response.debug)
181+
return cast(DebugInfo, response.debug_info)

0 commit comments

Comments
 (0)