Files
microsoft--agent-framework/python/samples/04-hosting
Farzad Sunavala 6dfcbc5c62 Python: support stable + preview Azure AI Search (Foundry IQ) API versions (#6603)
Update agent-framework-azure-ai-search to work across the stable/GA azure-search-documents SDK (12.0.0, api-version 2026-04-01) and the preview SDK (12.1.0b1, api-version 2026-05-01-preview) for both semantic and agentic modes.

- Bump the dependency to azure-search-documents>=12.0.0,<13 and the package to 1.0.0b260618.
- Add an api_version parameter (threaded into SearchClient, SearchIndexClient, and KnowledgeBaseRetrievalClient) plus STABLE_API_VERSION/PREVIEW_API_VERSION constants, re-exported from agent_framework.azure.
- Auto-detect preview-only agentic features (output mode, low/medium reasoning effort) via _preview_features_active(), which requires both the preview SDK and a preview api-version; defaults (extractive + minimal) work on both channels and preview-only options raise an actionable error otherwise.
- Make knowledge-base imports SDK-version resilient and fix the 12.x surface (k -> k_nearest_neighbors, defensive additional_properties).
- Update tests (pass on both SDKs), docs, samples, CHANGELOG, and uv.lock.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-29 13:12:52 +00:00
..

Hosting Samples

This directory contains Python samples that demonstrate different ways to host Agent Framework agents. Use this page to choose the hosting model that best fits your scenario, then continue to the README in the relevant subdirectory.

Hosting Options

Option Use this when you need... Start here
A2A Agent-to-Agent protocol interoperability or remote agent invocation. a2a/README.md
Azure Functions HTTP or serverless hosting on Azure Functions. azure_functions/README.md
Durable Task Durable execution, long-running flows, or orchestration patterns. durabletask/README.md
Foundry Hosted Agents Azure AI Foundry hosted agent deployment. foundry-hosted-agents/README.md

How to Choose

  • Start with A2A if you want one agent to call or expose another agent over the A2A protocol.
  • Start with Azure Functions if you want an HTTP-hosted or serverless entry point using Azure Functions.
  • Start with Durable Task if you need persistent state, durable workflows, or orchestration across multiple steps.
  • Start with Foundry Hosted Agents if you want to package and deploy an agent as a hosted agent in Azure AI Foundry.

Common Prerequisites

Most hosting samples share a small set of prerequisites:

  • A supported Python environment for running the samples locally.
  • An Azure AI Foundry project endpoint and model deployment name for FOUNDRY_PROJECT_ENDPOINT and FOUNDRY_MODEL.
  • Azure CLI authentication via az login when the sample uses AzureCliCredential.
  • Any hosting-specific tools or extra services called out in the subdirectory README.

Next Steps

  1. Pick the hosting approach that matches your scenario.
  2. Open the corresponding README for setup and run instructions.
  3. Follow that sample's environment, dependency, and execution steps.