-
Notifications
You must be signed in to change notification settings - Fork 863
Python: [BREAKING] Renamed async_credential to credential #2648
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Python Test Coverage Report •
Python Unit Test Overview
|
|||||||||||||||||||||||||||||||||||
There was a problem hiding this 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 implements a breaking change that renames the async_credential parameter to credential across Azure AI chat clients (AzureAIClient and AzureAIAgentClient) for improved consistency and brevity. The change affects the core implementation, all sample code, tests, and documentation.
Key Changes
- Renamed
async_credentialparameter tocredentialinAzureAIClientandAzureAIAgentClientconstructors - Updated all sample files to use the new parameter name
- Updated test files and documentation to reflect the change
Reviewed changes
Copilot reviewed 65 out of 65 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
python/packages/azure-ai/agent_framework_azure_ai/_client.py |
Updated AzureAIClient.__init__ parameter from async_credential to credential, including docstrings and internal references |
python/packages/azure-ai/agent_framework_azure_ai/_chat_client.py |
Updated AzureAIAgentClient.__init__ parameter from async_credential to credential, including docstrings and internal references |
python/packages/azure-ai/tests/test_azure_ai_client.py |
Updated test cases to use credential parameter in all client instantiations and updated related docstrings |
python/packages/azure-ai/tests/test_azure_ai_agent_client.py |
Updated test cases to use credential parameter in all client instantiations and updated related docstrings |
python/samples/getting_started/agents/azure_ai/*.py (15 files) |
Updated all Azure AI agent samples to use the new credential parameter |
python/samples/getting_started/agents/azure_ai_agent/*.py (10 files) |
Updated all Azure AI agent client samples to use the new credential parameter |
python/samples/getting_started/middleware/*.py (9 files) |
Updated middleware samples to use the new credential parameter |
python/samples/getting_started/context_providers/**/*.py (6 files) |
Updated context provider samples to use the new credential parameter |
python/samples/getting_started/workflows/agents/*.py (2 files) |
Updated workflow samples to use the new credential parameter |
python/samples/getting_started/threads/suspend_resume_thread.py |
Updated thread management sample to use the new credential parameter |
python/samples/getting_started/chat_client/azure_ai_chat_client.py |
Updated chat client sample to use the new credential parameter |
python/samples/getting_started/declarative/*.py (2 files) |
Updated declarative agent samples to use the new credential parameter |
python/samples/getting_started/devui/foundry_agent/agent.py |
Updated DevUI sample to use the new credential parameter |
python/samples/semantic-kernel-migration/azure_ai_agent/*.py (3 files) |
Updated Semantic Kernel migration samples to use the new credential parameter, also improved async context manager formatting |
python/samples/demos/workflow_evaluation/create_workflow.py |
Updated workflow evaluation demo to use the new credential parameter, includes additional code formatting improvements |
python/packages/lab/gaia/samples/azure_ai_agent.py |
Updated GAIA sample to use the new credential parameter |
python/samples/getting_started/context_providers/azure_ai_search/README.md |
Updated README documentation to show the new credential parameter |
Motivation and Context
Resolves: #1993
Renamed
async_credentialparameter in several chat clients tocredentialto make it shorter and for consistency between different providers.Contribution Checklist