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.0b260709.tar.gz (13.6 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.0b260709.tar.gz.

File metadata

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

File hashes

Hashes for agent_framework_azure_ai_search-1.0.0b260709.tar.gz
Algorithm Hash digest
SHA256 07abb4639a6a6200131989b592645168838817a757ca9a086dffcc4b75019f39
MD5 12fb9d1b5ff611f141d2641703c188dc
BLAKE2b-256 1dd64a000fd65ba9211aa9c30a11fc5c01e5c511d56797653f2ad788493ae83b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for agent_framework_azure_ai_search-1.0.0b260709-py3-none-any.whl
Algorithm Hash digest
SHA256 75644b702261576c910300c0b7bc443e0bd51bcc8f50bfcf270714cb483dce4a
MD5 84109420203f5e0b08dd0c9a2035faa4
BLAKE2b-256 d9cb28e883e1fc888fb27a09f56326974d5ae880d7c16a2d4ee4ad0592ace786

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