NgdZddlmZddlmZddlmZddlmZddl m Z ddl m Z ddl mZmZdd lmZmZmZmZdd lmZGd d e Zed S)z-Toolkit for interacting with an SQL database.)List) BaseCache) Callbacks)BaseLanguageModel)BaseTool) BaseToolkit) ConfigDictField)InfoSQLDatabaseToolListSQLDatabaseToolQuerySQLCheckerToolQuerySQLDataBaseTool) SQLDatabaseceZdZUdZedZeed<edZe ed<e de fdZ e dZdeefd Zdefd Zd S) SQLDatabaseToolkitaSQLDatabaseToolkit for interacting with SQL databases. Setup: Install ``langchain-community``. .. code-block:: bash pip install -U langchain-community Key init args: db: SQLDatabase The SQL database. llm: BaseLanguageModel The language model (for use with QuerySQLCheckerTool) Instantiate: .. code-block:: python from langchain_community.agent_toolkits.sql.toolkit import SQLDatabaseToolkit from langchain_community.utilities.sql_database import SQLDatabase from langchain_openai import ChatOpenAI db = SQLDatabase.from_uri("sqlite:///Chinook.db") llm = ChatOpenAI(temperature=0) toolkit = SQLDatabaseToolkit(db=db, llm=llm) Tools: .. code-block:: python toolkit.get_tools() Use within an agent: .. code-block:: python from langchain import hub from langgraph.prebuilt import create_react_agent # Pull prompt (or define your own) prompt_template = hub.pull("langchain-ai/sql-agent-system-prompt") system_message = prompt_template.format(dialect="SQLite", top_k=5) # Create agent agent_executor = create_react_agent( llm, toolkit.get_tools(), state_modifier=system_message ) # Query agent example_query = "Which country's customers spent the most?" events = agent_executor.stream( {"messages": [("user", example_query)]}, stream_mode="values", ) for event in events: event["messages"][-1].pretty_print() T)excludedbllmreturnc|jjS)z3Return string representation of SQL dialect to use.)rdialectselfs j/var/www/html/ai-engine/env/lib/python3.11/site-packages/langchain_community/agent_toolkits/sql/toolkit.pyrzSQLDatabaseToolkit.dialectSsw)arbitrary_types_allowedc t|j}d|jd}t|j|}d|jd}t |j|}d|jd}t |j|j| }||||gS) zGet the tools in the toolkit.)rzInput 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 z- first! Example Input: table1, table2, table3)r descriptiona4Input 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 'xxxx' in 'field list', use z# to query the correct table fields.zUse this tool to double check if your query is correct before executing it. Always use this tool before executing a query with !)rrr)r rnamer rr r)rlist_sql_database_tool"info_sql_database_tool_descriptioninfo_sql_database_tool#query_sql_database_tool_descriptionquery_sql_database_tool"query_sql_checker_tool_descriptionquery_sql_checker_tools r get_toolszSQLDatabaseToolkit.get_tools\s!4!@!@!@ 4&* 4 4 4 +"5w$F" " "  1,B+F  1 1 1 ,#7w$G# # #  /&+ / / / + "5wDH2T" " "  $ " " "   rc4|jS)z4Return db context that you may want in agent prompt.)r get_contextrs rr*zSQLDatabaseToolkit.get_contextsw""$$$rN)__name__ __module__ __qualname____doc__r rr__annotations__rrpropertystrrr model_configrrr(dictr*rrrrs88teD)))B )))"U4000C 000 X: $L% 4>% % % % N%T%%%%%%rrN)r.typingrlangchain_core.cachesrlangchain_core.callbacksrlangchain_core.language_modelsrlangchain_core.toolsrlangchain_core.tools.baserpydanticr r +langchain_community.tools.sql_database.toolr r r r*langchain_community.utilities.sql_databaserr model_rebuildr4rrr?s-33888888;;;;;;<<<<<<))))))111111&&&&&&&& CBBBBBp%p%p%p%p%p%p%p%f """""r