agent-framework-mem0 1.0.0b260127__tar.gz

agent_framework_mem0-1.0.0b260127/LICENSE

@@ -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

agent_framework_mem0-1.0.0b260127/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: agent-framework-mem0
+Version: 1.0.0b260127
+Summary: Mem0 integration for Microsoft Agent Framework.
+Author-email: Microsoft <af-support@microsoft.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: agent-framework-core
+Requires-Dist: mem0ai>=1.0.0
+Project-URL: homepage, https://aka.ms/agent-framework
+Project-URL: issues, https://github.com/microsoft/agent-framework/issues
+Project-URL: release_notes, https://github.com/microsoft/agent-framework/releases?q=tag%3Apython-1&expanded=true
+Project-URL: source, https://github.com/microsoft/agent-framework/tree/main/python
+
+# Get Started with Microsoft Agent Framework Mem0
+
+Please install this package via pip:
+
+```bash
+pip install agent-framework-mem0 --pre
+```
+
+## Memory Context Provider
+
+The Mem0 context provider enables persistent memory capabilities for your agents, allowing them to remember user preferences and conversation context across different sessions and threads.
+
+### Basic Usage Example
+
+See the [Mem0 basic example](https://github.com/microsoft/agent-framework/tree/main/python/samples/getting_started/context_providers/mem0/mem0_basic.py) which demonstrates:
+
+- Setting up an agent with Mem0 context provider
+- Teaching the agent user preferences
+- Retrieving information using remembered context across new threads
+- Persistent memory
+

agent_framework_mem0-1.0.0b260127/README.md

@@ -0,0 +1,20 @@
+# Get Started with Microsoft Agent Framework Mem0
+
+Please install this package via pip:
+
+```bash
+pip install agent-framework-mem0 --pre
+```
+
+## Memory Context Provider
+
+The Mem0 context provider enables persistent memory capabilities for your agents, allowing them to remember user preferences and conversation context across different sessions and threads.
+
+### Basic Usage Example
+
+See the [Mem0 basic example](https://github.com/microsoft/agent-framework/tree/main/python/samples/getting_started/context_providers/mem0/mem0_basic.py) which demonstrates:
+
+- Setting up an agent with Mem0 context provider
+- Teaching the agent user preferences
+- Retrieving information using remembered context across new threads
+- Persistent memory

agent_framework_mem0-1.0.0b260127/agent_framework_mem0/__init__.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import importlib.metadata
+
+from ._provider import Mem0Provider
+
+try:
+    __version__ = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0"  # Fallback for development mode
+
+__all__ = [
+    "Mem0Provider",
+    "__version__",
+]

agent_framework_mem0-1.0.0b260127/agent_framework_mem0/_provider.py

@@ -0,0 +1,229 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import sys
+from collections.abc import MutableSequence, Sequence
+from contextlib import AbstractAsyncContextManager
+from typing import Any, TypedDict
+
+from agent_framework import ChatMessage, Context, ContextProvider
+from agent_framework.exceptions import ServiceInitializationError
+from mem0 import AsyncMemory, AsyncMemoryClient
+
+if sys.version_info >= (3, 12):
+    from typing import override  # type: ignore # pragma: no cover
+else:
+    from typing_extensions import override  # type: ignore[import] # pragma: no cover
+
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, Self  # pragma: no cover
+else:
+    from typing_extensions import NotRequired, Self  # pragma: no cover
+
+
+# Type aliases for Mem0 search response formats (v1.1 and v2; v1 is deprecated, but matches the type definition for v2)
+class MemorySearchResponse_v1_1(TypedDict):
+    results: list[dict[str, Any]]
+    relations: NotRequired[list[dict[str, Any]]]
+
+
+MemorySearchResponse_v2 = list[dict[str, Any]]
+
+
+class Mem0Provider(ContextProvider):
+    """Mem0 Context Provider."""
+
+    def __init__(
+        self,
+        mem0_client: AsyncMemory | AsyncMemoryClient | None = None,
+        api_key: str | None = None,
+        application_id: str | None = None,
+        agent_id: str | None = None,
+        thread_id: str | None = None,
+        user_id: str | None = None,
+        scope_to_per_operation_thread_id: bool = False,
+        context_prompt: str = ContextProvider.DEFAULT_CONTEXT_PROMPT,
+    ) -> None:
+        """Initializes a new instance of the Mem0Provider class.
+
+        Args:
+            mem0_client: A pre-created Mem0 MemoryClient or None to create a default client.
+            api_key: The API key for authenticating with the Mem0 API. If not
+                provided, it will attempt to use the MEM0_API_KEY environment variable.
+            application_id: The application ID for scoping memories or None.
+            agent_id: The agent ID for scoping memories or None.
+            thread_id: The thread ID for scoping memories or None.
+            user_id: The user ID for scoping memories or None.
+            scope_to_per_operation_thread_id: Whether to scope memories to per-operation thread ID.
+            context_prompt: The prompt to prepend to retrieved memories.
+        """
+        should_close_client = False
+        if mem0_client is None:
+            mem0_client = AsyncMemoryClient(api_key=api_key)
+            should_close_client = True
+
+        self.api_key = api_key
+        self.application_id = application_id
+        self.agent_id = agent_id
+        self.thread_id = thread_id
+        self.user_id = user_id
+        self.scope_to_per_operation_thread_id = scope_to_per_operation_thread_id
+        self.context_prompt = context_prompt
+        self.mem0_client = mem0_client
+        self._per_operation_thread_id: str | None = None
+        self._should_close_client = should_close_client
+
+    async def __aenter__(self) -> "Self":
+        """Async context manager entry."""
+        if self.mem0_client and isinstance(self.mem0_client, AbstractAsyncContextManager):
+            await self.mem0_client.__aenter__()
+        return self
+
+    async def __aexit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: Any) -> None:
+        """Async context manager exit."""
+        if self._should_close_client and self.mem0_client and isinstance(self.mem0_client, AbstractAsyncContextManager):
+            await self.mem0_client.__aexit__(exc_type, exc_val, exc_tb)
+
+    async def thread_created(self, thread_id: str | None = None) -> None:
+        """Called when a new thread is created.
+
+        Args:
+            thread_id: The ID of the thread or None.
+        """
+        self._validate_per_operation_thread_id(thread_id)
+        self._per_operation_thread_id = self._per_operation_thread_id or thread_id
+
+    @override
+    async def invoked(
+        self,
+        request_messages: ChatMessage | Sequence[ChatMessage],
+        response_messages: ChatMessage | Sequence[ChatMessage] | None = None,
+        invoke_exception: Exception | None = None,
+        **kwargs: Any,
+    ) -> None:
+        self._validate_filters()
+
+        request_messages_list = (
+            [request_messages] if isinstance(request_messages, ChatMessage) else list(request_messages)
+        )
+        response_messages_list = (
+            [response_messages]
+            if isinstance(response_messages, ChatMessage)
+            else list(response_messages)
+            if response_messages
+            else []
+        )
+        messages_list = [*request_messages_list, *response_messages_list]
+
+        messages: list[dict[str, str]] = [
+            {"role": message.role.value, "content": message.text}
+            for message in messages_list
+            if message.role.value in {"user", "assistant", "system"} and message.text and message.text.strip()
+        ]
+
+        if messages:
+            await self.mem0_client.add(  # type: ignore[misc]
+                messages=messages,
+                user_id=self.user_id,
+                agent_id=self.agent_id,
+                run_id=self._per_operation_thread_id if self.scope_to_per_operation_thread_id else self.thread_id,
+                metadata={"application_id": self.application_id},
+            )
+
+    @override
+    async def invoking(self, messages: ChatMessage | MutableSequence[ChatMessage], **kwargs: Any) -> Context:
+        """Called before invoking the AI model to provide context.
+
+        Args:
+            messages: List of new messages in the thread.
+
+        Keyword Args:
+            **kwargs: not used at present.
+
+        Returns:
+            Context: Context object containing instructions with memories.
+        """
+        self._validate_filters()
+        messages_list = [messages] if isinstance(messages, ChatMessage) else list(messages)
+        input_text = "\n".join(msg.text for msg in messages_list if msg and msg.text and msg.text.strip())
+
+        # Validate input text is not empty before searching (possible for function approval responses)
+        if not input_text.strip():
+            return Context(messages=None)
+
+        # Build filters from init parameters
+        filters = self._build_filters()
+
+        search_response: MemorySearchResponse_v1_1 | MemorySearchResponse_v2 = await self.mem0_client.search(  # type: ignore[misc]
+            query=input_text,
+            filters=filters,
+        )
+
+        # Depending on the API version, the response schema varies slightly
+        if isinstance(search_response, list):
+            memories = search_response
+        elif isinstance(search_response, dict) and "results" in search_response:
+            memories = search_response["results"]
+        else:
+            # Fallback for unexpected schema - return response as text as-is
+            memories = [search_response]
+
+        line_separated_memories = "\n".join(memory.get("memory", "") for memory in memories)
+
+        return Context(
+            messages=[ChatMessage(role="user", text=f"{self.context_prompt}\n{line_separated_memories}")]
+            if line_separated_memories
+            else None
+        )
+
+    def _validate_filters(self) -> None:
+        """Validates that at least one filter is provided.
+
+        Raises:
+            ServiceInitializationError: If no filters are provided.
+        """
+        if not self.agent_id and not self.user_id and not self.application_id and not self.thread_id:
+            raise ServiceInitializationError(
+                "At least one of the filters: agent_id, user_id, application_id, or thread_id is required."
+            )
+
+    def _build_filters(self) -> dict[str, Any]:
+        """Build search filters from initialization parameters.
+
+        Returns:
+            Filter dictionary for mem0 v2 search API containing initialization parameters.
+            In the v2 API, filters holds the user_id, agent_id, run_id (thread_id), and app_id
+            (application_id) which are required for scoping memory search operations.
+        """
+        filters: dict[str, Any] = {}
+
+        if self.user_id:
+            filters["user_id"] = self.user_id
+        if self.agent_id:
+            filters["agent_id"] = self.agent_id
+        if self.scope_to_per_operation_thread_id and self._per_operation_thread_id:
+            filters["run_id"] = self._per_operation_thread_id
+        elif self.thread_id:
+            filters["run_id"] = self.thread_id
+        if self.application_id:
+            filters["app_id"] = self.application_id
+
+        return filters
+
+    def _validate_per_operation_thread_id(self, thread_id: str | None) -> None:
+        """Validates that a new thread ID doesn't conflict with an existing one when scoped.
+
+        Args:
+            thread_id: The new thread ID or None.
+
+        Raises:
+            ValueError: If a new thread ID is provided when one already exists.
+        """
+        if (
+            self.scope_to_per_operation_thread_id
+            and thread_id
+            and self._per_operation_thread_id
+            and thread_id != self._per_operation_thread_id
+        ):
+            raise ValueError(
+                "Mem0Provider can only be used with one thread at a time when scope_to_per_operation_thread_id is True."
+            )

agent_framework_mem0-1.0.0b260127/pyproject.toml

@@ -0,0 +1,89 @@
+[project]
+name = "agent-framework-mem0"
+description = "Mem0 integration for Microsoft Agent Framework."
+authors = [{ name = "Microsoft", email = "af-support@microsoft.com"}]
+readme = "README.md"
+requires-python = ">=3.10"
+version = "1.0.0b260127"
+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",
+    "mem0ai>=1.0.0",
+]
+
+[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"
+
+[tool.coverage.run]
+omit = [
+    "**/__init__.py"
+]
+
+[tool.pyright]
+extends = "../../pyproject.toml"
+
+
+[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_mem0"]
+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_mem0"
+test = "pytest --cov=agent_framework_mem0 --cov-report=term-missing:skip-covered tests"
+
+[build-system]
+requires = ["flit-core >= 3.11,<4.0"]
+build-backend = "flit_core.buildapi"