Skip to main content

Azure AI Search integration for Microsoft Agent Framework.

Project description

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_framework_azure_ai_search-1.0.0b260630.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file agent_framework_azure_ai_search-1.0.0b260630.tar.gz.

File metadata

  • Download URL: agent_framework_azure_ai_search-1.0.0b260630.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","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}

File hashes

Hashes for agent_framework_azure_ai_search-1.0.0b260630.tar.gz
Algorithm Hash digest
SHA256 73c0b45f02b7407e35e8345fc287566768905baf8d4a135802ee7293bd1634aa
MD5 e03d0537c88d67d0ada241c576f778c2
BLAKE2b-256 d14c6c1b40c3ff8f829d261246324873310974f0b247984cd0d584545482b914

See more details on using hashes here.

File details

Details for the file agent_framework_azure_ai_search-1.0.0b260630-py3-none-any.whl.

File metadata

  • Download URL: agent_framework_azure_ai_search-1.0.0b260630-py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","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}

File hashes

Hashes for agent_framework_azure_ai_search-1.0.0b260630-py3-none-any.whl
Algorithm Hash digest
SHA256 eae3a9bcf6c8fe4816e80919df213d11cb366362e33ea62ee667bba20b9d8042
MD5 2419c4b243b2d31f40047bf50ccbe00a
BLAKE2b-256 85810dc087573df1de5ef9d1e01a8bacc1e05f6c83c93d8044669fcfedd36f50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page