Files
agent-framework/python/samples/README.md
T
Laveesh Rohra a5b36dc379 Python: [Durabletask] Update feature-durabletask-python branch with main (#3068)
* Python: Add factory pattern to concurrent orchestration builder (#2738)

* Add factory pattern to concurrent orchestration builder

* Update readme

* Address AI comments

* Fix unit tests

* Fix import

* Prevent multiple calls to set participants or factories

* Add comments

* Mitigate warnings

* Fix mypy

* Address comments

* Address Copilot comments

* Fix tests

* Python: fix: GroupChat ManagerSelectionResponse JSON Schema for OpenAI Structured Outpu… (#2750)

* fix: ManagerSelectionResponse JSON Schema for OpenAI Structured Output Strict Mode

* refactor: install pre-commit then commit again

* Capture file IDs from code interpreter in streaming responses (#2741)

* .NET: [BREAKING] Prevent nulls in AIAgent property (#2719)

* prevent nulls in AIAgent property

* address feedback

* code ql sm04598 (#2723)

Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com>

* .NET: Add Conversation State Sample (Step05) (#2697)

* Initial plan

* Add Agent_OpenAI_Step05_Conversation sample for conversation state management

Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>

* Update Program.cs comment to accurately describe the sample

Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>

* Update the code to use the ConversationClient more in line with the samples in OpenAI

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Changing sample to use ChatClientAgent and conversationId in GetNewThread

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Bump AWSSDK.Extensions.Bedrock.MEAI from 4.0.4.7 to 4.0.4.11 (#2777)

---
updated-dependencies:
- dependency-name: AWSSDK.Extensions.Bedrock.MEAI
  dependency-version: 4.0.4.11
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump Azure.Identity from 1.17.0 to 1.17.1 (#2780)

---
updated-dependencies:
- dependency-name: Azure.Identity
  dependency-version: 1.17.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: Azure.Identity
  dependency-version: 1.17.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: Azure.Identity
  dependency-version: 1.17.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: Azure.Identity
  dependency-version: 1.17.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump Azure.AI.AgentServer.AgentFramework from 1.0.0-beta.4 to 1.0.0-beta.5 (#2778)

---
updated-dependencies:
- dependency-name: Azure.AI.AgentServer.AgentFramework
  dependency-version: 1.0.0-beta.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: Azure.AI.AgentServer.AgentFramework
  dependency-version: 1.0.0-beta.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: Azure.AI.AgentServer.AgentFramework
  dependency-version: 1.0.0-beta.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Python: added more complete parsing for mcp tool arguments (#2756)

* added more complete parsing for mcp tool arguments

* fixed mypy

* added nonlocal model counter, and some fixes

* fixes in naming logic

* extracted json parsing function, added parametrized test and checked coverage

* Python: Updated package versions (#2784)

* Updated package versions

* Small fix

* Bump actions/checkout from 5 to 6 (#2404)

Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>

* .NET: adds support for labels in edges,  fixes rendering of labels in dot a… (#1507)

* adds support for labels in edges,  fixes rendering of labels in dot and mermaid, adds rendering of labels in edges

* Update dotnet/src/Microsoft.Agents.AI.Workflows/Visualization/WorkflowVisualizer.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* escaping edge labels, adding tests for labels containing strange characters that would break the diagram and enabling the previous signature so the API has backwards compatibility.

* Unify label in EdgeData

* Edge API adjustments, removed useless "sanitizer"

* fixed test

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jacob Alber <jaalber@microsoft.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>

* Python: Added custom args and thread object to ai_function kwargs (#2769)

* Added an example of using kwargs in ai_function

* Added thread object to ai_function kwargs

* Updated docs

* Small fix

* Added thread parameter filtering

* Fix WorkflowAgent to include thread convo history. Enable checkpointing. (#2774)

* Update OpenAIResponses.yaml to match AgentSchema (#2598)

1. Update `connection` child types --  `kind: ApiKey` to `kind: key` otherwise schema will fail: https://microsoft.github.io/AgentSchema/reference/apikeyconnection/

2.  Update `outputSchema`'s `PropertySchema` to be `kind` instead of `type` otherwise schema will fail: https://microsoft.github.io/AgentSchema/reference/propertyschema/

* Python: Remove warnings from workflow builder on not using factories (#2808)

* Revert concurrent

* Fix comments

* Python: Filter framework kwargs from MCP tool invocations (#2870)

* Filter framework kwargs from MCP tool invocations

* Fixes

* Python: Fix WorkflowAgent to emit yield_output as agent response (#2866)

* Fix WorkflowAgent to emit yield_output as agent response

* use raw_representation

* Raw representation handling

* Python: Use agent description in HandoffBuilder auto-generated tools (#2713) (#2714)

## Summary
Enhanced `HandoffBuilder._apply_auto_tools` to use the target agent's
description when creating handoff tools, providing more informative tool
descriptions for LLMs.

## Changes
- Modified `_apply_auto_tools` to extract `description` from
  `AgentExecutor._agent` when available
- Updated iteration to use `.items()` for more efficient dict traversal
- Handoff tools now use agent descriptions instead of generic placeholders

## Example
Before: "Handoff to the refund_agent agent."
After: "You handle refund requests. Ask for order details and process refunds."

## Testing
- All handoff tests pass (20/20)
- No breaking changes to existing API

Fixes #2713

Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>

* Python: [BREAKING] Observability updates (#2782)

* fixes Python: Add env_file_path parameter to setup_observability() similar to AzureOpenAIChatClient
Fixes #2186

* WIP on updates using configure_azure_monitor

* improved setup and clarity

* fixed root .env.example

* revert changes

* updated files

* updated sample

* updated zero code

* test fixes and fixed links

* fix devui

* removed planning docs

* added enable method and updated readme and samples

* clarified docstring

* add return annotation

* updated naming

* update capatilized version

* updated readme and some fixes

* updated decorator name inline with the rest

* feedback from comments addressed

* Python: Fix middleware terminate flag to exit function calling loop immediately (#2868)

* Fix middleware terminate flag to exit function calling loop immediately

* Eliminating duck typing

* Improve function exec result handling

* Fix race condition

* Fix mypy issues

* Python: Fix context duplication in handoff workflows when restoring from checkpoint (#2867)

* Fix context duplication in handoff workflows when restoring from checkpoint

* Address Copilot PR review

* .NET: Update to latest Azure.AI.*, OpenAI, and M.E.AI* (#2850)

* Update to latest Azure.AI.*, OpenAI, and M.E.AI*

Absorb breaking changes in Responses surface area

* Update dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Utilities/ChatClientExtensions.cs

* Update dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Utilities/ChatClientExtensions.cs

* Update dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Utilities/ChatClientExtensions.cs

* Update dotnet/samples/GettingStarted/AgentWithOpenAI/Agent_OpenAI_Step04_CreateFromOpenAIResponseClient/Program.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Using patch to remove the model is necessary, updated the response client to actually use the the ForAgent

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com>

* Bump actions/download-artifact from 6 to 7 (#2862)

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 6 to 7.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v6...v7)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/cache from 4 to 5 (#2861)

Bumps [actions/cache](https://github.com/actions/cache) from 4 to 5.
- [Release notes](https://github.com/actions/cache/releases)
- [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md)
- [Commits](https://github.com/actions/cache/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/cache
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump actions/upload-artifact from 5 to 6 (#2860)

Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 5 to 6.
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](https://github.com/actions/upload-artifact/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Python : Ollama Connector for Agent Framework (#1104)

* Initial Commit for Olama Connector

* Added Olama Sample

* Add Sample & Fixed Open Telemetry

* Fixed Spelling from Olama to Ollama

* remove"opentelemetry-semantic-conventions-ai ~=0.4.13" since its handled in a different pr

* Added Tool Calling

* Finalizing test cases

* Adjust samples to be more reliable

* Update python/packages/ollama/agent_framework_ollama/_chat_client.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update python/packages/ollama/pyproject.toml

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update python/packages/ollama/tests/test_ollama_chat_client.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update python/packages/ollama/agent_framework_ollama/_chat_client.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Improved Docstrings & Sample

* Update python/packages/ollama/agent_framework_ollama/_chat_client.py

Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>

* Integrate PR Feedback
- Divided Streaming and Non-Streaming into independent Methods
- Catch Ollama Validation Error
- Add OTEL Provider Name
- Checked Ollama Messages
- Add Usage Statistics

* Revert setting, so it can be none

* Validate Message formatting between AF and Ollama

* Catch Ollama Error and raise a ServiceResponse Error

* Fix mypy error

* remove .vscode comma

* Add Reasoning support & adjust to new structure

* Add Ollama Multimodality and Reasoning

* Add test cases for reasoning

* Add Tests for Error Handling in Ollama Client

* Update python/samples/getting_started/multimodal_input/ollama_chat_multimodal.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Integrated Copilot Feedback

* Implement first PR Feedback

* Adjust Readme files for examples

* Adjust argument passing via additional chat options

* Implemented PR Feedback

* Removing Ollama Package from Core and moving samples

* Fix Link & Adding Samples to Main Sample Readme

* Fixing Links in Readme

* Moved Multimodal and Chat Example

* Fixed Link in ChatClient to Ollama

* Fix AgentFramework Links in Ollama Project

* Fix observability breaking change

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>

* Skip failing IT (#2904)

* .NET: Cosmos DB UT Fast Skip (For Non-Configured Local envs) (#2906)

* Cosmos DB UT Fast Skip (Non-Configured Local envs) + Long running UT skip in pipeline when no CosmosDB changes happened

* Force a CosmosDB source code change to trigger the pipeline

* Address possible string boolean mismatch

* Add debug

* Enabling emulator always when running IT

* .NET: Add TTLs to durable agent sessions (#2679)

* .NET: Add TTLs to durable agent sessions

* Remove unnecessary async

* PR feedback: clarify UTC

* PR feedback: limit minimum signal delay to <= 5 minutes

* PR feedback: Fix TTL disablement

* Linter: use auto-property

* Fix build break from OpenAI SDK change

* Updated CHANGELOG.md

* PR feedback

* Reduce default TTL to 14 days to work around DTS bug

* Python:  Update Mem0Provider to use v2 search API `filters` parameter (#2766)

* short fix to move id parameters to filters object

* added tests

* small fix

* mem0 dependency update

* Updated package versions (#2913)

* .NET: Switch to new "Run" method name. (#2843)

* Switch to new "RunAgent" method name.

* Try to disable false positive naming warning.

* Add comment about disabled warnings.

* Rename `RunAgent` to just `Run`.

* Update CHANGELOG.

* Python: Switch to new "run" method name. (#2890)

* Switch to `run` method.

* Add support for deprecated `run_agent`.

* Fix entity method name.

* Fix method name and improve tests.

* Update comment.

* Update Python CHANGELOG.

* [BREAKING] Python: Add factory pattern to handoff orchestration builder (#2844)

* WIP: Factory pattern to handoff

* Add factory pattern to concurrent orchestration builder; Next: tests and sample verification

* Add tests and improve comments

* Fix mypy

* Simplify handoff_simple.py

* Simplify handoff_autonoumous.py and bug fix

* Update readme

* Address Copilot comments

* Python: Flow custom kwargs to agents via Workflow SharedState (#2894)

* Flow custom kwargs to agents via SharedState

* Address Copilot feedback

* Improve sample typing

* Fix test

* Fix Pydantic error when using Literal type for tool params (#2893)

* Updated Ollama package version (#2920)

* Python: Azure AI Agent with Bing Grounding Citations Sample (#2892)

* bing grounding sample with citations

* small fix

* fix

* .NET: Make DelegatingAIAgent abstract (#2797)

* Initial plan

* Make DelegatingAIAgent abstract

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Added additional arguments for Azure AI agent (#2922)

* Python: Correction of MCP image type conversion in  _mcp.py (#2901)

* Correction of MCP image type conversion in  _mcp.py

* Added a new overload to the init function of the DataContent() type of the Agent Framework, edited the test case to correctly test the usage of the data and uri fields while using DataContent()

* Fixed tests related to the changes of the DataContent type, added testing for both string and byte representations

* Pass kwargs into subworkflows (#2923)

* Python: Move ollama samples to samples getting started dir (#2921)

* Move ollama samples to samples getting started dir

* Address feedback

* Python: fix: correct BadRequestError when using Pydantic model in response_fo… (#1843)

* fix: correct BadRequestError when using Pydantic model in response_format

* Fix lint

---------

Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>

* .NET: [Breaking] Delete display name property (#2758)

* delete the AIAgent.DisplayName property

* use agent name as a first value for activity display name

* Update dotnet/src/Microsoft.Agents.AI.Workflows/Specialized/HandoffAgentExecutor.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Python: cleanup and refactoring of chat clients (#2937)

* refactoring and unifying naming schemes of internal methods of chat clients

* set tool_choice to auto

* fix for mypy

* added note on naming and fix #2951

* fix responses

* fixes in azure ai agents client

* Python: Workflow add option to visualize internal executors (#2917)

* Workflow add option to visualize internal executors

* Address Copilot comments

* Python: Fixes Run ID and Thread ID casing to align with AG-UI Typescript SDK (#2948)

* added camelCase input to run id and thread id aligning with @ag-ui/core

* fixed per copilot suggestions

* Python: Add workflow cancellation sample (#2732)

* Add workflow cancellation sample

Add sample demonstrating how to cancel a running workflow using asyncio
tasks. Shows both cancellation mid-execution and normal completion paths.
Useful for implementing timeouts, graceful shutdown, or A2A executors.

* update docstring

* .NET: Update Anthropic package to version 12.0.0 (#2914)

* Initial plan

* Update Anthropic package to version 12.0.0

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>

* Python: Add Azure Managed Redis Support with Credential Provider (#2887)

* azure redis support

* small fixes

* azure managed redis sample

* fixes

* Bump CommunityToolkit.Aspire.OllamaSharp from 13.0.0-beta.440 to 13.0.0 (#2856)

---
updated-dependencies:
- dependency-name: CommunityToolkit.Aspire.OllamaSharp
  dependency-version: 13.0.0
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump AWSSDK.Extensions.Bedrock.MEAI from 4.0.4.11 to 4.0.5 (#2853)

---
updated-dependencies:
- dependency-name: AWSSDK.Extensions.Bedrock.MEAI
  dependency-version: 4.0.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com>

* Bump Azure.AI.AgentServer.AgentFramework from 1.0.0-beta.4 to 1.0.0-beta.5 (#2854)

---
updated-dependencies:
- dependency-name: Azure.AI.AgentServer.AgentFramework
  dependency-version: 1.0.0-beta.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
- dependency-name: Azure.AI.AgentServer.AgentFramework
  dependency-version: 1.0.0-beta.5
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>

* Python: Fix WorkflowAgent event handling and kwargs forwarding (#2946)

* Fix kwargs propagation through workflow.as_agent()

* Fix WorkflowAgent to respect AgentExecutor output_response setting

* .NET: Use GrpcEntityRunner instead of TaskEntityDispatcher (#2759)

* Use GrpcEntityRunner instead of TaskEntityDispatcher

* Pin to Durable worker 1.11.0

* Set the invocation result

* Update all Durable packages

* Update changelog, rename dispatcher to encondedEntityRequest

* Python: Bump Py version to 1.0.0b251218 for a release. Update CHANGELOG (#2968)

* Bump Py version to 1.0.0b251218 for a release. Update CHANGELOG

* update lock

* Fix formatting

* Fix ChatKit typing

* Python: Introducing Foundry Local Chat Clients (#2915)

* redo foundry local chat client

* fix mypy and spelling

* better docstring, updated sample

* fixed tests and added tests

* small sample update

* Updated package versions (#2978)

* Python: Added GitHub MCP sample with PAT (#2967)

* added github mcp sample with PAT

* addressed copilot fixes

* env fix

* Python: Preserve reasoning blocks with OpenRouter (#2950)

* Preserve reasoning blocks with OpenRouter

* Put encrypted reasoning in TextReasoningContent

* Remove unneccessary change

* Fix docs

* Support streaming

* Fix handling None in TextReasoningContent.text

* Python: Added response.created and response.in_progress event process to OpenAIBaseResponseClient (#2975)

* added response.created and response.in_progress to include response.id

* better doc string

* added tests for the new streaming event types

* Python: Introducing support for Bedrock-hosted models (Anthropic, Cohere, etc.) (#2610)

* Pushing the bedrock related changes to the new branch after addressing the review comments

* 2524 Addressed the second round review comments

* 2524 Addressed few more minor comments on the PR

* resolving the merge conflict

* 2524 resolved the uv.lock conflicts

* 2524 addressed more comments

* 2524 removed the print statement to fix the checks failure

* 2524 resolved the CI failure issues

* 2524 fixing the CI breaks

* 2524 Addressed the review comment

* 2524 resolved conflict

---------

Co-authored-by: Sunil Dutta <sunil.dutta@penske.com>
Co-authored-by: budgetboardingai <apurva.sharma31@gmail.com>

* .NET: [Durable Agents] Reliable streaming sample (#2942)

* .NET: [Durable Agents] Reliable streaming sample

* Add automated validation for new sample

* Address Copilot PR feedback

* Fix typo in README.md about agent definitions (#2634)

* Fix typo in README.md about agent definitions

* Update agent-samples/README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Python: latency improvements (#3014)

* latency improvements

* fixed mypy, added coding standards and instructions

* slight logic improvement

* Python: Updated package versions (#3024)

* Updated package versions

* Updated changelog

* Python: add powerfx safe mode (#3028)

* add powerfx safe mode

* improved docstring and aligned env_file loading

* ensured test uses reset

* .NET: [Breaking] Introduce RunCoreAsync/RunCoreStreamingAsync delegation pattern in AIAgent (#2749)

* Initial plan

* Refactor AIAgent: Make RunAsync and RunStreamingAsync non-abstract, add RunCoreAsync and RunCoreStreamingAsync

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Fix infinite recursion in test implementations

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Make RunAsync and RunStreamingAsync non-virtual as requested

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Fix DelegatingAIAgent subclasses to use RunCoreAsync/RunCoreStreamingAsync

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Fix XML documentation references in AnonymousDelegatingAIAgent

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Restore <see cref> tags with proper qualified signatures in AnonymousDelegatingAIAgent

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Rollback unnecessary XML documentation changes in AnonymousDelegatingAIAgent

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Remove pragma and update crefs to RunCoreAsync/RunCoreStreamingAsync

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* Fix EntityAgentWrapper to call base.RunCoreAsync/RunCoreStreamingAsync

Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>

* fix compilation issues

* fix compilatio issue

* fix tests

* fix unit tests

* fix unit test

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
Co-authored-by: SergeyMenshykh <sergemenshikh@gmail.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>

* Remove from feature branch

* Remove ollama changes

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Tao Chen <taochen@microsoft.com>
Co-authored-by: Kurt <65111699+q33566@users.noreply.github.com>
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
Co-authored-by: Korolev Dmitry <deagle.gross@gmail.com>
Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
Co-authored-by: Chris <66376200+crickman@users.noreply.github.com>
Co-authored-by: Jose Luis Latorre Millas <joslat@gmail.com>
Co-authored-by: Jacob Alber <jaalber@microsoft.com>
Co-authored-by: Richard Ortega <richardjortega@gmail.com>
Co-authored-by: 刘邦学AI <lbbniu@gmail.com>
Co-authored-by: Stephen Toub <stoub@microsoft.com>
Co-authored-by: Nico Möller <nkm-moeller@mail.de>
Co-authored-by: Chris Gillum <cgillum@microsoft.com>
Co-authored-by: Giles Odigwe <79032838+giles17@users.noreply.github.com>
Co-authored-by: Phillip Hoff <phillip.hoff@gmail.com>
Co-authored-by: Ege Ozan Özyedek <36128615+egeozanozyedek@users.noreply.github.com>
Co-authored-by: samueljohnsiby <66901393+samueljohnsiby@users.noreply.github.com>
Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
Co-authored-by: Hao Luo <338265+howlowck@users.noreply.github.com>
Co-authored-by: Victor Dibia <chuvidi2003@gmail.com>
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Co-authored-by: Jacob Viau <javia@microsoft.com>
Co-authored-by: SuperKenVery <39673849+SuperKenVery@users.noreply.github.com>
Co-authored-by: Sunil Dutta <dutta.2003@gmail.com>
Co-authored-by: Sunil Dutta <sunil.dutta@penske.com>
Co-authored-by: budgetboardingai <apurva.sharma31@gmail.com>
Co-authored-by: Syrine Chelly <62653967+SyChell@users.noreply.github.com>
Co-authored-by: SergeyMenshykh <sergemenshikh@gmail.com>
2026-01-02 13:13:37 -08:00

31 KiB

Python Samples

This directory contains samples demonstrating the capabilities of Microsoft Agent Framework for Python.

Agents

A2A (Agent-to-Agent)

File Description
getting_started/agents/a2a/agent_with_a2a.py Agent2Agent (A2A) Protocol Integration Sample

Anthropic

File Description
getting_started/agents/anthropic/anthropic_basic.py Agent with Anthropic Client
getting_started/agents/anthropic/anthropic_advanced.py Advanced sample with thinking and hosted tools.

Azure AI (based on azure-ai-agents V1 package)

File Description
getting_started/agents/azure_ai_agent/azure_ai_basic.py Azure AI Agent Basic Example
getting_started/agents/azure_ai_agent/azure_ai_with_azure_ai_search.py Azure AI Agent with Azure AI Search Example
getting_started/agents/azure_ai_agent/azure_ai_with_bing_grounding.py Azure AI agent with Bing Grounding search for real-time web information
getting_started/agents/azure_ai_agent/azure_ai_with_code_interpreter.py Azure AI Agent with Code Interpreter Example
getting_started/agents/azure_ai_agent/azure_ai_with_code_interpreter_file_generation.py Azure AI Agent with Code Interpreter File Generation Example
getting_started/agents/azure_ai_agent/azure_ai_with_existing_agent.py Azure AI Agent with Existing Agent Example
getting_started/agents/azure_ai_agent/azure_ai_with_existing_thread.py Azure AI Agent with Existing Thread Example
getting_started/agents/azure_ai_agent/azure_ai_with_explicit_settings.py Azure AI Agent with Explicit Settings Example
getting_started/agents/azure_ai_agent/azure_ai_with_file_search.py Azure AI agent with File Search capabilities
getting_started/agents/azure_ai_agent/azure_ai_with_function_tools.py Azure AI Agent with Function Tools Example
getting_started/agents/azure_ai_agent/azure_ai_with_hosted_mcp.py Azure AI Agent with Hosted MCP Example
getting_started/agents/azure_ai_agent/azure_ai_with_local_mcp.py Azure AI Agent with Local MCP Example
getting_started/agents/azure_ai_agent/azure_ai_with_multiple_tools.py Azure AI Agent with Multiple Tools Example
getting_started/agents/azure_ai_agent/azure_ai_with_openapi_tools.py Azure AI agent with OpenAPI tools
getting_started/agents/azure_ai_agent/azure_ai_with_thread.py Azure AI Agent with Thread Management Example

Azure AI (based on azure-ai-projects V2 package)

File Description
getting_started/agents/azure_ai/azure_ai_basic.py Azure AI Agent Basic Example
getting_started/agents/azure_ai/azure_ai_use_latest_version.py Azure AI Agent latest version reuse example
getting_started/agents/azure_ai/azure_ai_with_azure_ai_search.py Azure AI Agent with Azure AI Search Example
getting_started/agents/azure_ai/azure_ai_with_bing_grounding.py Azure AI Agent with Bing Grounding Example
getting_started/agents/azure_ai/azure_ai_with_bing_custom_search.py Azure AI Agent with Bing Custom Search Example
getting_started/agents/azure_ai/azure_ai_with_browser_automation.py Azure AI Agent with Browser Automation Example
getting_started/agents/azure_ai/azure_ai_with_code_interpreter.py Azure AI Agent with Code Interpreter Example
getting_started/agents/azure_ai/azure_ai_with_code_interpreter_file_generation.py Azure AI Agent with Code Interpreter File Generation Example
getting_started/agents/azure_ai/azure_ai_with_existing_agent.py Azure AI Agent with Existing Agent Example
getting_started/agents/azure_ai/azure_ai_with_existing_conversation.py Azure AI Agent with Existing Conversation Example
getting_started/agents/azure_ai/azure_ai_with_explicit_settings.py Azure AI Agent with Explicit Settings Example
getting_started/agents/azure_ai/azure_ai_with_file_search.py Azure AI Agent with File Search Example
getting_started/agents/azure_ai/azure_ai_with_hosted_mcp.py Azure AI Agent with Hosted MCP Example
getting_started/agents/azure_ai/azure_ai_with_response_format.py Azure AI Agent with Structured Output Example
getting_started/agents/azure_ai/azure_ai_with_thread.py Azure AI Agent with Thread Management Example
getting_started/agents/azure_ai/azure_ai_with_image_generation.py Azure AI Agent with Image Generation Example
getting_started/agents/azure_ai/azure_ai_with_microsoft_fabric.py Azure AI Agent with Microsoft Fabric Example
getting_started/agents/azure_ai/azure_ai_with_web_search.py Azure AI Agent with Web Search Example

Azure OpenAI

File Description
getting_started/agents/azure_openai/azure_assistants_basic.py Azure OpenAI Assistants Basic Example
getting_started/agents/azure_openai/azure_assistants_with_code_interpreter.py Azure OpenAI Assistants with Code Interpreter Example
getting_started/agents/azure_openai/azure_assistants_with_existing_assistant.py Azure OpenAI Assistants with Existing Assistant Example
getting_started/agents/azure_openai/azure_assistants_with_explicit_settings.py Azure OpenAI Assistants with Explicit Settings Example
getting_started/agents/azure_openai/azure_assistants_with_function_tools.py Azure OpenAI Assistants with Function Tools Example
getting_started/agents/azure_openai/azure_assistants_with_thread.py Azure OpenAI Assistants with Thread Management Example
getting_started/agents/azure_openai/azure_chat_client_basic.py Azure OpenAI Chat Client Basic Example
getting_started/agents/azure_openai/azure_chat_client_with_explicit_settings.py Azure OpenAI Chat Client with Explicit Settings Example
getting_started/agents/azure_openai/azure_chat_client_with_function_tools.py Azure OpenAI Chat Client with Function Tools Example
getting_started/agents/azure_openai/azure_chat_client_with_thread.py Azure OpenAI Chat Client with Thread Management Example
getting_started/agents/azure_openai/azure_responses_client_basic.py Azure OpenAI Responses Client Basic Example
getting_started/agents/azure_openai/azure_responses_client_image_analysis.py Azure OpenAI Responses Client with Image Analysis Example
getting_started/agents/azure_openai/azure_responses_client_with_code_interpreter.py Azure OpenAI Responses Client with Code Interpreter Example
getting_started/agents/azure_openai/azure_responses_client_with_explicit_settings.py Azure OpenAI Responses Client with Explicit Settings Example
getting_started/agents/azure_openai/azure_responses_client_with_function_tools.py Azure OpenAI Responses Client with Function Tools Example
getting_started/agents/azure_openai/azure_responses_client_with_hosted_mcp.py Azure OpenAI Responses Client with Hosted Model Context Protocol (MCP) Example
getting_started/agents/azure_openai/azure_responses_client_with_local_mcp.py Azure OpenAI Responses Client with local Model Context Protocol (MCP) Example
getting_started/agents/azure_openai/azure_responses_client_with_thread.py Azure OpenAI Responses Client with Thread Management Example

Copilot Studio

File Description
getting_started/agents/copilotstudio/copilotstudio_basic.py Copilot Studio Agent Basic Example
getting_started/agents/copilotstudio/copilotstudio_with_explicit_settings.py Copilot Studio Agent with Explicit Settings Example

Custom

File Description
getting_started/agents/custom/custom_agent.py Custom Agent Implementation Example
getting_started/agents/custom/custom_chat_client.py Custom Chat Client Implementation Example

Ollama

The recommended way to use Ollama is via the native OllamaChatClient from the agent-framework-ollama package.

File Description
getting_started/agents/ollama/ollama_agent_basic.py Basic Ollama Agent with native Ollama Chat Client
getting_started/agents/ollama/ollama_agent_reasoning.py Ollama Agent with reasoning capabilities
getting_started/agents/ollama/ollama_chat_client.py Direct usage of Ollama Chat Client
getting_started/agents/ollama/ollama_chat_multimodal.py Ollama Chat Client with multimodal (image) input
getting_started/agents/ollama/ollama_with_openai_chat_client.py Alternative: Ollama via OpenAI Chat Client

OpenAI

File Description
getting_started/agents/openai/openai_assistants_basic.py OpenAI Assistants Basic Example
getting_started/agents/openai/openai_assistants_with_code_interpreter.py OpenAI Assistants with Code Interpreter Example
getting_started/agents/openai/openai_assistants_with_existing_assistant.py OpenAI Assistants with Existing Assistant Example
getting_started/agents/openai/openai_assistants_with_explicit_settings.py OpenAI Assistants with Explicit Settings Example
getting_started/agents/openai/openai_assistants_with_file_search.py OpenAI Assistants with File Search Example
getting_started/agents/openai/openai_assistants_with_function_tools.py OpenAI Assistants with Function Tools Example
getting_started/agents/openai/openai_assistants_with_thread.py OpenAI Assistants with Thread Management Example
getting_started/agents/openai/openai_chat_client_basic.py OpenAI Chat Client Basic Example
getting_started/agents/openai/openai_chat_client_with_explicit_settings.py OpenAI Chat Client with Explicit Settings Example
getting_started/agents/openai/openai_chat_client_with_function_tools.py OpenAI Chat Client with Function Tools Example
getting_started/agents/openai/openai_chat_client_with_local_mcp.py OpenAI Chat Client with Local MCP Example
getting_started/agents/openai/openai_chat_client_with_thread.py OpenAI Chat Client with Thread Management Example
getting_started/agents/openai/openai_chat_client_with_web_search.py OpenAI Chat Client with Web Search Example
getting_started/agents/openai/openai_chat_client_with_runtime_json_schema.py OpenAI Chat Client with runtime JSON Schema for structured output without a Pydantic model
getting_started/agents/openai/openai_responses_client_basic.py OpenAI Responses Client Basic Example
getting_started/agents/openai/openai_responses_client_image_analysis.py OpenAI Responses Client Image Analysis Example
getting_started/agents/openai/openai_responses_client_image_generation.py OpenAI Responses Client Image Generation Example
getting_started/agents/openai/openai_responses_client_reasoning.py OpenAI Responses Client Reasoning Example
getting_started/agents/openai/openai_responses_client_with_code_interpreter.py OpenAI Responses Client with Code Interpreter Example
getting_started/agents/openai/openai_responses_client_with_explicit_settings.py OpenAI Responses Client with Explicit Settings Example
getting_started/agents/openai/openai_responses_client_with_file_search.py OpenAI Responses Client with File Search Example
getting_started/agents/openai/openai_responses_client_with_function_tools.py OpenAI Responses Client with Function Tools Example
getting_started/agents/openai/openai_responses_client_with_hosted_mcp.py OpenAI Responses Client with Hosted MCP Example
getting_started/agents/openai/openai_responses_client_with_local_mcp.py OpenAI Responses Client with Local MCP Example
getting_started/agents/openai/openai_responses_client_with_structured_output.py OpenAI Responses Client with Structured Output Example
getting_started/agents/openai/openai_responses_client_with_thread.py OpenAI Responses Client with Thread Management Example
getting_started/agents/openai/openai_responses_client_with_web_search.py OpenAI Responses Client with Web Search Example

Chat Client

File Description
getting_started/chat_client/azure_ai_chat_client.py Azure AI Chat Client Direct Usage Example
getting_started/chat_client/azure_assistants_client.py Azure OpenAI Assistants Client Direct Usage Example
getting_started/chat_client/azure_chat_client.py Azure Chat Client Direct Usage Example
getting_started/chat_client/azure_responses_client.py Azure OpenAI Responses Client Direct Usage Example
getting_started/chat_client/chat_response_cancellation.py Chat Response Cancellation Example
getting_started/chat_client/openai_assistants_client.py OpenAI Assistants Client Direct Usage Example
getting_started/chat_client/openai_chat_client.py OpenAI Chat Client Direct Usage Example
getting_started/chat_client/openai_responses_client.py OpenAI Responses Client Direct Usage Example

Context Providers

Mem0

File Description
getting_started/context_providers/mem0/mem0_basic.py Basic Mem0 integration example
getting_started/context_providers/mem0/mem0_oss.py Mem0 OSS (Open Source) integration example
getting_started/context_providers/mem0/mem0_threads.py Mem0 with thread management example

Redis

File Description
getting_started/context_providers/redis/redis_basics.py Basic Redis provider example
getting_started/context_providers/redis/redis_conversation.py Redis conversation context management example
getting_started/context_providers/redis/redis_threads.py Redis with thread management example

Other

File Description
getting_started/context_providers/simple_context_provider.py Simple context provider implementation example

DevUI

File Description
getting_started/devui/fanout_workflow/workflow.py Complex fan-out/fan-in workflow example
getting_started/devui/foundry_agent/agent.py Azure AI Foundry agent example
getting_started/devui/in_memory_mode.py In-memory mode example for DevUI
getting_started/devui/spam_workflow/workflow.py Spam detection workflow example
getting_started/devui/weather_agent_azure/agent.py Weather agent using Azure OpenAI example
getting_started/devui/workflow_agents/workflow.py Workflow with multiple agents example

Evaluation

File Description
getting_started/evaluation/red_teaming/red_team_agent_sample.py Red team agent evaluation sample for Azure AI Foundry
getting_started/evaluation/self_reflection/self_reflection.py LLM self-reflection with AI Foundry graders example
demos/workflow_evaluation/run_evaluation.py Multi-agent workflow evaluation demo with travel planning agents evaluated using Azure AI Foundry evaluators

MCP (Model Context Protocol)

File Description
getting_started/mcp/agent_as_mcp_server.py Agent as MCP Server Example
getting_started/mcp/mcp_api_key_auth.py MCP Authentication Example

Middleware

File Description
getting_started/middleware/agent_and_run_level_middleware.py Agent and run-level middleware example
getting_started/middleware/chat_middleware.py Chat middleware example
getting_started/middleware/class_based_middleware.py Class-based middleware implementation example
getting_started/middleware/decorator_middleware.py Decorator-based middleware example
getting_started/middleware/exception_handling_with_middleware.py Exception handling with middleware example
getting_started/middleware/function_based_middleware.py Function-based middleware example
getting_started/middleware/middleware_termination.py Middleware termination example
getting_started/middleware/override_result_with_middleware.py Override result with middleware example
getting_started/middleware/runtime_context_delegation.py Runtime context delegation example demonstrating how to pass API tokens, session data, and other context through hierarchical agent delegation
getting_started/middleware/shared_state_middleware.py Shared state middleware example
getting_started/middleware/thread_behavior_middleware.py Thread behavior middleware example demonstrating how to track conversation state across multiple agent runs

Multimodal Input

File Description
getting_started/multimodal_input/azure_chat_multimodal.py Azure OpenAI Chat with multimodal (image) input example
getting_started/multimodal_input/azure_responses_multimodal.py Azure OpenAI Responses with multimodal (image) input example
getting_started/multimodal_input/openai_chat_multimodal.py OpenAI Chat with multimodal (image) input example

Azure Functions

Sample Description
getting_started/azure_functions/01_single_agent/ Host a single agent in Azure Functions with Durable Extension HTTP endpoints and per-session state.
getting_started/azure_functions/02_multi_agent/ Register multiple agents in one function app with dedicated run routes and a health check endpoint.
getting_started/azure_functions/03_callbacks/ Capture streaming response telemetry via Durable Extension callbacks exposed through HTTP APIs.
getting_started/azure_functions/04_single_agent_orchestration_chaining/ Chain sequential agent executions inside a durable orchestration while preserving the shared thread context.
getting_started/azure_functions/05_multi_agent_orchestration_concurrency/ Run two agents concurrently within a durable orchestration and combine their domain-specific outputs.
getting_started/azure_functions/06_multi_agent_orchestration_conditionals/ Route orchestration logic based on structured agent responses for spam detection and reply drafting.
getting_started/azure_functions/07_single_agent_orchestration_hitl/ Implement a human-in-the-loop approval loop that iterates on agent output inside a durable orchestration.

Observability

File Description
getting_started/observability/advanced_manual_setup_console_output.py Advanced manual observability setup with console output
getting_started/observability/advanced_zero_code.py Zero-code observability setup example
getting_started/observability/agent_observability.py Agent observability example
getting_started/observability/agent_with_foundry_tracing.py Any chat client setup with Azure Foundry Observability
getting_started/observability/azure_ai_agent_observability.py Azure AI agent observability example
getting_started/observability/configure_otel_providers_with_env_var.py Setup observability using environment variables
getting_started/observability/configure_otel_providers_with_parameters.py Setup observability using parameters
getting_started/observability/workflow_observability.py Workflow observability example

Threads

File Description
getting_started/threads/custom_chat_message_store_thread.py Implementation of custom chat message store state
getting_started/threads/redis_chat_message_store_thread.py Basic example of using Redis chat message store
getting_started/threads/suspend_resume_thread.py Demonstrates how to suspend and resume a service-managed thread

Tools

File Description
getting_started/tools/ai_function_declaration_only.py Function declarations without implementations for testing agent reasoning
getting_started/tools/ai_function_from_dict_with_dependency_injection.py Creating AI functions from dictionary definitions using dependency injection
getting_started/tools/ai_function_recover_from_failures.py Graceful error handling when tools raise exceptions
getting_started/tools/ai_function_with_approval.py User approval workflows for function calls without threads
getting_started/tools/ai_function_with_approval_and_threads.py Tool approval workflows using threads for conversation history management
getting_started/tools/ai_function_with_max_exceptions.py Limiting tool failure exceptions using max_invocation_exceptions
getting_started/tools/ai_function_with_max_invocations.py Limiting total tool invocations using max_invocations
getting_started/tools/ai_functions_in_class.py Using ai_function decorator with class methods for stateful tools

Workflows

View the list of Workflows samples here.

Sample Guidelines

For information on creating new samples, see SAMPLE_GUIDELINES.md.

More Information