Repository navigation
fix(tools): make NL2SQL guidance dialect-aware #7813
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
liang0417
wants to merge
2
commits into
crewAIInc:main
Choose a base branch
from
liang0417:fix/nl2sql-dialect
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+103
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
lib/crewai-tools/tests/tools/test_nl2sql_dialect_guidance.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| """Tests for dialect-specific NL2SQLTool generation guidance.""" | ||
|
|
||
| from unittest.mock import patch | ||
|
|
||
| import pytest | ||
|
|
||
|
|
||
| pytest.importorskip("sqlalchemy") | ||
|
|
||
| from crewai_tools.tools.nl2sql.nl2sql_tool import NL2SQLTool # noqa: E402 | ||
|
|
||
|
|
||
| def _make_tool(db_uri: str, **kwargs: object) -> NL2SQLTool: | ||
| with ( | ||
| patch.object(NL2SQLTool, "_fetch_available_tables", return_value=[]), | ||
| patch.object(NL2SQLTool, "_fetch_all_available_columns", return_value=[]), | ||
| ): | ||
| return NL2SQLTool(db_uri=db_uri, **kwargs) | ||
|
|
||
|
|
||
| def test_sqlite_dialect_is_inferred_from_uri() -> None: | ||
| tool = _make_tool("sqlite:///example.db") | ||
|
|
||
| assert tool.dialect == "sqlite" | ||
| assert "Generate SQLite-compatible SQL" in tool.description | ||
| assert "Do not use ILIKE" in tool.description | ||
|
|
||
|
|
||
| def test_postgresql_dialect_is_inferred_from_uri() -> None: | ||
| tool = _make_tool("postgresql://user:password@localhost/database") | ||
|
|
||
| assert tool.dialect == "postgresql" | ||
| assert "Generate PostgreSQL-compatible SQL" in tool.description | ||
| assert "ILIKE" in tool.description | ||
|
|
||
|
|
||
| def test_explicit_dialect_overrides_uri() -> None: | ||
| tool = _make_tool( | ||
| "postgresql://user:password@localhost/database", dialect=" SQLite " | ||
| ) | ||
|
|
||
| assert tool.dialect == "sqlite" | ||
| assert "Generate SQLite-compatible SQL" in tool.description | ||
|
|
||
|
|
||
| def test_custom_description_is_preserved() -> None: | ||
| tool = _make_tool( | ||
| "sqlite:///example.db", | ||
| description="Use the reporting database.", | ||
| ) | ||
|
|
||
| assert tool.description.startswith("Use the reporting database.") | ||
| assert "Generate SQLite-compatible SQL" in tool.description | ||
|
|
||
|
|
||
| def test_dialect_guidance_is_not_duplicated_on_restore() -> None: | ||
| tool = _make_tool("sqlite:///example.db") | ||
|
|
||
| restored = _make_tool(**tool.model_dump()) | ||
|
|
||
| assert restored.description.count("Generate SQLite-compatible SQL") == 1 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.