[Search] azure-search-documents 12.1.0b1 preview release for API version 2026-05-01-preview#46933
Open
hizixin wants to merge 5 commits into
Open
[Search] azure-search-documents 12.1.0b1 preview release for API version 2026-05-01-preview#46933hizixin wants to merge 5 commits into
hizixin wants to merge 5 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Prepares azure-search-documents for the 12.1.0b1 preview release targeting API version 2026-05-01-preview, updating default API versions, adding new/updated preview surfaces (including search query/debug features and indexer operations), and expanding test coverage with preview-gated capability checks.
Changes:
- Bump package version to
12.1.0b1and update defaults/metadata to2026-05-01-preview. - Add/extend preview API surfaces across Search, Indexes, and KnowledgeBases clients (sync + async), plus generated API-version validation.
- Add capability-gated unit tests and update internal testing/release reference docs.
Reviewed changes
Copilot reviewed 81 out of 82 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/search/azure-search-documents/tsp-location.yaml | Update spec commit pointer |
| sdk/search/azure-search-documents/tests/test_search_indexing_buffered_sender.py | Reformat buffered sender tests |
| sdk/search/azure-search-documents/tests/test_search_indexing_buffered_sender_live.py | Reformat live buffered sender test |
| sdk/search/azure-search-documents/tests/test_search_indexing_buffered_sender_async.py | Reformat async buffered sender tests |
| sdk/search/azure-search-documents/tests/test_search_indexer_models.py | Add pylint disables for test file |
| sdk/search/azure-search-documents/tests/test_search_indexer_client.py | New unit tests for preview indexer ops |
| sdk/search/azure-search-documents/tests/test_search_indexer_client_data_sources_live.py | Reformat live data sources assertions |
| sdk/search/azure-search-documents/tests/test_search_indexer_client_data_sources_live_async.py | Reformat async live loop formatting |
| sdk/search/azure-search-documents/tests/test_search_indexer_client_async.py | New async unit tests for preview indexer ops |
| sdk/search/azure-search-documents/tests/test_search_index_model.py | Expand docstring for preview gating |
| sdk/search/azure-search-documents/tests/test_search_index_client.py | New unit tests for index list paging kwargs |
| sdk/search/azure-search-documents/tests/test_search_index_client_synonym_maps_live_async.py | Reformat async synonym map tests |
| sdk/search/azure-search-documents/tests/test_search_index_client_knowledge_base_configurations_live.py | Reformat knowledge base live test signature |
| sdk/search/azure-search-documents/tests/test_search_index_client_indexes_live_async.py | Reformat async index live test |
| sdk/search/azure-search-documents/tests/test_search_index_client_async.py | New async unit tests for index paging kwargs |
| sdk/search/azure-search-documents/tests/test_search_client.py | Add preview-gated search parameter/debug tests |
| sdk/search/azure-search-documents/tests/test_search_client_search_live.py | Reformat live search paging assertion |
| sdk/search/azure-search-documents/tests/test_search_client_search_live_async.py | Reformat async live search assertions/calls |
| sdk/search/azure-search-documents/tests/test_search_client_index_documents_live.py | Reformat live indexing calls |
| sdk/search/azure-search-documents/tests/test_search_client_index_documents_live_async.py | Reformat async live indexing calls |
| sdk/search/azure-search-documents/tests/test_search_client_async.py | Add async preview-gated search/debug tests |
| sdk/search/azure-search-documents/tests/test_knowledge_base_retrieval_client.py | New unit test for KB audience translation |
| sdk/search/azure-search-documents/tests/test_knowledge_base_retrieval_client_async.py | New async unit test for KB audience translation |
| sdk/search/azure-search-documents/tests/_search_helpers.py | Reformat helper builders/utilities |
| sdk/search/azure-search-documents/tests/_search_helpers_async.py | Reformat async helper utilities |
| sdk/search/azure-search-documents/tests/_capabilities.py | Add capability gating registry/logic |
| sdk/search/azure-search-documents/search/models/_patch.py | New generated patch hook (search.models) |
| sdk/search/azure-search-documents/search/models/_models.py | New generated model (search.models) |
| sdk/search/azure-search-documents/search/models/_enums.py | New generated enum (search.models) |
| sdk/search/azure-search-documents/search/models/init.py | New generated exports (search.models) |
| sdk/search/azure-search-documents/search/init.py | New top-level search namespace package |
| sdk/search/azure-search-documents/sdk_packaging.toml | Remove legacy packaging config |
| sdk/search/azure-search-documents/pyproject.toml | Mark as Beta; add packaging section |
| sdk/search/azure-search-documents/mypy.ini | Adjust mypy settings for validation module |
| sdk/search/azure-search-documents/CHANGELOG.md | Add 12.1.0b1 entry and default API note |
| sdk/search/azure-search-documents/azure/search/documents/models/_patch.py | Reorder imports in models patch |
| sdk/search/azure-search-documents/azure/search/documents/models/_enums.py | Add new query/hybrid/vector enums |
| sdk/search/azure-search-documents/azure/search/documents/models/init.py | Export new models/enums publicly |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/_enums.py | Add KB enums for new preview features |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/models/init.py | Export new KB models/enums publicly |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_patch.py | Update KB aio patch docs/default version |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_operations/_operations.py | Add api version validation + new header param |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_configuration.py | Default KB aio api version update |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_client.py | Update KB aio client docs |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_utils/model_base.py | Minor generated model_base cleanup |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_patch.py | Update KB patch docs/default version |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_operations/_operations.py | Add validation + new header param |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_configuration.py | Default KB api version update |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_client.py | Update KB client docs |
| sdk/search/azure-search-documents/azure/search/documents/indexes/models/_enums.py | Add many new indexer/skill enums |
| sdk/search/azure-search-documents/azure/search/documents/indexes/models/init.py | Export new indexer/skill models/enums |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_patch.py | Update indexes aio patch docs/default |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_operations/_patch.py | Add new paging kwargs + indexer ops |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_configuration.py | Default indexes aio api version update |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_client.py | Update indexes aio client docs |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_utils/model_base.py | Minor generated model_base cleanup |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_patch.py | Update indexes patch docs/default |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_patch.py | Add new paging kwargs + indexer ops |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_configuration.py | Default indexes api version update |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_client.py | Update indexes client docs |
| sdk/search/azure-search-documents/azure/search/documents/aio/_patch.py | Update SearchClient aio patch docs/default |
| sdk/search/azure-search-documents/azure/search/documents/aio/_operations/_patch.py | Add new search kwargs + debug accessor |
| sdk/search/azure-search-documents/azure/search/documents/aio/_operations/_operations.py | Add validation + new query/header params |
| sdk/search/azure-search-documents/azure/search/documents/aio/_configuration.py | Default SearchClient aio api version update |
| sdk/search/azure-search-documents/azure/search/documents/aio/_client.py | Update SearchClient aio client docs |
| sdk/search/azure-search-documents/azure/search/documents/_version.py | Bump version constant |
| sdk/search/azure-search-documents/azure/search/documents/_validation.py | Add generated API-version validation decorator |
| sdk/search/azure-search-documents/azure/search/documents/_utils/model_base.py | Minor generated model_base cleanup |
| sdk/search/azure-search-documents/azure/search/documents/_patch.py | Add preview ApiVersion; update default |
| sdk/search/azure-search-documents/azure/search/documents/_operations/_patch.py | Add new search kwargs + debug accessor |
| sdk/search/azure-search-documents/azure/search/documents/_operations/_operations.py | Add validation + new query/header params |
| sdk/search/azure-search-documents/azure/search/documents/_configuration.py | Default SearchClient api version update |
| sdk/search/azure-search-documents/azure/search/documents/_client.py | Update SearchClient client docs |
| sdk/search/azure-search-documents/apiview-properties.json | Map new/updated public API symbols |
| sdk/search/azure-search-documents/.github/skills/azure-search-documents/references/testing.md | Update test conventions + preview gating |
| sdk/search/azure-search-documents/.github/skills/azure-search-documents/references/release.md | Update changelog drafting conventions |
| sdk/search/azure-search-documents/_metadata.json | Update apiVersion metadata |
Comment on lines
+10
to
+18
| from typing import Any, Mapping, Optional, overload | ||
|
|
||
| from ...azure.search.documents._utils.model_base import Model as _Model, rest_field | ||
|
|
||
|
|
||
| class SharePointConnectorAppRegistration(_Model): | ||
| """Configures a SharePoint connector app registration for the index, enabling document-level | ||
| permissions from SharePoint. | ||
|
|
| "azure.search.documents.indexes.models.SentimentSkillV3": "Search.SentimentSkillV3", | ||
| "azure.search.documents.indexes.models.ServiceIndexersRuntime": "Search.ServiceIndexersRuntime", | ||
| "azure.search.documents.indexes.models.ShaperSkill": "Search.ShaperSkill", | ||
| "search.models.SharePointConnectorAppRegistration": "Search.SharePointConnectorAppRegistration", |
Comment on lines
+40
to
+44
| if _index_with_default(method_added_on) > _index_with_default(client_api_version): | ||
| raise ValueError( | ||
| f"'{func.__name__}' is not available in API version " | ||
| f"{client_api_version}. Pass service API version {method_added_on} or newer to your client." | ||
| ) |
Comment on lines
+355
to
+361
| def get_debug_info(self) -> _models.DebugInfo: | ||
| """Return the debug information for the query. | ||
|
|
||
| :return: the debug information for the query | ||
| :rtype: ~azure.search.documents.models.DebugInfo | ||
| """ | ||
| return cast(_models.DebugInfo, self._first_iterator_instance().get_debug_info()) |
Comment on lines
+172
to
+178
| async def get_debug_info(self) -> _models.DebugInfo: | ||
| """Return the debug information for the query. | ||
|
|
||
| :return: the debug information for the query | ||
| :rtype: ~azure.search.documents.models.DebugInfo | ||
| """ | ||
| return cast(_models.DebugInfo, await self._first_iterator_instance().get_debug_info()) |
Comment on lines
+3
to
+16
| ## 12.1.0b1 | ||
|
|
||
| ### Features Added | ||
|
|
||
| ### Breaking Changes | ||
| - Below enum members are added for API version support | ||
| - `azure.search.documents.ApiVersion.V2026_05_01_PREVIEW` | ||
|
|
||
| ### Bugs Fixed | ||
| - Below properties are added for service counters | ||
| - `azure.search.documents.indexes.models.SearchServiceCounters.knowledge_base_counter` | ||
| - `azure.search.documents.indexes.models.SearchServiceCounters.knowledge_source_counter` | ||
|
|
||
| ### Other Changes | ||
|
|
||
| - Updated default API version to `2026-05-01-preview`. |
| @@ -1,3 +1,4 @@ | |||
| # pylint: disable=line-too-long,useless-suppression | |||
Comment on lines
+61
to
64
| :keyword api_version: The API version to use for this operation. Known values are | ||
| "2026-05-01-preview" and None. Default value is "2026-05-01-preview". Note that overriding this | ||
| default value may result in unsupported behavior. | ||
| :paramtype api_version: str |
Comment on lines
67
to
+71
| [tool.azure-sdk-conda] | ||
| in_bundle = false | ||
|
|
||
| [packaging] | ||
| auto_update = false |
Comment on lines
+28
to
+36
| def _empty_async_pager(*_args, **_kwargs): | ||
| pager = mock.MagicMock(spec=AsyncItemPaged) | ||
|
|
||
| async def _aiter(): | ||
| for _ in (): | ||
| yield _ | ||
|
|
||
| pager.__aiter__ = lambda self: _aiter() | ||
| return pager |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…meters Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
hizixin
force-pushed
the
search/2026-05-01-preview
branch
from
3354f99 to
d38dd3c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines