14831426262

Committed 05 May 2025 07:36AM UTC coverage: 90.418% (-0.1%) from 90.513%

Build # 14831426262

Build Type

Pull #9290

github

Committed by

web-flow

Commit Message

Merge 01b92259e into 7db719981

Pull Request Pull Request #9290: feat: enable streaming ToolCall/Result from Agent

Run Details

10908 of 12064 relevant lines covered (90.42%)

0.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

16.67

haystack/components/generators/utils.py

# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0

from openai.types.chat.chat_completion_chunk import ChoiceDeltaToolCall

from haystack.dataclasses import StreamingChunk


def print_streaming_chunk(chunk: StreamingChunk) -> None:
    """
    Callback function to handle and display streaming output chunks.

    This function processes a `StreamingChunk` object by:
    - Printing tool call metadata (if any), including function names and arguments, as they arrive.
    - Printing tool call results when available.
    - Printing the main content (e.g., text tokens) of the chunk as it is received.

    The function outputs data directly to stdout and flushes output buffers to ensure immediate display during
    streaming.

    :param chunk: A chunk of streaming data containing content and optional metadata, such as tool calls and
        tool results.
    """
    # Print tool call metadata if available (from ChatGenerator)
    if chunk.meta.get("tool_calls"):
        for tool_call in chunk.meta["tool_calls"]:
            if isinstance(tool_call, ChoiceDeltaToolCall) and tool_call.function:
                if tool_call.function.name and not tool_call.function.arguments:
                    print(f"[TOOL CALL - {tool_call.function.name}] ", flush=True, end="")

                if tool_call.function.arguments:
                    if tool_call.function.arguments.startswith("{"):
                        print("\nArguments: ", flush=True, end="")
                    print(tool_call.function.arguments, flush=True, end="")
                    if tool_call.function.arguments.endswith("}"):
                        print("\n\n", flush=True, end="")

    # Print tool call results if available (from ToolInvoker)
    if chunk.meta.get("tool_result"):
        print(f"[TOOL RESULT]\n{chunk.meta['tool_result']}\n\n", flush=True, end="")

    # Print the main content of the chunk (from ChatGenerator)
    if chunk.content:
        print(chunk.content, flush=True, end="")

1	# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
2	#
3	# SPDX-License-Identifier: Apache-2.0
4
5	from openai.types.chat.chat_completion_chunk import ChoiceDeltaToolCall	1✔
6
7	from haystack.dataclasses import StreamingChunk	1✔
8
9
10	def print_streaming_chunk(chunk: StreamingChunk) -> None:	1✔
11	"""
12	Callback function to handle and display streaming output chunks.
13
14	This function processes a `StreamingChunk` object by:
15	- Printing tool call metadata (if any), including function names and arguments, as they arrive.
16	- Printing tool call results when available.
17	- Printing the main content (e.g., text tokens) of the chunk as it is received.
18
19	The function outputs data directly to stdout and flushes output buffers to ensure immediate display during
20	streaming.
21
22	:param chunk: A chunk of streaming data containing content and optional metadata, such as tool calls and
23	tool results.
24	"""
25	# Print tool call metadata if available (from ChatGenerator)
26	if chunk.meta.get("tool_calls"):	×
27	for tool_call in chunk.meta["tool_calls"]:	×
28	if isinstance(tool_call, ChoiceDeltaToolCall) and tool_call.function:	×
29	if tool_call.function.name and not tool_call.function.arguments:	×
30	print(f"[TOOL CALL - {tool_call.function.name}] ", flush=True, end="")	×
31
32	if tool_call.function.arguments:	×
33	if tool_call.function.arguments.startswith("{"):	×
34	print("\nArguments: ", flush=True, end="")	×
35	print(tool_call.function.arguments, flush=True, end="")	×
36	if tool_call.function.arguments.endswith("}"):	×
37	print("\n\n", flush=True, end="")	×
38
39	# Print tool call results if available (from ToolInvoker)
40	if chunk.meta.get("tool_result"):	×
41	print(f"[TOOL RESULT]\n{chunk.meta['tool_result']}\n\n", flush=True, end="")	×
42
43	# Print the main content of the chunk (from ChatGenerator)
44	if chunk.content:	×
45	print(chunk.content, flush=True, end="")	×

deepset-ai / haystack / 14831426262

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous