mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-06-26 22:00:13 +00:00
91094e1038
* Initial commit * Update deprecation version * Improve comment * Minor simplification * Add reno note * Remove deprecation warning * Remove fallback in haystack/components/generators/utils.py * FinishReason alphabetical import * Add tool_call_results finish reason, adapt codebase * Define finish_reason to be Optional[FinishReason] * Add StreamingChunk finish_reason in HF generators * Update reno note * Repair merge issue * Update tests for finish_reason * Resolve mypy issues * Lint issue * Enhance HF finish_reason translation * Remove irrlevant test * PR comments --------- Co-authored-by: Sebastian Husch Lee <sjrl423@gmail.com>
144 lines
4.8 KiB
Python
144 lines
4.8 KiB
Python
# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
|
|
#
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
import pytest
|
|
|
|
from haystack.dataclasses import StreamingChunk, ComponentInfo, ToolCallDelta, ToolCallResult, ToolCall, FinishReason
|
|
from haystack import component
|
|
from haystack import Pipeline
|
|
|
|
|
|
@component
|
|
class ExampleComponent:
|
|
def __init__(self):
|
|
self.name = "test_component"
|
|
|
|
def run(self) -> str:
|
|
return "Test content"
|
|
|
|
|
|
def test_create_chunk_with_content_and_metadata():
|
|
chunk = StreamingChunk(content="Test content", meta={"key": "value"})
|
|
|
|
assert chunk.content == "Test content"
|
|
assert chunk.meta == {"key": "value"}
|
|
|
|
|
|
def test_create_chunk_with_only_content():
|
|
chunk = StreamingChunk(content="Test content")
|
|
|
|
assert chunk.content == "Test content"
|
|
assert chunk.meta == {}
|
|
|
|
|
|
def test_access_content():
|
|
chunk = StreamingChunk(content="Test content", meta={"key": "value"})
|
|
assert chunk.content == "Test content"
|
|
|
|
|
|
def test_create_chunk_with_empty_content():
|
|
chunk = StreamingChunk(content="")
|
|
assert chunk.content == ""
|
|
assert chunk.meta == {}
|
|
|
|
|
|
def test_create_chunk_with_all_fields():
|
|
component_info = ComponentInfo(type="test.component", name="test_component")
|
|
chunk = StreamingChunk(content="Test content", meta={"key": "value"}, component_info=component_info)
|
|
|
|
assert chunk.content == "Test content"
|
|
assert chunk.meta == {"key": "value"}
|
|
assert chunk.component_info == component_info
|
|
|
|
|
|
def test_create_chunk_with_content_and_tool_call():
|
|
with pytest.raises(ValueError):
|
|
# Can't have content + tool_call at the same time
|
|
StreamingChunk(
|
|
content="Test content",
|
|
meta={"key": "value"},
|
|
tool_calls=[ToolCallDelta(id="123", tool_name="test_tool", arguments='{"arg1": "value1"}', index=0)],
|
|
)
|
|
|
|
|
|
def test_create_chunk_with_content_and_tool_call_result():
|
|
with pytest.raises(ValueError):
|
|
# Can't have content + tool_call_result at the same time
|
|
StreamingChunk(
|
|
content="Test content",
|
|
meta={"key": "value"},
|
|
tool_call_result=ToolCallResult(
|
|
result="output",
|
|
origin=ToolCall(id="123", tool_name="test_tool", arguments={"arg1": "value1"}),
|
|
error=False,
|
|
),
|
|
)
|
|
|
|
|
|
def test_component_info_from_component():
|
|
component = ExampleComponent()
|
|
component_info = ComponentInfo.from_component(component)
|
|
assert component_info.type == "test_streaming_chunk.ExampleComponent"
|
|
|
|
|
|
def test_component_info_from_component_with_name_from_pipeline():
|
|
pipeline = Pipeline()
|
|
component = ExampleComponent()
|
|
pipeline.add_component("pipeline_component", component)
|
|
component_info = ComponentInfo.from_component(component)
|
|
assert component_info.type == "test_streaming_chunk.ExampleComponent"
|
|
assert component_info.name == "pipeline_component"
|
|
|
|
|
|
def test_tool_call_delta():
|
|
tool_call = ToolCallDelta(id="123", tool_name="test_tool", arguments='{"arg1": "value1"}', index=0)
|
|
assert tool_call.id == "123"
|
|
assert tool_call.tool_name == "test_tool"
|
|
assert tool_call.arguments == '{"arg1": "value1"}'
|
|
assert tool_call.index == 0
|
|
|
|
|
|
def test_tool_call_delta_with_missing_fields():
|
|
with pytest.raises(ValueError):
|
|
_ = ToolCallDelta(id="123", index=0)
|
|
|
|
|
|
def test_create_chunk_with_finish_reason():
|
|
"""Test creating a chunk with the new finish_reason field."""
|
|
chunk = StreamingChunk(content="Test content", finish_reason="stop")
|
|
|
|
assert chunk.content == "Test content"
|
|
assert chunk.finish_reason == "stop"
|
|
assert chunk.meta == {}
|
|
|
|
|
|
def test_create_chunk_with_finish_reason_and_meta():
|
|
"""Test creating a chunk with both finish_reason field and meta."""
|
|
chunk = StreamingChunk(
|
|
content="Test content", finish_reason="stop", meta={"model": "gpt-4", "usage": {"tokens": 10}}
|
|
)
|
|
|
|
assert chunk.content == "Test content"
|
|
assert chunk.finish_reason == "stop"
|
|
assert chunk.meta["model"] == "gpt-4"
|
|
assert chunk.meta["usage"]["tokens"] == 10
|
|
|
|
|
|
def test_finish_reason_standard_values():
|
|
"""Test all standard finish_reason values including the new Haystack-specific ones."""
|
|
standard_values = ["stop", "length", "tool_calls", "content_filter", "tool_call_results"]
|
|
|
|
for value in standard_values:
|
|
chunk = StreamingChunk(content="Test content", finish_reason=value)
|
|
assert chunk.finish_reason == value
|
|
|
|
|
|
def test_finish_reason_tool_call_results():
|
|
"""Test specifically the new tool_call_results finish reason."""
|
|
chunk = StreamingChunk(content="", finish_reason="tool_call_results", meta={"finish_reason": "tool_call_results"})
|
|
|
|
assert chunk.finish_reason == "tool_call_results"
|
|
assert chunk.meta["finish_reason"] == "tool_call_results"
|
|
assert chunk.content == ""
|