使用 OpenAI、Marqo 为 Postgres 生成 SQL¶
本笔记本介绍了使用 vanna Python 包通过 AI（RAG + LLM）生成 SQL 的过程，包括连接到数据库和训练。如果你还没准备好在你自己的数据库上进行训练，仍然可以使用示例 SQLite 数据库来尝试。
你想使用哪个 LLM？
-
通过 Vanna.AI 使用 OpenAI（推荐）免费使用 Vanna.AI 生成你的查询
-
[Selected] OpenAI使用你自己的 API 密钥使用 OpenAI
-
Azure OpenAI如果你在 Azure 上部署了 OpenAI 模型
-
通过 Mistral API 使用 Mistral如果你有 Mistral API 密钥
-
其他 LLM如果你有其他 LLM 模型
你想在哪里存储‘训练’数据？
-
Vanna 托管向量数据库（推荐）免费使用 Vanna.AI 的托管向量数据库 (pgvector)。这可以在不同机器上使用，无需额外设置。
-
ChromaDB免费在本地使用 ChromaDB 的开源向量数据库。无需额外设置——所有数据库文件将在本地创建和存储。
-
[Selected] Marqo免费在本地使用 Marqo。需要额外设置。或者使用他们的托管选项。
-
其他向量数据库使用任何其他向量数据库。需要额外设置。
设置¶
在 [ ]
%pip install 'vanna[marqo,openai,postgres]'
在 [ ]
from vanna.openai.openai_chat import OpenAI_Chat
from vanna.marqo.marqo import Marqo
在 [ ]
class MyVanna(Marqo, OpenAI_Chat):
def __init__(self, config=None):
Marqo.__init__(self, config={'marqo_url': MARQO_URL, 'marqo_model': MARQO_MODEL})
OpenAI_Chat.__init__(self, config=config)
vn = MyVanna(config={'api_key': 'sk-...', 'model': 'gpt-4-...'})
你想查询哪个数据库？
-
[Selected] Postgres
-
Snowflake
-
BigQuery
-
SQLite
-
其他数据库使用 Vanna 为任何 SQL 数据库生成查询
在 [ ]
vn.connect_to_postgres(host='my-host', dbname='my-dbname', user='my-user', password='my-password', port='my-port')
训练¶
你只需要训练一次。除非你想添加更多训练数据，否则不要再次训练。
在 [ ]
# 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)
在 [ ]
# 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'")
在 [ ]
# At any time you can inspect what training data the package is able to reference
training_data = vn.get_training_data()
training_data
在 [ ]
# You can remove training data if there's obsolete/incorrect information.
vn.remove_training_data(id='1-ddl')
向 AI 提问¶
每当你提出新问题时，它会找到 10 个最相关的训练数据片段，并将其用作 LLM 提示的一部分来生成 SQL。
在 [ ]
vn.ask(question=...)
启动用户界面¶
在 [ ]
from vanna.flask import VannaFlaskApp
app = VannaFlaskApp(vn)
app.run()
