huggingface-api-haystack 0.3.0__tar.gz → 0.5.0__tar.gz

huggingface_api_haystack-0.5.0/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## [unreleased]
+
+### 🧪 Testing
+
+- Trust test modules under Haystack 3.0's deserialization allowlist (#3537)
+- Make Tool/Agent serialization assertions version-agnostic for Haystack 2.x/3.x (#3533)
+
+### 🧹 Chores
+
+- Support sync streaming callbacks in async contexts for Haystack 2.x/3.x compatibility (#3534)
+
+
+## [integrations/huggingface_api-v0.3.0] - 2026-06-26
+
+### 🐛 Bug Fixes
+
+- Validate top_k in HuggingFaceTEIRanker (#3503)
+
+### 🧪 Testing
+
+- Improve del_hf_env_vars fixture (#3428)
+
+### 🧹 Chores
+
+- Improve consistency of integrations folder structure (#3430)
+
+
+## [integrations/huggingface_api-v0.2.0] - 2026-06-05
+
+### 🚀 Features
+
+- Move HuggingFaceTEIRanker from Haystack (#3407)
+
+### 📚 Documentation
+
+- Document raised exceptions in HF API components (#3406)
+
+
+## [integrations/huggingface_api-v0.1.0] - 2026-06-05
+
+### 🚀 Features
+
+- Move HF API components to core integrations (#3403)
+
+<!-- generated by git-cliff -->

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: huggingface-api-haystack
-Version: 0.3.0
+Version: 0.5.0
 Summary: Haystack integration for Hugging Face API
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/huggingface_api#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
@@ -28,7 +28,7 @@ Description-Content-Type: text/markdown
 [![PyPI - Version](https://img.shields.io/pypi/v/huggingface-api-haystack.svg)](https://pypi.org/project/huggingface-api-haystack)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/huggingface-api-haystack.svg)](https://pypi.org/project/huggingface-api-haystack)
 
-- [Integration page](https://haystack.deepset.ai/integrations/huggingface_api)
+- [Integration page](https://haystack.deepset.ai/integrations/huggingface-api)
 - [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/huggingface_api/CHANGELOG.md)
 
 ---
@@ -37,4 +37,4 @@ Description-Content-Type: text/markdown
 
 Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
 
-To run integration tests locally, you need to export the `HF_API_TOKEN` environment variable.
+To run integration tests locally, you need to export the `HF_TOKEN` environment variable.

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/README.md

@@ -3,7 +3,7 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/huggingface-api-haystack.svg)](https://pypi.org/project/huggingface-api-haystack)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/huggingface-api-haystack.svg)](https://pypi.org/project/huggingface-api-haystack)
 
-- [Integration page](https://haystack.deepset.ai/integrations/huggingface_api)
+- [Integration page](https://haystack.deepset.ai/integrations/huggingface-api)
 - [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/huggingface_api/CHANGELOG.md)
 
 ---
@@ -12,4 +12,4 @@
 
 Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
 
-To run integration tests locally, you need to export the `HF_API_TOKEN` environment variable.
+To run integration tests locally, you need to export the `HF_TOKEN` environment variable.

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/pyproject.toml

@@ -132,6 +132,7 @@ ignore = [
     "PLR0912",
     "PLR0913",
     "PLR0915",
+    "PLR0917",
     # Allow `Any` type - used legitimately for dynamic types and SDK boundaries
     "ANN401",
 ]

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/src/haystack_integrations/components/generators/huggingface_api/chat/chat_generator.py

@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+import inspect
 import json
 from collections.abc import AsyncIterable, Iterable
 from datetime import datetime, timezone
@@ -10,7 +11,6 @@ from typing import Any, Union
 from haystack import component, default_from_dict, default_to_dict, logging
 from haystack.components.generators.utils import _convert_streaming_chunks_to_chat_message, _normalize_messages
 from haystack.dataclasses import (
-    AsyncStreamingCallbackT,
     ChatMessage,
     ComponentInfo,
     ReasoningContent,
@@ -505,7 +505,9 @@ class HuggingFaceAPIChatGenerator:
             A list of ChatMessage objects representing the input messages. If a string is provided, it is converted
             to a list containing a ChatMessage with user role.
         :param generation_kwargs:
-            Additional keyword arguments for text generation.
+            Additional keyword arguments for text generation. These are merged per key with the
+            `generation_kwargs` passed at initialization: keys provided here take precedence, keys set only
+            at initialization are kept.
         :param tools:
             A list of tools or a Toolset for which the model can prepare calls. If set, it will override
             the `tools` parameter set during component initialization. This parameter can accept either a
@@ -565,7 +567,9 @@ class HuggingFaceAPIChatGenerator:
             A list of ChatMessage objects representing the input messages. If a string is provided, it is converted
             to a list containing a ChatMessage with user role.
         :param generation_kwargs:
-            Additional keyword arguments for text generation.
+            Additional keyword arguments for text generation. These are merged per key with the
+            `generation_kwargs` passed at initialization: keys provided here take precedence, keys set only
+            at initialization are kept.
         :param tools:
             A list of tools or a Toolset for which the model can prepare calls. If set, it will override the `tools`
             parameter set during component initialization. This parameter can accept either a list of `Tool` objects
@@ -680,7 +684,7 @@ class HuggingFaceAPIChatGenerator:
         self,
         messages: list[dict[str, str]],
         generation_kwargs: dict[str, Any],
-        streaming_callback: AsyncStreamingCallbackT,
+        streaming_callback: StreamingCallbackT,
     ) -> dict[str, list[ChatMessage]]:
         api_output: AsyncIterable[ChatCompletionStreamOutput] = await self._async_client.chat_completion(
             messages,
@@ -696,7 +700,10 @@ class HuggingFaceAPIChatGenerator:
                 chunk=chunk, previous_chunks=streaming_chunks, component_info=component_info
             )
             streaming_chunks.append(stream_chunk)
-            await streaming_callback(stream_chunk)
+            # sync callbacks are allowed in async contexts with Haystack >= 3.0, so only await async ones
+            callback_result = streaming_callback(stream_chunk)
+            if inspect.isawaitable(callback_result):
+                await callback_result
 
         message = _convert_streaming_chunks_to_chat_message(chunks=streaming_chunks)
         if message.meta.get("usage") is None:

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/src/haystack_integrations/components/rankers/huggingface_api/ranker.py

@@ -108,6 +108,7 @@ class HuggingFaceTEIRanker:
             self,
             url=self.url,
             top_k=self.top_k,
+            raw_scores=self.raw_scores,
             timeout=self.timeout,
             token=self.token,
             max_retries=self.max_retries,

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/tests/conftest.py

@@ -27,3 +27,13 @@ def del_hf_env_vars_if_empty(monkeypatch):
     for var in ("HF_API_TOKEN", "HF_TOKEN"):
         if not os.environ.get(var, "").strip():
             monkeypatch.delenv(var, raising=False)
+
+
+@pytest.fixture(autouse=True)
+def allow_deserialization_of_test_modules(monkeypatch):
+    """
+    haystack-ai >= 3.0 refuses to deserialize classes and callables from modules outside its
+    trusted-module allowlist. Tools and callbacks defined in the test modules live outside that
+    allowlist, so trust them explicitly; haystack-ai 2.x ignores this environment variable.
+    """
+    monkeypatch.setenv("HAYSTACK_DESERIALIZATION_ALLOWLIST", "tests,test_*")

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/tests/test_chat_generator.py

@@ -270,20 +270,10 @@ class TestHuggingFaceAPIChatGenerator:
         assert init_params["token"] == {"env_vars": ["HF_API_TOKEN", "HF_TOKEN"], "strict": False, "type": "env_var"}
         assert init_params["generation_kwargs"] == {"temperature": 0.6, "stop": ["stop", "words"], "max_tokens": 512}
         assert init_params["streaming_callback"] is None
-        assert init_params["tools"] == [
-            {
-                "type": "haystack.tools.tool.Tool",
-                "data": {
-                    "description": "description",
-                    "function": "builtins.print",
-                    "inputs_from_state": None,
-                    "name": "name",
-                    "outputs_to_state": None,
-                    "outputs_to_string": None,
-                    "parameters": {"x": {"type": "string"}},
-                },
-            }
-        ]
+
+        # deserializing the serialized component must reproduce the original tool
+        loaded = HuggingFaceAPIChatGenerator.from_dict(result)
+        assert loaded.tools == [tool]
 
     def test_from_dict(self, mock_check_valid_model):
         tool = Tool(name="name", description="description", parameters={"x": {"type": "string"}}, function=print)
@@ -323,6 +313,11 @@ class TestHuggingFaceAPIChatGenerator:
         pipeline.add_component("generator", generator)
 
         pipeline_dict = pipeline.to_dict()
+
+        # the Tool serialization format is owned by haystack-ai and varies across its versions; the
+        # dumps/loads round-trip below covers the tools, so exclude them from the pinned-dict comparison
+        tools_entries = pipeline_dict["components"]["generator"]["init_parameters"].pop("tools")
+        assert len(tools_entries) == 1
         assert pipeline_dict == {
             "metadata": {},
             "max_runs_per_component": 100,
@@ -337,20 +332,6 @@ class TestHuggingFaceAPIChatGenerator:
                         "token": {"type": "env_var", "env_vars": ["ENV_VAR"], "strict": False},
                         "generation_kwargs": {"temperature": 0.6, "stop": ["stop", "words"], "max_tokens": 512},
                         "streaming_callback": None,
-                        "tools": [
-                            {
-                                "type": "haystack.tools.tool.Tool",
-                                "data": {
-                                    "inputs_from_state": None,
-                                    "name": "name",
-                                    "outputs_to_state": None,
-                                    "outputs_to_string": None,
-                                    "description": "description",
-                                    "parameters": {"x": {"type": "string"}},
-                                    "function": "builtins.print",
-                                },
-                            }
-                        ],
                     },
                 }
             },
@@ -393,6 +374,19 @@ class TestHuggingFaceAPIChatGenerator:
         assert len(response["replies"]) == 1
         assert [isinstance(reply, ChatMessage) for reply in response["replies"]]
 
+    def test_run_with_generation_kwargs(self, mock_check_valid_model, mock_chat_completion, chat_messages):
+        generator = HuggingFaceAPIChatGenerator(
+            api_type=HFGenerationAPIType.SERVERLESS_INFERENCE_API,
+            api_params={"model": "meta-llama/Llama-2-13b-chat-hf"},
+            generation_kwargs={"max_tokens": 100, "temperature": 0.5},
+        )
+
+        generator.run(messages=chat_messages, generation_kwargs={"temperature": 0.9})
+
+        _, kwargs = mock_chat_completion.call_args
+        assert kwargs["max_tokens"] == 100
+        assert kwargs["temperature"] == 0.9
+
     def test_run_with_string_input(self, mock_check_valid_model, mock_chat_completion):
         generator = HuggingFaceAPIChatGenerator(
             api_type=HFGenerationAPIType.SERVERLESS_INFERENCE_API,
@@ -933,6 +927,22 @@ class TestHuggingFaceAPIChatGenerator:
         assert len(response["replies"]) == 1
         assert [isinstance(reply, ChatMessage) for reply in response["replies"]]
 
+    @pytest.mark.asyncio
+    async def test_run_async_with_generation_kwargs(
+        self, mock_check_valid_model, mock_chat_completion_async, chat_messages
+    ):
+        generator = HuggingFaceAPIChatGenerator(
+            api_type=HFGenerationAPIType.SERVERLESS_INFERENCE_API,
+            api_params={"model": "meta-llama/Llama-2-13b-chat-hf"},
+            generation_kwargs={"max_tokens": 100, "temperature": 0.5},
+        )
+
+        await generator.run_async(messages=chat_messages, generation_kwargs={"temperature": 0.9})
+
+        _, kwargs = mock_chat_completion_async.call_args
+        assert kwargs["max_tokens"] == 100
+        assert kwargs["temperature"] == 0.9
+
     @pytest.mark.asyncio
     async def test_run_async_with_string_input(self, mock_check_valid_model, mock_chat_completion_async):
         generator = HuggingFaceAPIChatGenerator(
@@ -1189,30 +1199,10 @@ class TestHuggingFaceAPIChatGenerator:
         )
         data = generator.to_dict()
 
-        expected_tools_data = {
-            "type": "haystack.tools.toolset.Toolset",
-            "data": {
-                "tools": [
-                    {
-                        "type": "haystack.tools.tool.Tool",
-                        "data": {
-                            "name": "weather",
-                            "description": "useful to determine the weather in a given location",
-                            "parameters": {
-                                "type": "object",
-                                "properties": {"city": {"type": "string"}},
-                                "required": ["city"],
-                            },
-                            "function": "tests.test_chat_generator.get_weather",
-                            "outputs_to_string": None,
-                            "inputs_from_state": None,
-                            "outputs_to_state": None,
-                        },
-                    }
-                ]
-            },
-        }
-        assert data["init_parameters"]["tools"] == expected_tools_data
+        # deserializing the serialized component must reproduce the original toolset
+        loaded = HuggingFaceAPIChatGenerator.from_dict(data)
+        assert isinstance(loaded.tools, Toolset)
+        assert list(loaded.tools) == list(toolset)
 
     def test_convert_tools_to_hfapi_tools(self):
         assert _convert_tools_to_hfapi_tools(None) is None

{huggingface_api_haystack-0.3.0 → huggingface_api_haystack-0.5.0}/tests/test_ranker.py

@@ -60,6 +60,14 @@ class TestHuggingFaceTEIRanker:
         assert data["init_parameters"]["max_retries"] == 4
         assert data["init_parameters"]["retry_status_codes"] == [500, 502]
 
+    def test_raw_scores_survives_a_serialization_round_trip(self, del_hf_env_vars_if_empty):
+        """raw_scores goes into the request payload, so losing it changes what the API returns."""
+        ranker = HuggingFaceTEIRanker(url="https://api.my-tei-service.com", raw_scores=True)
+
+        restored = HuggingFaceTEIRanker.from_dict(ranker.to_dict())
+
+        assert restored.raw_scores is True
+
     def test_from_dict(self, del_hf_env_vars_if_empty):
         """Test deserialization from dict with environment variable token"""
         data = {

huggingface_api_haystack-0.3.0/CHANGELOG.md

@@ -1,20 +0,0 @@
-# Changelog
-
-## [integrations/huggingface_api-v0.2.0] - 2026-06-05
-
-### 🚀 Features
-
-- Move HuggingFaceTEIRanker from Haystack (#3407)
-
-### 📚 Documentation
-
-- Document raised exceptions in HF API components (#3406)
-
-
-## [integrations/huggingface_api-v0.1.0] - 2026-06-05
-
-### 🚀 Features
-
-- Move HF API components to core integrations (#3403)
-
-<!-- generated by git-cliff -->