Vanna 项目安装和配置指南

Vanna 项目安装和配置指南

vanna 人工智能驱动的数据库查询 。使用RAG实现准确的文本到SQL的转换 。 项目地址: https://gitcode.com/gh_mirrors/va/vanna

1. 项目基础介绍和主要编程语言

项目基础介绍

Vanna 是一个 MIT 许可的开源 Python 框架，旨在通过使用 RAG（Retrieval-Augmented Generation）技术，实现与 SQL 数据库的交互。用户可以通过自然语言提问，Vanna 会自动生成相应的 SQL 查询，并执行查询以获取结果。

主要编程语言

Vanna 项目主要使用 Python 编程语言进行开发。

2. 项目使用的关键技术和框架

关键技术和框架

• RAG（Retrieval-Augmented Generation）: 这是一种结合了检索和生成技术的方法，用于生成准确的 SQL 查询。
• LLM（Large Language Model）: 使用大型语言模型来理解和生成自然语言查询。
• SQL 数据库: 支持任何可以通过 Python 连接的 SQL 数据库。
• OpenAI 和 ChromaDB: 提供了与这些服务的集成，用户可以自定义使用其他 LLM 或向量数据库。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装和配置 Vanna 之前，请确保您的系统满足以下要求：

• Python 3.7 或更高版本
• 安装了 pip（Python 包管理工具）
• 访问互联网以安装所需的 Python 包

安装步骤

步骤 1：克隆项目仓库

首先，您需要从 GitHub 克隆 Vanna 项目仓库到本地。

git clone https://github.com/vanna-ai/vanna.git
cd vanna

步骤 2：创建虚拟环境（可选）

为了隔离项目的依赖环境，建议创建一个虚拟环境。

python3 -m venv vanna-env
source vanna-env/bin/activate  # 在 Windows 上使用 `vanna-env\Scripts\activate`

步骤 3：安装依赖包

使用 pip 安装项目所需的依赖包。

pip install -r requirements.txt

步骤 4：配置 Vanna

Vanna 的配置可以通过设置环境变量或直接在代码中进行。以下是一个简单的配置示例：

from vanna.openai import OpenAI_Chat
from vanna.chromadb import ChromaDB_VectorStore

class MyVanna(ChromaDB_VectorStore, OpenAI_Chat):
    def __init__(self, config=None):
        ChromaDB_VectorStore.__init__(self, config=config)
        OpenAI_Chat.__init__(self, config=config)

vn = MyVanna(config={'api_key': 'your-openai-api-key', 'model': 'gpt-4'})

步骤 5：训练和使用 Vanna

您可以通过提供 DDL 语句、文档或 SQL 查询来训练 Vanna。以下是一个简单的训练和使用示例：

# 训练 Vanna
vn.train(ddl="""
CREATE TABLE IF NOT EXISTS my_table (
    id INT PRIMARY KEY,
    name VARCHAR(100),
    age INT
)
""")

# 提问并获取 SQL 查询
sql_query = vn.ask("What are the top 10 customers by sales?")
print(sql_query)

结束语

通过以上步骤，您已经成功安装并配置了 Vanna 项目。您现在可以开始使用 Vanna 与您的 SQL 数据库进行交互，并通过自然语言提问来获取数据洞察。

vanna 人工智能驱动的数据库查询 。使用RAG实现准确的文本到SQL的转换 。 项目地址: https://gitcode.com/gh_mirrors/va/vanna