Python : Ollama Connector for Agent Framework

python/packages/core/agent_framework/_types.py

@@ -2051,6 +2051,15 @@ def text(self) -> str:
         """
         return " ".join(content.text for content in self.contents if isinstance(content, TextContent))
 
+    @property
+    def reasoning(self) -> str:
+        """Returns the reasoning content of the message.
+
+        Remarks:
+            This property concatenates the text of all TextReasoningContent objects in Contents.
+        """
+        return " ".join(content.text for content in self.contents if isinstance(content, TextReasoningContent))
+
 
 # region ChatResponse
 
@@ -2440,6 +2449,11 @@ def text(self) -> str:
         """Returns the concatenated text of all messages in the response."""
         return ("\n".join(message.text for message in self.messages if isinstance(message, ChatMessage))).strip()
 
+    @property
+    def reasoning(self) -> str:
+        """Returns the concatenated reasoning of all messages in the response."""
+        return ("\n".join(message.reasoning for message in self.messages if isinstance(message, ChatMessage))).strip()
+
     def __str__(self) -> str:
         return self.text
 
@@ -2575,6 +2589,11 @@ def text(self) -> str:
         """Returns the concatenated text of all contents in the update."""
         return "".join(content.text for content in self.contents if isinstance(content, TextContent))
 
+    @property
+    def reasoning(self) -> str:
+        """Returns the reasoning content of the message."""
+        return " ".join(content.text for content in self.contents if isinstance(content, TextReasoningContent))
+
     def __str__(self) -> str:
         return self.text
 
@@ -2684,6 +2703,11 @@ def text(self) -> str:
         """Get the concatenated text of all messages."""
         return "".join(msg.text for msg in self.messages) if self.messages else ""
 
+    @property
+    def reasoning(self) -> str:
+        """Get the concatenated reasoning of all messages."""
+        return " ".join(msg.reasoning for msg in self.messages) if self.messages else ""
+
     @property
     def user_input_requests(self) -> list[UserInputRequestContents]:
         """Get all BaseUserInputRequest messages from the response."""
@@ -2850,6 +2874,11 @@ def text(self) -> str:
             else ""
         )
 
+    @property
+    def reasoning(self) -> str:
+        """Get the concatenated text of all TextReasoningContent objects in contents."""
+        return " ".join(content.text for content in self.contents if isinstance(content, TextReasoningContent))
+
     @property
     def user_input_requests(self) -> list[UserInputRequestContents]:
         """Get all BaseUserInputRequest messages from the response."""

python/packages/core/agent_framework/ollama/__init__.py

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import importlib
+from typing import Any
+
+PACKAGE_NAME = "agent_framework_ollama"
+PACKAGE_EXTRA = "ollama"
+_IMPORTS = [
+    "OllamaChatClient",
+    "OllamaSettings",
+    "__version__",
+]
+
+
+def __getattr__(name: str) -> Any:
+    if name in _IMPORTS:
+        try:
+            return getattr(importlib.import_module(PACKAGE_NAME), name)
+        except ModuleNotFoundError as exc:
+            raise ModuleNotFoundError(
+                f"The '{PACKAGE_EXTRA}' extra is not installed, please do `pip install agent-framework-{PACKAGE_EXTRA}`"
+            ) from exc
+    raise AttributeError(f"Module {PACKAGE_NAME} has no attribute {name}.")
+
+
+def __dir__() -> list[str]:
+    return _IMPORTS

python/packages/core/agent_framework/ollama/__init__.pyi

@@ -0,0 +1,13 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from agent_framework_ollama import (
+    OllamaChatClient,
+    OllamaSettings,
+    __version__,
+)
+
+__all__ = [
+    "OllamaChatClient",
+    "OllamaSettings",
+    "__version__",
+]

python/packages/core/tests/core/test_types.py

@@ -498,6 +498,26 @@ def test_chat_message_contents():
     assert message.text == "Hello, how are you? I'm fine, thank you!"
 
 
+def test_chat_message_reasoning_contents():
+    """Test the ChatMessage class to ensure it initializes correctly with contents."""
+    # Create a ChatMessage with a role and multiple contents
+    content1 = TextReasoningContent("For this task, we need to consider the following...")
+    content2 = TextReasoningContent("And then we can proceed with the next steps.")
+    message = ChatMessage(role="user", contents=[content1, content2])
+
+    # Check the type and content
+    assert message.role == Role.USER
+    assert len(message.contents) == 2
+    assert isinstance(message.contents[0], TextReasoningContent)
+    assert isinstance(message.contents[1], TextReasoningContent)
+    assert message.contents[0].text == "For this task, we need to consider the following..."
+    assert message.contents[1].text == "And then we can proceed with the next steps."
+    assert (
+        message.reasoning
+        == "For this task, we need to consider the following... And then we can proceed with the next steps."
+    )
+
+
 def test_chat_message_with_chatrole_instance():
     m = ChatMessage(role=Role.USER, text="hi")
     assert m.role == Role.USER
@@ -646,6 +666,7 @@ def test_chat_response_updates_to_chat_response_multiple():
     # Check the type and content
     assert len(chat_response.messages) == 1
     assert chat_response.text == "I'm doing well,  thank you!"
+    assert chat_response.reasoning == "Additional context"
     assert isinstance(chat_response.messages[0], ChatMessage)
     assert len(chat_response.messages[0].contents) == 3
     assert chat_response.messages[0].message_id == "1"

python/packages/ollama/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

python/packages/ollama/README.md

@@ -0,0 +1,9 @@
+# Get Started with Microsoft Agent Framework Ollama
+
+Please install this package as the extra for `agent-framework`:
+
+```bash
+pip install agent-framework-ollama --pre
+```
+
+and see the [README](https://github.com/microsoft/agent-framework/tree/main/python/README.md) for more information.

python/packages/ollama/agent_framework_ollama/__init__.py

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