Repository navigation
Python: Correct Azure AI Search sample setup instructions - #9520
Open
LI (ktz03) wants to merge 1 commit into
Open
LI (ktz03) wants to merge 1 commit into
LI (ktz03) wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only corrections match the existing implementation and samples, with no unresolved findings.
No open issues 🎉
What changed in this PR
Corrects Azure AI Search sample documentation to match the existing provider API and shipped examples. No runtime behavior changes.
Changes:
- Separates existing Knowledge Base and index-backed agentic setup.
- Corrects parameter names, defaults, authentication guidance, and sample commands.
- Fixes the semantic sample reference in the agentic sample’s explanatory text.
| File | Description |
|---|---|
python/samples/02-agents/context_providers/azure_ai_search/search_context_agentic.py |
Corrects a filename reference in explanatory text. |
python/samples/02-agents/context_providers/azure_ai_search/README.md |
Aligns setup instructions and examples with the current API. |
Review effort: Balanced
This branch was successfully deployed
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.
Motivation & Context
The Azure AI Search sample guide combines mutually exclusive
index_nameandknowledge_base_namearguments in its agentic example, which raisesSettingNotFoundErrorduring construction. It also lists obsolete script names and constructor options.Description & Review Guide
SettingNotFoundError; documented argument names now match the current constructor. Ruff checks and source compilation pass on Windows with cached Azure Search SDK 12.0.0. No full sample, cloud retrieval, model, authentication, preview SDK, package build or full-suite run was performed.AzureAISearchContextProvider, and the documented commands name files that exist.Related Issue
N/A - trivial change. These are obvious documentation corrections to match existing public constructors and shipped sample names. Existing Knowledge Base support was added in #2464; this change preserves that behavior and the initialization/sample work in #5021 and #2369.
AI Assistance
AI assistance details: Documentation, example verification, and this PR description.
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.