mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-16 04:18:35 +00:00
62d12543f2
- Fix issue #3: Make similarity_threshold and limit optional with defaults - Updated BaseTool._default_args_schema to extract default values from function signatures - Updated BaseTool._set_args_schema for consistency - Now uses inspect.signature() and pydantic.create_model() to properly handle defaults - Fix issue #1: Make qdrant_client import conditional - Moved qdrant_client imports to TYPE_CHECKING block - Added runtime imports only when QdrantConfig is actually used - Prevents import errors when using ChromaDB without qdrant_client installed - Added comprehensive tests: - test_rag_tool_default_parameters_are_optional: Verifies schema has correct required fields - test_rag_tool_chromadb_no_qdrant_import: Ensures ChromaDB usage doesn't import qdrant_client All existing tests pass. Fixes reported issues where LLM calls would fail with ValidationError on first attempt due to required fields that should have been optional. Co-Authored-By: João <joao@crewai.com>
246 lines
8.2 KiB
Python
246 lines
8.2 KiB
Python
"""Tests for RAG tool with mocked embeddings and vector database."""
|
|
|
|
from pathlib import Path
|
|
from tempfile import TemporaryDirectory
|
|
from typing import cast
|
|
from unittest.mock import MagicMock, Mock, patch
|
|
import sys
|
|
|
|
from crewai_tools.adapters.crewai_rag_adapter import CrewAIRagAdapter
|
|
from crewai_tools.tools.rag.rag_tool import RagTool
|
|
|
|
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.get_rag_client")
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.create_client")
|
|
def test_rag_tool_initialization(
|
|
mock_create_client: Mock, mock_get_rag_client: Mock
|
|
) -> None:
|
|
"""Test that RagTool initializes with CrewAI adapter by default."""
|
|
mock_client = MagicMock()
|
|
mock_client.get_or_create_collection = MagicMock(return_value=None)
|
|
mock_get_rag_client.return_value = mock_client
|
|
mock_create_client.return_value = mock_client
|
|
|
|
class MyTool(RagTool):
|
|
pass
|
|
|
|
tool = MyTool()
|
|
assert tool.adapter is not None
|
|
assert isinstance(tool.adapter, CrewAIRagAdapter)
|
|
|
|
adapter = cast(CrewAIRagAdapter, tool.adapter)
|
|
assert adapter.collection_name == "rag_tool_collection"
|
|
assert adapter._client is not None
|
|
|
|
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.get_rag_client")
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.create_client")
|
|
def test_rag_tool_add_and_query(
|
|
mock_create_client: Mock, mock_get_rag_client: Mock
|
|
) -> None:
|
|
"""Test adding content and querying with RagTool."""
|
|
mock_client = MagicMock()
|
|
mock_client.get_or_create_collection = MagicMock(return_value=None)
|
|
mock_client.add_documents = MagicMock(return_value=None)
|
|
mock_client.search = MagicMock(
|
|
return_value=[
|
|
{"content": "The sky is blue on a clear day.", "metadata": {}, "score": 0.9}
|
|
]
|
|
)
|
|
mock_get_rag_client.return_value = mock_client
|
|
mock_create_client.return_value = mock_client
|
|
|
|
class MyTool(RagTool):
|
|
pass
|
|
|
|
tool = MyTool()
|
|
|
|
tool.add("The sky is blue on a clear day.")
|
|
tool.add("Machine learning is a subset of artificial intelligence.")
|
|
|
|
# Verify documents were added
|
|
assert mock_client.add_documents.call_count == 2
|
|
|
|
result = tool._run(query="What color is the sky?")
|
|
assert "Relevant Content:" in result
|
|
assert "The sky is blue" in result
|
|
|
|
mock_client.search.return_value = [
|
|
{
|
|
"content": "Machine learning is a subset of artificial intelligence.",
|
|
"metadata": {},
|
|
"score": 0.85,
|
|
}
|
|
]
|
|
|
|
result = tool._run(query="Tell me about machine learning")
|
|
assert "Relevant Content:" in result
|
|
assert "Machine learning" in result
|
|
|
|
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.get_rag_client")
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.create_client")
|
|
def test_rag_tool_with_file(
|
|
mock_create_client: Mock, mock_get_rag_client: Mock
|
|
) -> None:
|
|
"""Test RagTool with file content."""
|
|
mock_client = MagicMock()
|
|
mock_client.get_or_create_collection = MagicMock(return_value=None)
|
|
mock_client.add_documents = MagicMock(return_value=None)
|
|
mock_client.search = MagicMock(
|
|
return_value=[
|
|
{
|
|
"content": "Python is a programming language known for its simplicity.",
|
|
"metadata": {"file_path": "test.txt"},
|
|
"score": 0.95,
|
|
}
|
|
]
|
|
)
|
|
mock_get_rag_client.return_value = mock_client
|
|
mock_create_client.return_value = mock_client
|
|
|
|
with TemporaryDirectory() as tmpdir:
|
|
test_file = Path(tmpdir) / "test.txt"
|
|
test_file.write_text(
|
|
"Python is a programming language known for its simplicity."
|
|
)
|
|
|
|
class MyTool(RagTool):
|
|
pass
|
|
|
|
tool = MyTool()
|
|
tool.add(str(test_file))
|
|
|
|
assert mock_client.add_documents.called
|
|
|
|
result = tool._run(query="What is Python?")
|
|
assert "Relevant Content:" in result
|
|
assert "Python is a programming language" in result
|
|
|
|
|
|
@patch("crewai_tools.tools.rag.rag_tool.RagTool._create_embedding_function")
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.create_client")
|
|
def test_rag_tool_with_custom_embeddings(
|
|
mock_create_client: Mock, mock_create_embedding: Mock
|
|
) -> None:
|
|
"""Test RagTool with custom embeddings configuration to ensure no API calls."""
|
|
mock_embedding_func = MagicMock()
|
|
mock_embedding_func.return_value = [[0.2] * 1536]
|
|
mock_create_embedding.return_value = mock_embedding_func
|
|
|
|
mock_client = MagicMock()
|
|
mock_client.get_or_create_collection = MagicMock(return_value=None)
|
|
mock_client.add_documents = MagicMock(return_value=None)
|
|
mock_client.search = MagicMock(
|
|
return_value=[{"content": "Test content", "metadata": {}, "score": 0.8}]
|
|
)
|
|
mock_create_client.return_value = mock_client
|
|
|
|
class MyTool(RagTool):
|
|
pass
|
|
|
|
config = {
|
|
"vectordb": {"provider": "chromadb", "config": {}},
|
|
"embedding_model": {
|
|
"provider": "openai",
|
|
"config": {"model": "text-embedding-3-small"},
|
|
},
|
|
}
|
|
|
|
tool = MyTool(config=config)
|
|
tool.add("Test content")
|
|
|
|
result = tool._run(query="Test query")
|
|
assert "Relevant Content:" in result
|
|
assert "Test content" in result
|
|
|
|
mock_create_embedding.assert_called()
|
|
|
|
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.get_rag_client")
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.create_client")
|
|
def test_rag_tool_no_results(
|
|
mock_create_client: Mock, mock_get_rag_client: Mock
|
|
) -> None:
|
|
"""Test RagTool when no relevant content is found."""
|
|
mock_client = MagicMock()
|
|
mock_client.get_or_create_collection = MagicMock(return_value=None)
|
|
mock_client.search = MagicMock(return_value=[])
|
|
mock_get_rag_client.return_value = mock_client
|
|
mock_create_client.return_value = mock_client
|
|
|
|
class MyTool(RagTool):
|
|
pass
|
|
|
|
tool = MyTool()
|
|
|
|
result = tool._run(query="Non-existent content")
|
|
assert "Relevant Content:" in result
|
|
assert "No relevant content found" in result
|
|
|
|
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.get_rag_client")
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.create_client")
|
|
def test_rag_tool_default_parameters_are_optional(
|
|
mock_create_client: Mock, mock_get_rag_client: Mock
|
|
) -> None:
|
|
"""Test that similarity_threshold and limit parameters have defaults and are optional."""
|
|
mock_client = MagicMock()
|
|
mock_client.get_or_create_collection = MagicMock(return_value=None)
|
|
mock_client.search = MagicMock(
|
|
return_value=[{"content": "Test content", "metadata": {}, "score": 0.9}]
|
|
)
|
|
mock_get_rag_client.return_value = mock_client
|
|
mock_create_client.return_value = mock_client
|
|
|
|
class MyTool(RagTool):
|
|
pass
|
|
|
|
tool = MyTool()
|
|
|
|
schema = tool.args_schema.model_json_schema()
|
|
required_fields = schema.get("required", [])
|
|
|
|
assert "query" in required_fields, "query should be required"
|
|
assert "similarity_threshold" not in required_fields, "similarity_threshold should be optional"
|
|
assert "limit" not in required_fields, "limit should be optional"
|
|
|
|
properties = schema.get("properties", {})
|
|
assert "query" in properties
|
|
assert "similarity_threshold" in properties
|
|
assert "limit" in properties
|
|
|
|
result = tool._run(query="Test query")
|
|
assert "Relevant Content:" in result
|
|
assert "Test content" in result
|
|
|
|
|
|
@patch("crewai_tools.adapters.crewai_rag_adapter.get_rag_client")
|
|
def test_rag_tool_chromadb_no_qdrant_import(mock_get_rag_client: Mock) -> None:
|
|
"""Test that using ChromaDB config does not import qdrant_client."""
|
|
mock_client = MagicMock()
|
|
mock_client.get_or_create_collection = MagicMock(return_value=None)
|
|
mock_get_rag_client.return_value = mock_client
|
|
|
|
original_modules = sys.modules.copy()
|
|
|
|
if "qdrant_client" in sys.modules:
|
|
del sys.modules["qdrant_client"]
|
|
if "qdrant_client.models" in sys.modules:
|
|
del sys.modules["qdrant_client.models"]
|
|
|
|
sys.modules["qdrant_client"] = None
|
|
sys.modules["qdrant_client.models"] = None
|
|
|
|
try:
|
|
class MyTool(RagTool):
|
|
pass
|
|
|
|
tool = MyTool()
|
|
|
|
assert tool.adapter is not None
|
|
assert isinstance(tool.adapter, CrewAIRagAdapter)
|
|
finally:
|
|
sys.modules.clear()
|
|
sys.modules.update(original_modules)
|