mirror of
https://github.com/kennethreitz/langchain.git
synced 2026-06-05 23:00:18 +00:00
Leonid Ganeline
ae8bc9e830
The `sql_database.py` is unnecessarily placed in the root code folder. A similar code is usually placed in the `utilities/`. As a byproduct of this placement, the sql_database is [placed on the top level of classes in the API Reference](https://api.python.langchain.com/en/latest/api_reference.html#module-langchain.sql_database) which is confusing and not correct. - moved the `sql_database.py` from the root code folder to the `utilities/` @baskaryan --------- Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
72 lines
2.8 KiB
Python
72 lines
2.8 KiB
Python
"""Toolkit for interacting with an SQL database."""
|
|
from typing import List
|
|
|
|
from pydantic import Field
|
|
|
|
from langchain.agents.agent_toolkits.base import BaseToolkit
|
|
from langchain.schema.language_model import BaseLanguageModel
|
|
from langchain.tools import BaseTool
|
|
from langchain.tools.sql_database.tool import (
|
|
InfoSQLDatabaseTool,
|
|
ListSQLDatabaseTool,
|
|
QuerySQLCheckerTool,
|
|
QuerySQLDataBaseTool,
|
|
)
|
|
from langchain.utilities.sql_database import SQLDatabase
|
|
|
|
|
|
class SQLDatabaseToolkit(BaseToolkit):
|
|
"""Toolkit for interacting with SQL databases."""
|
|
|
|
db: SQLDatabase = Field(exclude=True)
|
|
llm: BaseLanguageModel = Field(exclude=True)
|
|
|
|
@property
|
|
def dialect(self) -> str:
|
|
"""Return string representation of SQL dialect to use."""
|
|
return self.db.dialect
|
|
|
|
class Config:
|
|
"""Configuration for this pydantic object."""
|
|
|
|
arbitrary_types_allowed = True
|
|
|
|
def get_tools(self) -> List[BaseTool]:
|
|
"""Get the tools in the toolkit."""
|
|
list_sql_database_tool = ListSQLDatabaseTool(db=self.db)
|
|
info_sql_database_tool_description = (
|
|
"Input to this tool is a comma-separated list of tables, output is the "
|
|
"schema and sample rows for those tables. "
|
|
"Be sure that the tables actually exist by calling "
|
|
f"{list_sql_database_tool.name} first! "
|
|
"Example Input: 'table1, table2, table3'"
|
|
)
|
|
info_sql_database_tool = InfoSQLDatabaseTool(
|
|
db=self.db, description=info_sql_database_tool_description
|
|
)
|
|
query_sql_database_tool_description = (
|
|
"Input to this tool is a detailed and correct SQL query, output is a "
|
|
"result from the database. If the query is not correct, an error message "
|
|
"will be returned. If an error is returned, rewrite the query, check the "
|
|
"query, and try again. If you encounter an issue with Unknown column "
|
|
f"'xxxx' in 'field list', using {info_sql_database_tool.name} "
|
|
"to query the correct table fields."
|
|
)
|
|
query_sql_database_tool = QuerySQLDataBaseTool(
|
|
db=self.db, description=query_sql_database_tool_description
|
|
)
|
|
query_sql_checker_tool_description = (
|
|
"Use this tool to double check if your query is correct before executing "
|
|
"it. Always use this tool before executing a query with "
|
|
f"{query_sql_database_tool.name}!"
|
|
)
|
|
query_sql_checker_tool = QuerySQLCheckerTool(
|
|
db=self.db, llm=self.llm, description=query_sql_checker_tool_description
|
|
)
|
|
return [
|
|
query_sql_database_tool,
|
|
info_sql_database_tool,
|
|
list_sql_database_tool,
|
|
query_sql_checker_tool,
|
|
]
|