fix(search-documents): restore indexes model compat exports#47876
Draft
mattgotteiner wants to merge 4 commits into
Draft
fix(search-documents): restore indexes model compat exports#47876mattgotteiner wants to merge 4 commits into
mattgotteiner wants to merge 4 commits into
Conversation
Restore the preview compatibility exports for KnowledgeRetrievalOutputMode and KnowledgeRetrievalReasoningEffort from azure.search.documents.indexes.models, and add back supported SearchIndex serialize/deserialize round-trip helpers via the package patch layer. Add targeted regression coverage, changelog notes, and the API surface snapshot update. Fixes #47871 Fixes #47872 Fixes #47873 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The isolated CI package test jobs do not expose a top-level tests package, so importing tests._capabilities caused collection-time ModuleNotFoundError across the PR matrix. Use the package-local _capabilities import instead. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Inline the public SearchIndex serialize/deserialize helpers onto SearchIndex instead of a private mixin to avoid the remaining docs/build CI failure while preserving the compatibility surface. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Use docs-safe compatibility wrapper types for KnowledgeRetrievalOutputMode and KnowledgeRetrievalReasoningEffort so Sphinx does not index the same knowledgebases symbols twice, and add the required docstrings for the SearchIndex round-trip helpers. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
Summary
KnowledgeRetrievalOutputModeandKnowledgeRetrievalReasoningEffortas public re-exports fromazure.search.documents.indexes.modelsSearchIndex.serialize()/SearchIndex.deserialize()round-trip helpers through the package patch layerTesting
python -m pytest --noconftest tests/test_search_index_model.py -qFixes #47871
Fixes #47872
Fixes #47873