ollama-haystack 2.3.0__tar.gz → 2.4.0__tar.gz

{ollama_haystack-2.3.0 → ollama_haystack-2.4.0}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [integrations/ollama-v2.3.0] - 2025-01-29
+
+### 🚀 Features
+
+- Add `response_format` param to `OllamaChatGenerator` (#1326)
+
+
 ## [integrations/ollama-v2.2.0] - 2025-01-16
 
 ### 🚀 Features

{ollama_haystack-2.3.0 → ollama_haystack-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ollama-haystack
-Version: 2.3.0
+Version: 2.4.0
 Summary: An integration between the Ollama LLM framework and Haystack
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/ollama#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
@@ -15,9 +15,10 @@ Classifier: Programming Language :: Python :: 3.9
 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 :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: haystack-ai
 Requires-Dist: ollama>=0.4.0
 Requires-Dist: pydantic

{ollama_haystack-2.3.0 → ollama_haystack-2.4.0}/pyproject.toml

@@ -7,7 +7,7 @@ name = "ollama-haystack"
 dynamic = ["version"]
 description = 'An integration between the Ollama LLM framework and Haystack'
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = "Apache-2.0"
 keywords = []
 authors = [
@@ -23,6 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
 ]
@@ -51,7 +52,6 @@ dependencies = [
     "pytest",
     "pytest-rerunfailures",
     "haystack-pydoc-tools",
-    "jsonschema",  # needed for Tool
 ]
 [tool.hatch.envs.default.scripts]
 test = "pytest {args:tests}"
@@ -62,10 +62,6 @@ cov = ["test-cov", "cov-report"]
 cov-retry = ["test-cov-retry", "cov-report"]
 docs = ["pydoc-markdown pydoc/config.yml"]
 
-[[tool.hatch.envs.all.matrix]]
-python = ["3.9", "3.10", "3.11", "3.12"]
-
-
 [tool.hatch.envs.lint]
 installer = "uv"
 detached = true

{ollama_haystack-2.3.0 → ollama_haystack-2.4.0}/src/haystack_integrations/components/generators/ollama/chat/chat_generator.py

@@ -41,6 +41,60 @@ def _convert_chatmessage_to_ollama_format(message: ChatMessage) -> Dict[str, Any
     return ollama_msg
 
 
+def _convert_ollama_meta_to_openai_format(intput_response_dict: Dict) -> Dict:
+    """
+    Internal function to convert Ollama metadata to OpenAI format.
+
+    All fields that are not part of the OpenAI metadata are left unchanged in the returned dict.
+
+    Example Ollama metadata:
+    {
+        'model': 'phi4:14b-q4_K_M',
+        'created_at': '2025-03-09T18:38:33.004185821Z',
+        'done': True,
+        'done_reason': 'stop',
+        'total_duration': 86627206961,
+        'load_duration': 23585622554,
+        'prompt_eval_count': 26,
+        'prompt_eval_duration': 3426000000,
+        'eval_count': 298,
+        'eval_duration': 4799921000
+    }
+
+    Example OpenAI metadata:
+    {
+        'model': 'phi4:14b-q4_K_M',
+        'finish_reason': 'stop',
+        'usage': {
+            'completion_tokens': 298,
+            'prompt_tokens': 26,
+            'total_tokens': 324,
+        }
+        'completion_start_time': '2025-03-09T18:38:33.004185821Z',
+        'done': True,
+        'total_duration': 86627206961,
+        'load_duration': 23585622554,
+        'prompt_eval_duration': 3426000000,
+        'eval_duration': 4799921000,
+    }
+    """
+    meta = {key: value for key, value in intput_response_dict.items() if key != "message"}
+
+    if "done_reason" in meta:
+        meta["finish_reason"] = meta.pop("done_reason")
+    if "created_at" in meta:
+        meta["completion_start_time"] = meta.pop("created_at")
+    if "eval_count" in meta and "prompt_eval_count" in meta:
+        eval_count = meta.pop("eval_count")
+        prompt_eval_count = meta.pop("prompt_eval_count")
+        meta["usage"] = {
+            "completion_tokens": eval_count,
+            "prompt_tokens": prompt_eval_count,
+            "total_tokens": eval_count + prompt_eval_count,
+        }
+    return meta
+
+
 def _convert_ollama_response_to_chatmessage(ollama_response: "ChatResponse") -> ChatMessage:
     """
     Converts the non-streaming response from the Ollama API to a ChatMessage with assistant role.
@@ -60,7 +114,7 @@ def _convert_ollama_response_to_chatmessage(ollama_response: "ChatResponse") ->
 
     message = ChatMessage.from_assistant(text=text, tool_calls=tool_calls)
 
-    message.meta.update({key: value for key, value in response_dict.items() if key != "message"})
+    message._meta = _convert_ollama_meta_to_openai_format(response_dict)
     return message
 
 

{ollama_haystack-2.3.0 → ollama_haystack-2.4.0}/tests/test_chat_generator.py

@@ -97,13 +97,12 @@ def test_convert_chatmessage_to_ollama_invalid():
 
 
 def test_convert_ollama_response_to_chatmessage():
-    model = "some_model"
-
     ollama_response = ChatResponse(
-        model=model,
+        model="some_model",
         created_at="2023-12-12T14:13:43.416799Z",
         message={"role": "assistant", "content": "Hello! How are you today?"},
         done=True,
+        done_reason="stop",
         total_duration=5191566416,
         load_duration=2154458,
         prompt_eval_count=26,
@@ -117,6 +116,22 @@ def test_convert_ollama_response_to_chatmessage():
     assert observed.role == "assistant"
     assert observed.text == "Hello! How are you today?"
 
+    assert observed.meta == {
+        "finish_reason": "stop",
+        "usage": {
+            "completion_tokens": 298,
+            "prompt_tokens": 26,
+            "total_tokens": 324,
+        },
+        "completion_start_time": "2023-12-12T14:13:43.416799Z",
+        "load_duration": 2154458,
+        "total_duration": 5191566416,
+        "eval_duration": 4799921000,
+        "prompt_eval_duration": 383809000,
+        "done": True,
+        "model": "some_model",
+    }
+
 
 def test_convert_ollama_response_to_chatmessage_with_tools():
     model = "some_model"
@@ -215,7 +230,8 @@ class TestOllamaChatGenerator:
             response_format={"type": "object", "properties": {"name": {"type": "string"}, "age": {"type": "number"}}},
         )
         data = component.to_dict()
-        assert data == {
+
+        expected_dict = {
             "type": "haystack_integrations.components.generators.ollama.chat.chat_generator.OllamaChatGenerator",
             "init_parameters": {
                 "timeout": 120,
@@ -249,6 +265,17 @@ class TestOllamaChatGenerator:
             },
         }
 
+        # add outputs_to_string, inputs_from_state and outputs_to_state tool parameters for compatibility with
+        # haystack-ai>=2.12.0
+        if hasattr(tool, "outputs_to_string"):
+            expected_dict["init_parameters"]["tools"][0]["data"]["outputs_to_string"] = tool.outputs_to_string
+        if hasattr(tool, "inputs_from_state"):
+            expected_dict["init_parameters"]["tools"][0]["data"]["inputs_from_state"] = tool.inputs_from_state
+        if hasattr(tool, "outputs_to_state"):
+            expected_dict["init_parameters"]["tools"][0]["data"]["outputs_to_state"] = tool.outputs_to_state
+
+        assert data == expected_dict
+
     def test_from_dict(self):
         tool = Tool(
             name="name",