Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Get Started with Microsoft Agent Framework Azure AI Search

Please install this package via pip:

pip install agent-framework-azure-ai-search --pre

Azure AI Search Integration

The Azure AI Search integration provides context providers for RAG (Retrieval Augmented Generation) capabilities with two modes:

  • Semantic Mode: Fast hybrid search (vector + keyword) with semantic ranking
  • Agentic Mode: Multi-hop reasoning using Knowledge Bases for complex queries

API versions: stable vs preview

The integration auto-detects which build of azure-search-documents is installed — there is nothing to configure in code:

Channel Install Data-plane api-version (chosen by the SDK)
Stable pip install azure-search-documents (>=12.0.0) 2026-04-01
Preview pip install --pre azure-search-documents (e.g. 12.1.0b1) 2026-05-01-preview

The provider never pins an api-version; the installed build selects its own, so newer releases work without code changes.

Agentic output modes (answer_synthesis) and extended reasoning effort (low/medium) ship only in the preview build. When a stable build is installed, the provider uses extractive output with minimal reasoning effort and raises an actionable error if a preview-only option is explicitly requested. Switching channels is a single change — the install — with no code edits.

Basic Usage Example

See the Azure AI Search context provider examples which demonstrate:

  • Semantic search with hybrid (vector + keyword) queries
  • Agentic mode with Knowledge Bases for complex multi-hop reasoning
  • Environment variable configuration with Settings class
  • API key and managed identity authentication

Metadata

Release files for agent-framework-azure-ai-search 1.0.0b260730

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agent-framework-azure-ai-search 1.0.0b260730
File Size Uploaded Provenance
agent_framework_azure_ai_search-1.0.0b260730.tar.gz 13.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for agent-framework-azure-ai-search 1.0.0b260730
File Interpreter ABI Platform
agent_framework_azure_ai_search-1.0.0b260730-py3-none-any.whl Python 3 none any Details

Total release size: 27.6 kB

Release files / agent_framework_azure_ai_search-1.0.0b260730.tar.gz

Download URL agent_framework_azure_ai_search-1.0.0b260730.tar.gz
Size 13.9 kB
Tags Source
SHA-256 checksum
How to use checksums
984ecec58290fbbfeaad799448b4ba9d4004317c9ffb1bed3ce5c00884862382
BLAKE2b-256 checksum
How to use checksums
ff1a5541846f63e182972cd741c4112c4fd7bafcb3aec379fcc0f9f5ed721b94
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / agent_framework_azure_ai_search-1.0.0b260730-py3-none-any.whl

Download URL agent_framework_azure_ai_search-1.0.0b260730-py3-none-any.whl
Size 13.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
38b1bebf86f09708379e63b70bca33778d42deb29fd3af5b2e156bd3bf2e21ac
BLAKE2b-256 checksum
How to use checksums
a6b5ff4763e8c8805fcd36999b067aeb1f14ac502256c3e820ead7e308d261ff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for agent-framework-azure-ai-search 1.0.0b260730

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page