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>=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.
Query-time user identity
Agentic retrieval can forward a caller-specific Azure AI Search authorization token when the
index uses permission fields for document-level access control. Pass a sync or async Azure token
credential for the caller via query_source_credential; the provider requests the Azure AI Search
resource scope and forwards the token on each Knowledge Base retrieval request. This capability
requires azure-search-documents>=12.1.0b1, installed with
pip install --pre "azure-search-documents>=12.1.0b1".
context_provider = AzureAISearchContextProvider(
endpoint=search_endpoint,
credential=application_credential,
mode="agentic",
knowledge_base_name=knowledge_base_name,
query_source_credential=user_credential,
)
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
5 maintainers
Metadata
5 maintainers
Release files for agent-framework-azure-ai-search 1.0.0b260813
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| agent_framework_azure_ai_search-1.0.0b260813.tar.gz | 14.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| agent_framework_azure_ai_search-1.0.0b260813-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.1 kB
Release files / agent_framework_azure_ai_search-1.0.0b260813.tar.gz
| Download URL | agent_framework_azure_ai_search-1.0.0b260813.tar.gz |
|---|---|
| Size | 14.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b39a02106cb6b17ca1766f59a24d5c93ce59f59967101efb8d04392660a914f6
|
|
BLAKE2b-256 checksum How to use checksums |
e74fe2f41e0dece09d85fb033465ed7fc19a4800f9c29c44ea75b292d33180f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":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.0b260813-py3-none-any.whl
| Download URL | agent_framework_azure_ai_search-1.0.0b260813-py3-none-any.whl |
|---|---|
| Size | 14.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c76e9ba89581aafb0678e3048d30ef7a2cdc532d10dd90c9600bbe65a8ec7899
|
|
BLAKE2b-256 checksum How to use checksums |
3b1ac989af1a44c4c10e15e6010356d4d3e7a98fcc1950c79d118a3b8d26af26
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":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.0b260813
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.
