Python: Updated documentation for Azure AI#2280
Merged
dmytrostruk merged 3 commits intomicrosoft:mainfrom Nov 17, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to clearly differentiate between Azure AI Agent V1 samples (using azure-ai-agents 1.x package with AzureAIAgentClient) and V2 samples (using azure-ai-projects 2.x package with AzureAIClient).
Key changes:
- Added clarifying text to README files explaining the V1/V2 distinction and cross-referencing between sample folders
- Reorganized the main samples README to separate V1 and V2 examples into distinct sections
- Corrected a file path reference error in the samples README
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
python/samples/getting_started/agents/azure_ai_agent/README.md |
Added explanation that this folder contains V1 samples with link to V2 folder |
python/samples/getting_started/agents/azure_ai/README.md |
Added explanation that this folder contains V2 samples with changelog link and reference to V1 folder |
python/samples/getting_started/agents/README.md |
Updated table to clarify V1 and V2 distinction for Azure AI folders |
python/samples/README.md |
Separated Azure AI examples into V1 and V2 sections and fixed incorrect file path |
TaoChenOSU
approved these changes
Nov 17, 2025
eavanvalkenburg
approved these changes
Nov 17, 2025
arisng
pushed a commit
to arisng/agent-framework
that referenced
this pull request
Feb 2, 2026
* Updated documentation for Azure AI * Small fixes
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 and Context
Updated the documentation for Azure AI to differentiate between V1 and V2 samples.
Contribution Checklist