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

{huggingface_api_haystack-0.4.0 → huggingface_api_haystack-0.5.0}/CHANGELOG.md

@@ -1,5 +1,17 @@
 # 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

{huggingface_api_haystack-0.4.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.4.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.4.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.4.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.4.0 → huggingface_api_haystack-0.5.0}/src/haystack_integrations/components/generators/huggingface_api/chat/chat_generator.py

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

{huggingface_api_haystack-0.4.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.4.0 → huggingface_api_haystack-0.5.0}/tests/test_chat_generator.py

@@ -374,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,
@@ -914,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(

{huggingface_api_haystack-0.4.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 = {