Skip to content

Python: Updated documentation for Azure AI#2280

Merged
dmytrostruk merged 3 commits intomicrosoft:mainfrom
dmytrostruk:azure-ai-docs-update
Nov 17, 2025
Merged

Python: Updated documentation for Azure AI#2280
dmytrostruk merged 3 commits intomicrosoft:mainfrom
dmytrostruk:azure-ai-docs-update

Conversation

@dmytrostruk
Copy link
Member

Motivation and Context

Updated the documentation for Azure AI to differentiate between V1 and V2 samples.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

@dmytrostruk dmytrostruk self-assigned this Nov 17, 2025
@dmytrostruk dmytrostruk added the documentation Improvements or additions to documentation label Nov 17, 2025
Copilot AI review requested due to automatic review settings November 17, 2025 18:41
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@dmytrostruk dmytrostruk added this pull request to the merge queue Nov 17, 2025
Merged via the queue into microsoft:main with commit ea06677 Nov 17, 2025
23 checks passed
arisng pushed a commit to arisng/agent-framework that referenced this pull request Feb 2, 2026
* Updated documentation for Azure AI

* Small fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants