haystack-experimental 0.14.0__py3-none-any.whl → 0.14.2__py3-none-any.whl

haystack_experimental/components/agents/agent.py

@@ -5,6 +5,7 @@
 # pylint: disable=wrong-import-order,wrong-import-position,ungrouped-imports
 # ruff: noqa: I001
 
+import inspect
 from dataclasses import dataclass
 from typing import Any, Optional, Union
 
@@ -20,7 +21,6 @@ import haystack_experimental.core.pipeline.breakpoint as exp_breakpoint
 
 hs_breakpoint._create_agent_snapshot = exp_breakpoint._create_agent_snapshot
 hs_breakpoint._create_pipeline_snapshot_from_tool_invoker = exp_breakpoint._create_pipeline_snapshot_from_tool_invoker  # type: ignore[assignment]
-hs_breakpoint._trigger_tool_invoker_breakpoint = exp_breakpoint._trigger_tool_invoker_breakpoint
 
 from haystack import logging
 from haystack.components.agents.agent import Agent as HaystackAgent
@@ -39,7 +39,7 @@ from haystack.core.serialization import default_from_dict, import_class_by_name
 from haystack.dataclasses import ChatMessage
 from haystack.dataclasses.breakpoints import AgentBreakpoint, ToolBreakpoint
 from haystack.dataclasses.streaming_chunk import StreamingCallbackT
-from haystack.tools import Tool, Toolset, deserialize_tools_or_toolset_inplace
+from haystack.tools import ToolsType, deserialize_tools_or_toolset_inplace
 from haystack.utils.callable_serialization import deserialize_callable
 from haystack.utils.deserialization import deserialize_chatgenerator_inplace
 
@@ -122,7 +122,7 @@ class Agent(HaystackAgent):
         self,
         *,
         chat_generator: ChatGenerator,
-        tools: Optional[Union[list[Tool], Toolset]] = None,
+        tools: Optional[ToolsType] = None,
         system_prompt: Optional[str] = None,
         exit_conditions: Optional[list[str]] = None,
         state_schema: Optional[dict[str, Any]] = None,
@@ -172,7 +172,7 @@ class Agent(HaystackAgent):
         requires_async: bool,
         *,
         system_prompt: Optional[str] = None,
-        tools: Optional[Union[list[Tool], Toolset, list[str]]] = None,
+        tools: Optional[Union[ToolsType, list[str]]] = None,
         **kwargs: dict[str, Any],
     ) -> _ExecutionContext:
         """
@@ -213,7 +213,7 @@ class Agent(HaystackAgent):
         streaming_callback: Optional[StreamingCallbackT],
         requires_async: bool,
         *,
-        tools: Optional[Union[list[Tool], Toolset, list[str]]] = None,
+        tools: Optional[Union[ToolsType, list[str]]] = None,
     ) -> _ExecutionContext:
         """
         Initialize execution context from an AgentSnapshot.
@@ -251,7 +251,7 @@ class Agent(HaystackAgent):
         break_point: Optional[AgentBreakpoint] = None,
         snapshot: Optional[AgentSnapshot] = None,  # type: ignore[override]
         system_prompt: Optional[str] = None,
-        tools: Optional[Union[list[Tool], Toolset, list[str]]] = None,
+        tools: Optional[Union[ToolsType, list[str]]] = None,
         **kwargs: Any,
     ) -> dict[str, Any]:
         """
@@ -286,7 +286,13 @@ class Agent(HaystackAgent):
             "snapshot": snapshot,
             **kwargs,
         }
-        self._runtime_checks(break_point=break_point, snapshot=snapshot)
+        # The PR https://github.com/deepset-ai/haystack/pull/9987 removed the unused snapshot parameter from
+        # _runtime_checks. This change will be released in Haystack 2.20.0.
+        # To maintain compatibility with Haystack 2.19 we check the number of parameters and call accordingly.
+        if len(inspect.signature(self._runtime_checks).parameters) == 2:
+            self._runtime_checks(break_point, snapshot)
+        else:
+            self._runtime_checks(break_point)  # type: ignore[call-arg]  # pylint: disable=no-value-for-parameter
 
         if snapshot:
             exe_context = self._initialize_from_snapshot(
@@ -435,7 +441,7 @@ class Agent(HaystackAgent):
         break_point: Optional[AgentBreakpoint] = None,
         snapshot: Optional[AgentSnapshot] = None,  # type: ignore[override]
         system_prompt: Optional[str] = None,
-        tools: Optional[Union[list[Tool], Toolset, list[str]]] = None,
+        tools: Optional[Union[ToolsType, list[str]]] = None,
         **kwargs: Any,
     ) -> dict[str, Any]:
         """
@@ -473,7 +479,13 @@ class Agent(HaystackAgent):
             "snapshot": snapshot,
             **kwargs,
         }
-        self._runtime_checks(break_point=break_point, snapshot=snapshot)
+        # The PR https://github.com/deepset-ai/haystack/pull/9987 removed the unused snapshot parameter from
+        # _runtime_checks. This change will be released in Haystack 2.20.0.
+        # To maintain compatibility with Haystack 2.19 we check the number of parameters and call accordingly.
+        if len(inspect.signature(self._runtime_checks).parameters) == 2:
+            self._runtime_checks(break_point, snapshot)
+        else:
+            self._runtime_checks(break_point)  # type: ignore[call-arg]  # pylint: disable=no-value-for-parameter
 
         if snapshot:
             exe_context = self._initialize_from_snapshot(

haystack_experimental/components/generators/chat/openai.py

@@ -3,12 +3,12 @@
 # SPDX-License-Identifier: Apache-2.0
 
 from dataclasses import replace
-from typing import Any, Optional, Union
+from typing import Any, Optional
 
 from haystack import component
 from haystack.components.generators.chat.openai import OpenAIChatGenerator as BaseOpenAIChatGenerator
 from haystack.dataclasses import ChatMessage, StreamingCallbackT
-from haystack.tools import Tool, Toolset
+from haystack.tools import ToolsType
 
 from haystack_experimental.utils.hallucination_risk_calculator.dataclasses import HallucinationScoreConfig
 from haystack_experimental.utils.hallucination_risk_calculator.openai_planner import calculate_hallucination_metrics
@@ -59,7 +59,7 @@ class OpenAIChatGenerator(BaseOpenAIChatGenerator):
         streaming_callback: Optional[StreamingCallbackT] = None,
         generation_kwargs: Optional[dict[str, Any]] = None,
         *,
-        tools: Optional[Union[list[Tool], Toolset]] = None,
+        tools: Optional[ToolsType] = None,
         tools_strict: Optional[bool] = None,
         hallucination_score_config: Optional[HallucinationScoreConfig] = None,
     ) -> dict[str, list[ChatMessage]]:
@@ -75,9 +75,8 @@ class OpenAIChatGenerator(BaseOpenAIChatGenerator):
             override the parameters passed during component initialization.
             For details on OpenAI API parameters, see [OpenAI documentation](https://platform.openai.com/docs/api-reference/chat/create).
         :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 or a `Toolset` instance.
+            A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls.
+            If set, it will override the `tools` parameter provided during initialization.
         :param tools_strict:
             Whether to enable strict schema adherence for tool calls. If set to `True`, the model will follow exactly
             the schema provided in the `parameters` field of the tool definition, but this may increase latency.
@@ -127,7 +126,7 @@ class OpenAIChatGenerator(BaseOpenAIChatGenerator):
         streaming_callback: Optional[StreamingCallbackT] = None,
         generation_kwargs: Optional[dict[str, Any]] = None,
         *,
-        tools: Optional[Union[list[Tool], Toolset]] = None,
+        tools: Optional[ToolsType] = None,
         tools_strict: Optional[bool] = None,
         hallucination_score_config: Optional[HallucinationScoreConfig] = None,
     ) -> dict[str, list[ChatMessage]]:
@@ -147,9 +146,8 @@ class OpenAIChatGenerator(BaseOpenAIChatGenerator):
             override the parameters passed during component initialization.
             For details on OpenAI API parameters, see [OpenAI documentation](https://platform.openai.com/docs/api-reference/chat/create).
         :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 or a `Toolset` instance.
+            A list of Tool and/or Toolset objects, or a single Toolset for which the model can prepare calls.
+            If set, it will override the `tools` parameter provided during initialization.
         :param tools_strict:
             Whether to enable strict schema adherence for tool calls. If set to `True`, the model will follow exactly
             the schema provided in the `parameters` field of the tool definition, but this may increase latency.

haystack_experimental/components/query/query_expander.py

@@ -99,7 +99,7 @@ class QueryExpander:
             If None, a default OpenAIChatGenerator with gpt-4.1-mini model is used.
         :param prompt_template: Custom [PromptBuilder](https://docs.haystack.deepset.ai/docs/promptbuilder)
             template for query expansion. The template should instruct the LLM to return a JSON response with the
-            structure: {"queries": ["query1", "query2", "query3"]}. The template should include 'query' and
+            structure: `{"queries": ["query1", "query2", "query3"]}`. The template should include 'query' and
             'n_expansions' variables.
         :param n_expansions: Number of alternative queries to generate (default: 4).
         :param include_original_query: Whether to include the original query in the output.

haystack_experimental/core/pipeline/breakpoint.py

@@ -8,9 +8,6 @@ from datetime import datetime
 from typing import TYPE_CHECKING, Any, Optional
 
 from haystack import logging
-from haystack.core.errors import BreakpointException
-from haystack.core.pipeline.breakpoint import _save_pipeline_snapshot
-from haystack.dataclasses import ChatMessage
 from haystack.dataclasses.breakpoints import AgentBreakpoint, PipelineSnapshot, PipelineState, ToolBreakpoint
 from haystack.utils.base_serialization import _serialize_value_with_schema
 from haystack.utils.misc import _get_output_dir
@@ -120,55 +117,3 @@ def _create_pipeline_snapshot_from_tool_invoker(
         final_snapshot = replace(parent_snapshot, agent_snapshot=agent_snapshot)
 
     return final_snapshot
-
-
-def _trigger_tool_invoker_breakpoint(*, llm_messages: list[ChatMessage], pipeline_snapshot: PipelineSnapshot) -> None:
-    """
-    Check if a tool call breakpoint should be triggered before executing the tool invoker.
-
-    NOTE: Only difference to Haystack's native implementation is that it includes the fix from
-    PR https://github.com/deepset-ai/haystack/pull/9853 where we make sure to check all tool calls in a chat message
-    when checking if a BreakpointException should be made.
-
-    :param llm_messages: List of ChatMessage objects containing potential tool calls.
-    :param pipeline_snapshot: PipelineSnapshot object containing the state of the pipeline and Agent snapshot.
-    :raises BreakpointException: If the breakpoint is triggered, indicating a breakpoint has been reached for a tool
-        call.
-    """
-    if not pipeline_snapshot.agent_snapshot:
-        raise ValueError("PipelineSnapshot must contain an AgentSnapshot to trigger a tool call breakpoint.")
-
-    if not isinstance(pipeline_snapshot.agent_snapshot.break_point.break_point, ToolBreakpoint):
-        return
-
-    tool_breakpoint = pipeline_snapshot.agent_snapshot.break_point.break_point
-
-    # Check if we should break for this specific tool or all tools
-    if tool_breakpoint.tool_name is None:
-        # Break for any tool call
-        should_break = any(msg.tool_call for msg in llm_messages)
-    else:
-        # Break only for the specific tool
-        should_break = any(
-            tc.tool_name == tool_breakpoint.tool_name for msg in llm_messages for tc in msg.tool_calls or []
-        )
-
-    if not should_break:
-        return  # No breakpoint triggered
-
-    _save_pipeline_snapshot(pipeline_snapshot=pipeline_snapshot)
-
-    msg = (
-        f"Breaking at {tool_breakpoint.component_name} visit count "
-        f"{pipeline_snapshot.agent_snapshot.component_visits[tool_breakpoint.component_name]}"
-    )
-    if tool_breakpoint.tool_name:
-        msg += f" for tool {tool_breakpoint.tool_name}"
-    logger.info(msg)
-
-    raise BreakpointException(
-        message=msg,
-        component=tool_breakpoint.component_name,
-        inputs=pipeline_snapshot.agent_snapshot.component_inputs,
-        results=pipeline_snapshot.agent_snapshot.component_inputs["tool_invoker"]["serialized_data"]["state"],
-    )

{haystack_experimental-0.14.0.dist-info → haystack_experimental-0.14.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: haystack-experimental
-Version: 0.14.0
+Version: 0.14.2
 Summary: Experimental components and features for the Haystack LLM framework.
 Project-URL: CI: GitHub, https://github.com/deepset-ai/haystack-experimental/actions
 Project-URL: GitHub: issues, https://github.com/deepset-ai/haystack-experimental/issues
@@ -107,9 +107,9 @@ that includes it. Once it reaches the end of its lifespan, the experiment will b
 [20]: https://github.com/deepset-ai/haystack-experimental/blob/main/haystack_experimental/components/agents/human_in_the_loop/strategies.py
 [21]: https://github.com/deepset-ai/haystack-experimental/blob/main/haystack_experimental/components/agents/human_in_the_loop/dataclasses.py
 [22]: https://github.com/deepset-ai/haystack-experimental/blob/main/haystack_experimental/components/agents/human_in_the_loop/errors.py
-[23]: https://github.com/deepset-ai/haystack-experimental/discussions/XXX
+[23]: https://github.com/deepset-ai/haystack-experimental/discussions/381
 [24]: https://github.com/deepset-ai/haystack-experimental/blob/main/haystack_experimental/components/sumarizers/llm_summarizer.py
-[25]: https://github.com/deepset-ai/haystack-experimental/discussions/XXX
+[25]: https://github.com/deepset-ai/haystack-experimental/discussions/382
 
 ### Adopted experiments
 | Name                                                                                   | Type                                     | Final release |

{haystack_experimental-0.14.0.dist-info → haystack_experimental-0.14.2.dist-info}/RECORD

@@ -4,7 +4,7 @@ haystack_experimental/chat_message_stores/in_memory.py,sha256=nc_B_70KOvtgsul4QJ
 haystack_experimental/chat_message_stores/types.py,sha256=QzjA5-A08PlMAy7MMLNNUpob8S60Ypec74gSbz_l49E,2101
 haystack_experimental/components/__init__.py,sha256=eHD7xrty2PCky_gG3ty19rpM4WfV32TyytM7gJODwl4,110
 haystack_experimental/components/agents/__init__.py,sha256=Sxu9LxPpQ5cljgoTgUeNC0GY8CwUdiSy1JWkd_-RRJ4,414
-haystack_experimental/components/agents/agent.py,sha256=eQJ1at3RZPlXZ6zdphTL-9sE7btrmLs5p7wKLzCSgXs,31972
+haystack_experimental/components/agents/agent.py,sha256=1H8fzEp97QtRWXx336PDRj1lJEUyH4aYr-HcHbNZvTw,32789
 haystack_experimental/components/agents/human_in_the_loop/__init__.py,sha256=xLr1G9pNWMmCpKN9mbv6yqeFfwMcbZyaVfCkzlwMxhY,1674
 haystack_experimental/components/agents/human_in_the_loop/breakpoint.py,sha256=GhNdGdFNDnwSiTukD4WVp6-1YgGjq5oqCEcGMC2dcog,2902
 haystack_experimental/components/agents/human_in_the_loop/dataclasses.py,sha256=OakB0PXBSG0LbQixcuo-d7IC-A3_k6qi80pB8hwY23o,2563
@@ -18,12 +18,12 @@ haystack_experimental/components/embedders/types/__init__.py,sha256=HGR8aavwIEx7
 haystack_experimental/components/embedders/types/protocol.py,sha256=EEVtggoYWZL6zF-vbasJollCxLbheMYIISAh7hJ8LkA,1038
 haystack_experimental/components/generators/__init__.py,sha256=eHD7xrty2PCky_gG3ty19rpM4WfV32TyytM7gJODwl4,110
 haystack_experimental/components/generators/chat/__init__.py,sha256=LEKI1mMtltVbSiU40QgBfnWC-z3_660TWuV-cVHhdTw,465
-haystack_experimental/components/generators/chat/openai.py,sha256=QFb-l_VbTkqi46rqE6rkmMoRkT3fX8kEsStOEGMEBRw,10040
+haystack_experimental/components/generators/chat/openai.py,sha256=gX6UI4yfY0pzKhWErquvPF_gV-3Ut0y6wSJytAD07Jk,9855
 haystack_experimental/components/preprocessors/__init__.py,sha256=x3fM1lpGzYjWB3hpdbDWxXr_rYASb2e9yX0PgYG84rA,518
 haystack_experimental/components/preprocessors/embedding_based_document_splitter.py,sha256=VyQ--gaMsWid-IRBVXi5YPJpwbFlaK-2mRFvRF8MSBQ,17616
 haystack_experimental/components/preprocessors/md_header_level_inferrer.py,sha256=1Tn-H4Gvg2yYSUc54cPWKTCK78KXet5u32_1S8PM3NU,5643
 haystack_experimental/components/query/__init__.py,sha256=quaqe16cbtgIdJx7d56CMdk1zZQ6f_3_TICsU0HF_U8,446
-haystack_experimental/components/query/query_expander.py,sha256=zc9i2zP3ciOWWr029wO_lw3Tl8W3_kQcYcoHDs5Nj8c,12293
+haystack_experimental/components/query/query_expander.py,sha256=cZAT6ThSXXfeI-Fg2FrnqWn7uOvl9m5z8Pz8wKvrJuw,12295
 haystack_experimental/components/retrievers/__init__.py,sha256=CqPvqyvGp5L3Y1gTVQC8DD_xHzbIfTzGlj3oCsZM3J8,528
 haystack_experimental/components/retrievers/chat_message_retriever.py,sha256=CaAgW1qzzhMYyKNOyk-eIBgSsO7Bg7uDqAtgcorCE60,4030
 haystack_experimental/components/retrievers/multi_query_embedding_retriever.py,sha256=IAjAh3SqsKx_d8QEfRAqVYNDL5UUuBb3GNJPDGjokjU,8103
@@ -36,7 +36,7 @@ haystack_experimental/components/writers/__init__.py,sha256=iMdeAaZozza8E6dQ4Lc2
 haystack_experimental/components/writers/chat_message_writer.py,sha256=iu8gmvmRXlqd9S2-9B8p-7C0Y5GTuOI1AqcVKAkrzDc,3502
 haystack_experimental/core/__init__.py,sha256=eHD7xrty2PCky_gG3ty19rpM4WfV32TyytM7gJODwl4,110
 haystack_experimental/core/pipeline/__init__.py,sha256=eHD7xrty2PCky_gG3ty19rpM4WfV32TyytM7gJODwl4,110
-haystack_experimental/core/pipeline/breakpoint.py,sha256=04a2ngU2I5B2lp7iUqJjax8ZNarq5i753M1hFUGzc4s,7603
+haystack_experimental/core/pipeline/breakpoint.py,sha256=JtwQP8OF5Sdqo0abPRgs1K3SqBkUXhZ53PkeagcK2ZE,5134
 haystack_experimental/dataclasses/__init__.py,sha256=eHD7xrty2PCky_gG3ty19rpM4WfV32TyytM7gJODwl4,110
 haystack_experimental/dataclasses/breakpoints.py,sha256=f0kxYXJRHzk6jAW5Na51MZfUuRIlulhN4oTrGWTpSFE,2095
 haystack_experimental/super_components/__init__.py,sha256=eHD7xrty2PCky_gG3ty19rpM4WfV32TyytM7gJODwl4,110
@@ -48,8 +48,8 @@ haystack_experimental/utils/hallucination_risk_calculator/core_math.py,sha256=8X
 haystack_experimental/utils/hallucination_risk_calculator/dataclasses.py,sha256=3vk9jsbW-7C9n408Qe730qgdXxIOzsTigf4TMLpryvI,2318
 haystack_experimental/utils/hallucination_risk_calculator/openai_planner.py,sha256=-yVQsGzM5rXsAVwolE6sp5W6q1yDw66SiIUuUbPk1ng,11413
 haystack_experimental/utils/hallucination_risk_calculator/skeletonization.py,sha256=qNdBUoFiBjQsI3ovrhd4RyTFmIbv51Goai1Z_l9lG28,5488
-haystack_experimental-0.14.0.dist-info/METADATA,sha256=p8xYGisk0cutaMtYxQXMlmXZvYrLFGpdK2aHJUBJhVY,18566
-haystack_experimental-0.14.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-haystack_experimental-0.14.0.dist-info/licenses/LICENSE,sha256=93_5nS97uHxptHvK9E8BZgKxLGeIS-rBWT2swIv-X5Y,11368
-haystack_experimental-0.14.0.dist-info/licenses/LICENSE-MIT.txt,sha256=knmLkIKj_6tTrTSVRg9Tq88Kww4UCPLt2I1RGXJv9sQ,1037
-haystack_experimental-0.14.0.dist-info/RECORD,,
+haystack_experimental-0.14.2.dist-info/METADATA,sha256=5wj3kC9aQ6B3TOrh9FNXmkbQMD1nEnF2eUoRc-B2yqA,18566
+haystack_experimental-0.14.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+haystack_experimental-0.14.2.dist-info/licenses/LICENSE,sha256=93_5nS97uHxptHvK9E8BZgKxLGeIS-rBWT2swIv-X5Y,11368
+haystack_experimental-0.14.2.dist-info/licenses/LICENSE-MIT.txt,sha256=knmLkIKj_6tTrTSVRg9Tq88Kww4UCPLt2I1RGXJv9sQ,1037
+haystack_experimental-0.14.2.dist-info/RECORD,,