使用 OpenAI 和其他 VectorDB 为 Postgres 生成 SQL¶
本 Jupyter Notebook 将介绍如何使用 vanna Python 软件包通过 AI (RAG + LLMs) 生成 SQL，包括连接到数据库和训练。如果您还没有准备好在自己的数据库上进行训练，仍然可以使用示例 SQLite 数据库 进行尝试。
您想使用哪种 LLM？
-
通过 Vanna.AI 使用 OpenAI (推荐)免费使用 Vanna.AI 生成查询
-
[已选中] OpenAI使用您自己的 API 密钥使用 OpenAI
-
Azure OpenAI如果您在 Azure 上部署了 OpenAI 模型
-
通过 Mistral API 使用 Mistral如果您有 Mistral API 密钥
-
其他 LLM如果您有不同的 LLM 模型
您想将“训练”数据存储在哪里？
设置¶
In [ ]
%pip install 'vanna[openai,postgres]'
In [ ]
from vanna.openai.openai_chat import OpenAI_Chat
from vanna.base import VannaBase
In [ ]
class MyCustomVectorDB(VannaBase):
def add_ddl(self, ddl: str, **kwargs) -> str:
# Implement here
def add_documentation(self, doc: str, **kwargs) -> str:
# Implement here
def add_question_sql(self, question: str, sql: str, **kwargs) -> str:
# Implement here
def get_related_ddl(self, question: str, **kwargs) -> list:
# Implement here
def get_related_documentation(self, question: str, **kwargs) -> list:
# Implement here
def get_similar_question_sql(self, question: str, **kwargs) -> list:
# Implement here
def get_training_data(self, **kwargs) -> pd.DataFrame:
# Implement here
def remove_training_data(id: str, **kwargs) -> bool:
# Implement here
class MyVanna(MyCustomVectorDB, OpenAI_Chat):
def __init__(self, config=None):
MyCustomVectorDB.__init__(self, config=config)
OpenAI_Chat.__init__(self, config=config)
vn = MyVanna(config={'api_key': 'sk-...', 'model': 'gpt-4-...'})
您想查询哪个数据库？
-
[已选中] Postgres
-
Snowflake
-
BigQuery
-
SQLite
-
其他数据库使用 Vanna 为任何 SQL 数据库生成查询
In [ ]
vn.connect_to_postgres(host='my-host', dbname='my-dbname', user='my-user', password='my-password', port='my-port')
训练¶
您只需训练一次。除非想添加更多训练数据，否则无需再次训练。
In [ ]
# The information schema query may need some tweaking depending on your database. This is a good starting point.
df_information_schema = vn.run_sql("SELECT * FROM INFORMATION_SCHEMA.COLUMNS")
# This will break up the information schema into bite-sized chunks that can be referenced by the LLM
plan = vn.get_training_plan_generic(df_information_schema)
plan
# If you like the plan, then uncomment this and run it to train
# vn.train(plan=plan)
In [ ]
# The following are methods for adding training data. Make sure you modify the examples to match your database.
# DDL statements are powerful because they specify table names, colume names, types, and potentially relationships
vn.train(ddl="""
CREATE TABLE IF NOT EXISTS my-table (
id INT PRIMARY KEY,
name VARCHAR(100),
age INT
)
""")
# Sometimes you may want to add documentation about your business terminology or definitions.
vn.train(documentation="Our business defines OTIF score as the percentage of orders that are delivered on time and in full")
# You can also add SQL queries to your training data. This is useful if you have some queries already laying around. You can just copy and paste those from your editor to begin generating new SQL.
vn.train(sql="SELECT * FROM my-table WHERE name = 'John Doe'")
In [ ]
# At any time you can inspect what training data the package is able to reference
training_data = vn.get_training_data()
training_data
In [ ]
# You can remove training data if there's obsolete/incorrect information.
vn.remove_training_data(id='1-ddl')
提问 AI¶
每当您提出一个新问题时，它会找到 10 条最相关的训练数据，并将其用作 LLM 提示的一部分来生成 SQL。
In [ ]
vn.ask(question=...)
启动用户界面¶
In [ ]
from vanna.flask import VannaFlaskApp
app = VannaFlaskApp(vn)
app.run()
