Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ed8af31
Python: Fix pyright errors and move search provider to core (#1546)
Oct 29, 2025
8de2673
address pablo coments
Nov 2, 2025
0cd48ab
update azure ai search pypi version to latest prev
farzad528 Nov 17, 2025
88886a3
Merge remote-tracking branch 'origin/main' into feature/azure-ai-sear…
farzad528 Nov 17, 2025
a9244c2
init update
farzad528 Nov 17, 2025
5aa6c32
Merge branch 'microsoft:main' into feature/azure-ai-search-agentic-rag
farzad528 Nov 17, 2025
c0d2e51
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 Nov 17, 2025
c7d1e79
Fix MyPy type annotation errors in search provider
farzad528 Nov 17, 2025
69e5841
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 Nov 17, 2025
df2aaac
Fix DEFAULT_CONTEXT_PROMPT MyPy error and update test
farzad528 Nov 17, 2025
f9e6cab
Merge remote-tracking branch 'origin/feature/azure-ai-search-agentic-…
farzad528 Nov 17, 2025
8043512
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 Nov 17, 2025
8923716
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 Nov 17, 2025
316b39e
Merge branch 'microsoft:main' into feature/azure-ai-search-agentic-rag
farzad528 Nov 18, 2025
a02b1c7
Python: Move Azure AI Search to separate package per PR feedback
farzad528 Nov 19, 2025
be6b61f
Python: Clarify top_k parameter only applies to semantic mode
farzad528 Nov 19, 2025
f743aaa
Python: Add Knowledge Base output mode and retrieval reasoning effort…
farzad528 Nov 19, 2025
004a55c
effort and outputmode query params
farzad528 Nov 19, 2025
86ee4af
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 Nov 19, 2025
5d96845
Address PR review feedback for Azure AI Search context provider
farzad528 Nov 19, 2025
c2441bd
Merge origin/main into feature/azure-ai-search-agentic-rag-separate
farzad528 Nov 19, 2025
e78d6d7
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 Nov 20, 2025
0ba9b29
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 Nov 20, 2025
a2db26f
comments eduward
farzad528 Nov 20, 2025
b419269
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 Nov 20, 2025
97facd7
ed latest comments
farzad528 Nov 20, 2025
d1f4c60
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 Nov 20, 2025
aab0ebe
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 Nov 20, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions python/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ AZURE_AI_PROJECT_ENDPOINT=""
AZURE_AI_MODEL_DEPLOYMENT_NAME=""
# Bing connection for web search (optional, used by samples with web search)
BING_CONNECTION_ID=""
# Azure AI Search (optional, used by AzureAISearchContextProvider samples)
AZURE_SEARCH_ENDPOINT=""
AZURE_SEARCH_API_KEY=""
AZURE_SEARCH_INDEX_NAME=""
AZURE_SEARCH_SEMANTIC_CONFIG=""
AZURE_SEARCH_KNOWLEDGE_BASE_NAME=""
# Note: For agentic mode Knowledge Bases, also set AZURE_OPENAI_ENDPOINT below
# (different from AZURE_AI_PROJECT_ENDPOINT - Knowledge Base needs OpenAI endpoint for model calls)
# OpenAI
OPENAI_API_KEY=""
OPENAI_CHAT_MODEL_ID=""
Expand Down
21 changes: 21 additions & 0 deletions python/packages/aisearch/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Microsoft Corporation.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
23 changes: 23 additions & 0 deletions python/packages/aisearch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Get Started with Microsoft Agent Framework Azure AI Search

Please install this package via pip:

```bash
pip install agent-framework-aisearch --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

### Basic Usage Example

See the [Azure AI Search context provider examples](https://github.com/microsoft/agent-framework/tree/main/python/samples/getting_started/agents/azure_ai/) 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
16 changes: 16 additions & 0 deletions python/packages/aisearch/agent_framework_aisearch/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copyright (c) Microsoft. All rights reserved.

import importlib.metadata

from ._search_provider import AzureAISearchContextProvider, AzureAISearchSettings

try:
__version__ = importlib.metadata.version(__name__)
except importlib.metadata.PackageNotFoundError:
__version__ = "0.0.0" # Fallback for development mode

__all__ = [
"AzureAISearchContextProvider",
"AzureAISearchSettings",
"__version__",
]
914 changes: 914 additions & 0 deletions python/packages/aisearch/agent_framework_aisearch/_search_provider.py

Large diffs are not rendered by default.

91 changes: 91 additions & 0 deletions python/packages/aisearch/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
[project]
name = "agent-framework-aisearch"
description = "Azure AI Search integration for Microsoft Agent Framework."
authors = [{ name = "Microsoft", email = "af-support@microsoft.com"}]
readme = "README.md"
requires-python = ">=3.10"
version = "1.0.0b251118"
license-files = ["LICENSE"]
urls.homepage = "https://aka.ms/agent-framework"
urls.source = "https://github.com/microsoft/agent-framework/tree/main/python"
urls.release_notes = "https://github.com/microsoft/agent-framework/releases?q=tag%3Apython-1&expanded=true"
urls.issues = "https://github.com/microsoft/agent-framework/issues"
classifiers = [
"License :: OSI Approved :: MIT License",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
"Typing :: Typed",
]
dependencies = [
"agent-framework-core",
"azure-search-documents==11.7.0b2",
]

[tool.uv]
prerelease = "if-necessary-or-explicit"
environments = [
"sys_platform == 'darwin'",
"sys_platform == 'linux'",
"sys_platform == 'win32'"
]

[tool.uv-dynamic-versioning]
fallback-version = "0.0.0"

[tool.pytest.ini_options]
testpaths = 'tests'
addopts = "-ra -q -r fEX"
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"
filterwarnings = [
"ignore:Support for class-based `config` is deprecated:DeprecationWarning:pydantic.*"
]
timeout = 120

[tool.ruff]
extend = "../../pyproject.toml"
exclude = ["examples"]

[tool.coverage.run]
omit = [
"**/__init__.py"
]

[tool.pyright]
extends = "../../pyproject.toml"
exclude = ['tests']

[tool.mypy]
plugins = ['pydantic.mypy']
strict = true
python_version = "3.10"
ignore_missing_imports = true
disallow_untyped_defs = true
no_implicit_optional = true
check_untyped_defs = true
warn_return_any = true
show_error_codes = true
warn_unused_ignores = false
disallow_incomplete_defs = true
disallow_untyped_decorators = true

[tool.bandit]
targets = ["agent_framework_aisearch"]
exclude_dirs = ["tests"]

[tool.poe]
executor.type = "uv"
include = "../../shared_tasks.toml"
[tool.poe.tasks]
mypy = "mypy --config-file $POE_ROOT/pyproject.toml agent_framework_aisearch"
test = "pytest --cov=agent_framework_aisearch --cov-report=term-missing:skip-covered tests"

[build-system]
requires = ["flit-core >= 3.11,<4.0"]
build-backend = "flit_core.buildapi"
Loading
Loading