-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Python: Feature/azure ai search agentic rag (search as separate package) #2328
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
eavanvalkenburg
merged 28 commits into
microsoft:main
from
farzad528:feature/azure-ai-search-agentic-rag-separate
Nov 20, 2025
Merged
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)
8de2673
address pablo coments
0cd48ab
update azure ai search pypi version to latest prev
farzad528 88886a3
Merge remote-tracking branch 'origin/main' into feature/azure-ai-sear…
farzad528 a9244c2
init update
farzad528 5aa6c32
Merge branch 'microsoft:main' into feature/azure-ai-search-agentic-rag
farzad528 c0d2e51
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 c7d1e79
Fix MyPy type annotation errors in search provider
farzad528 69e5841
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 df2aaac
Fix DEFAULT_CONTEXT_PROMPT MyPy error and update test
farzad528 f9e6cab
Merge remote-tracking branch 'origin/feature/azure-ai-search-agentic-…
farzad528 8043512
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 8923716
Merge branch 'main' into feature/azure-ai-search-agentic-rag
farzad528 316b39e
Merge branch 'microsoft:main' into feature/azure-ai-search-agentic-rag
farzad528 a02b1c7
Python: Move Azure AI Search to separate package per PR feedback
farzad528 be6b61f
Python: Clarify top_k parameter only applies to semantic mode
farzad528 f743aaa
Python: Add Knowledge Base output mode and retrieval reasoning effort…
farzad528 004a55c
effort and outputmode query params
farzad528 86ee4af
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 5d96845
Address PR review feedback for Azure AI Search context provider
farzad528 c2441bd
Merge origin/main into feature/azure-ai-search-agentic-rag-separate
farzad528 e78d6d7
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 0ba9b29
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 a2db26f
comments eduward
farzad528 b419269
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 97facd7
ed latest comments
farzad528 d1f4c60
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 aab0ebe
Merge branch 'main' into feature/azure-ai-search-agentic-rag-separate
farzad528 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
16
python/packages/aisearch/agent_framework_aisearch/__init__.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
914
python/packages/aisearch/agent_framework_aisearch/_search_provider.py
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.