Text-to-SQL 工具Vanna + MySQL本地部署 | 数据库对话机器人

news2024/11/23 2:37:22

今天我们来重点研究与实测一个开源的Text2SQL优化框架 – Vanna
在这里插入图片描述

1. Vanna 简介【Text-to-SQL 工具】

Vanna 是一个基于 MIT 许可的开源 Python RAG（检索增强生成）框架，用于 SQL 生成和相关功能。它允许用户在数据上训练一个 RAG “模型”，然后提问问题，这将生成在数据库上运行的 SQL 查询语句，并将查询结果通过表格和图表的方式展示给用户。

简单的说，Vanna是一个开源的、基于Python的、用于SQL自动生成与相关功能的RAG（检索增强生成）框架。

基本特点：

  • 开放源代码：https://github.com/vanna-ai/vanna
  • 基于Python语言。可通过PyPi包vanna在自己项目中直接使用
  • RAG框架。RAG最典型的应用是 私有知识库问答，通过Prompt注入私有知识以提高LLM回答的准确性。但RAG本身是一种Prompt增强方案，完全可以用于其他LLM应用场景。

2. Vanna工作原理

借助LLM实现一个最简单的、基于Text2SQL的数据库对话机器人本身原理是比较简单的：
在这里插入图片描述
Vanna则是借助了相对简单也更易理解的RAG方法，通过检索增强来构建Prompt，以提高SQL生成的准确率：
在这里插入图片描述
从这张图可以了解到，Vanna的关键原理为：

借助数据库的DDL语句、元数据（数据库内关于自身数据的描述信息）、相关文档说明、参考样例SQL等训练一个RAG的“模型”（embedding+向量库）；
并在收到用户自然语言描述的问题时，从RAG模型中通过语义检索出相关的内容，进而组装进入Prompt，然后交给LLM生成SQL。

3. 使用步骤

第一步：在你的数据上训练一个RAG“模型”

把DDL/Schemas描述、文档、参考SQL等交给Vanna训练一个用于RAG检索的“模型”（向量库）。
在这里插入图片描述
本文尝试了1、3、4的方法，记住这几种方法，下面会用到。

第二步：提出“问题”，获得回答

RAG模型训练完成后，可以用自然语言直接提问。Vanna会利用RAG与LLM生成SQL，并自动运行后返回结果。

4. vanna的扩展与定制化

从上述的vanna原理介绍可以知道，其相关的三个主要基础设施为：

  • Database，即需要进行查询的关系型数据库
  • VectorDB，即需要存放RAG“模型”的向量库
  • LLM，即需要使用的大语言模型，用来执行Text2SQL任务

在这里插入图片描述
Vanna的设计具备了很好的扩展性与个性化能力，能够支持任意数据库、向量数据库与大模型。

4.1 自定义LLM与向量库

默认情况下，Vanna支持使用其在线LLM服务（对接OpenAI）与向量库，可以无需对这两个进行任何设置，即可使用。因此使用Vanna最简单的原型只需要五行代码：

import vanna
from vanna.remote import VannaDefault
vn = VannaDefault(model='model_name', api_key='api_key')
vn.connect_to_sqlite('https://vanna.ai/Chinook.sqlite')
vn.ask("What are the top 10 albums by sales?")

注意：使用Vanna.AI的在线LLM与向量库服务，需要首先到 https://vanna.ai/ 去申请账号，具体请参考下一部分实测。

如果需要使用自己本地的LLM或者向量库，比如使用自己的OpenAI账号与ChromaDB向量库，则可以扩展出自己的Vanna对象，并传入个性化配置即可。

from vanna.openai.openai_chat import OpenAI_Chat
from vanna.chromadb.chromadb_vector 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': 'sk-...', 'model': 'gpt-4-...'})

这里的OpenAI_Chat和ChromaDB_VectorStore是Vanna已经内置支持的LLM和VectorDB。
如果你需要支持 没有内置支持的LLM和vectorDB，
则需要首先 扩展出自己的LLM类与VectorDB类，
实现必要的方法（具体可参考官方文档），
然后再 扩展出自己的Vanna对象：
在这里插入图片描述

4.2 自定义关系型数据库

Vanna默认支持Postgres，SQL Server，Duck DB，SQLite等关系型数据库，可直接对这一类数据库进行自动访问，实现数据对话机器人。
但如果需要连接自己企业的其他数据库，比如企业内部的Mysql或者Oracle，自需要定义一个个性化的run_sql方法，并返回一个Pandas Dataframe即可。具体可参考下方的实测代码。

5. 实测：数据库对话机器人

这里我们使用Vanna快速构建一个与数据库对话的AI智能体，直观的感受Vanna的工作过程与效果。

【0 - 选择基础环境】

  • LLM（大模型）
    选择Vanna.AI在线提供的OpenAI服务，真实环境中建议使用自己的LLM。
  • VectorDB（向量数据库）
    选择Vanna.AI在线提供的VectorDB服务，真实环境中可根据条件灵活选择。
  • RDBMS（关系型数据库）
    我们选择本地测试环境中的一个MySQL数据库，其中存放了一些测试的社区用户信息数据customer：
    在这里插入图片描述

我用DBeaver工具来管理MySQL数据库，创建数据可以用SQL语句CREATE 或 导入csv
导入csv可以参考【数据库】DBeaver链接MariaDB建表，导入csv数据这篇博客

【1 - 申请Vanna账号】

由于我们使用了Vanna.AI的在线LLM与vectorDB服务。因此首先在Vanna.AI申请一个账号，并获得API-key（红框中部分 / 代码中隐藏部分）：
在这里插入图片描述
设置一个Model name，用于在线的RAG model：
我的设置为：community
在这里插入图片描述
注意：与新数据库对话，需要重新设置一个Model name

【2 - 构建Vanna对象】

pip install vanna

使用pip安装vanna库后，首先使用如下代码创建默认的Vanna对象：

import vanna
from vanna.remote import VannaDefault
api_key = '上面获得的API-key'
vanna_model_name = '上面设置的model-name( 我的是community )'
vn = VannaDefault(model=vanna_model_name, api_key=api_key)

由于我们需要使用自己的本地Mysql数据库，需要定义一个run_sql方法
设置好MySQL数据库的user 、password、host 和 database

（这个database名称是DBeaver工具customer上方的数据库名称Community，RAG model的名称是网页上设置的 community，首字母是小写的，各位别抄错啦！按自己的配置来哈！）

import pandas as pd
import mysql.connector

def run_sql(sql: str) -> pd.DataFrame:
    cnx = mysql.connector.connect(user='root',password='111000',host='localhost',database='Community')
    cursor = cnx.cursor()
    cursor.execute(sql)
    result = cursor.fetchall()
    columns = cursor.column_names
    df = pd.DataFrame(result, columns=columns)
    return df

将自定义的方法设置到上面创建的Vanna对象：

vn.run_sql = run_sql
vn.run_sql_is_set = True

【3 - 训练RAG Model】

这里我们先采用Vanna提供的一种更简单的方式：通过数据库的元数据信息构建训练计划(plan），然后交给Vanna生成RAG model：

df_information_schema = vn.run_sql("SELECT * FROM INFORMATION_SCHEMA.COLUMNS where table_schema = 'chatdata'")
plan = vn.get_training_plan_generic(df_information_schema)
vn.train(plan=plan)

我构建计划(plan)的方式失败！
故通过 DDL语句 和 SQL问答对 的方式来构建。

表和列名的注释很重要！
表和列名的注释很重要！
表和列名的注释很重要！
有助于vn识别语义，有的列名英文不是那么明确，可能会导致vn生成SQL出错。

比如身份证号的英文可以是id_number，我这里是id_card
比如性别的英文可以是sex，我这里是gender。

当时我的表还没添加注释，所以多加了CREATE TABLE的操作，如果各位同学在创建表时，已添加了注释，下面这句CREATE TABLE就可以省略了。

需要注意的是，下面的训练代码只需要执行一次即可。

vn.train(ddl="""
CREATE TABLE IF NOT EXISTS customer (
    name INT PRIMARY KEY COMMENT '姓名', 
    gender INT COMMENT '性别(男性=1/女性=2)', 
    id_card VARCHAR(100) COMMENT '身份证',
    mobile VARCHAR(100) COMMENT '手机', 
    nation VARCHAR(10) COMMENT '民族', 
    residential_city VARCHAR(100) COMMENT '居住城市',
) COMMENT='customer' CHARACTER SET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
""")

vn.train(question='年龄最大的是哪个？',sql='SELECT name FROM customer ORDER BY age DESC LIMIT 1')

可能直接给个问答对即可。引导vn去customer表中查询。
不行的话这两句vn.train都加上。

【4 - 测试：与数据库对话】

以上的准备工作完成后，就可以与你的关系型数据库对话了：

vn.ask('统计不同民族数量？')

控制台可以看到输出的结果，包含了SQL和执行结果：
在这里插入图片描述
并且会弹出一个网页，显示执行的结果
在这里插入图片描述
【5 - 前端Web APP测试】
Vanna提供了一个内置的基于Flask框架的Web APP，可以直接运行后，通过更直观的界面与你的数据库对话，并且具有图表可视化的效果，还内置了简单的RAG Model数据的管理功能。通过这种方式启动web App：

from vanna.flask import VannaFlaskApp
app = VannaFlaskApp(vn)
app.run()

通过默认的端口访问http://localhost:8084，即可与你的数据库对话，界面如下：
在这里插入图片描述
在这里插入图片描述
以上，我们深入了解了Vanna这样一个基于Python与RAG的Text2SQL交互式数据分析框架。借助这样的框架，我们无需太多关心Prompt的构建、组装与优化，就可以快速实现一个基于Text2SQL方案的交互式数据库对话机器人，且具备更高的正确率。

此外，Vanna也提供了一些有用的关联功能：

  • RAG model数据的查询与管理API
  • 基于Plotly的结果可视化API
  • 前端Web APP的简单参考实现

在实际测试中，我们也发现Vanna仍然存在一些问题，

  • 大部分问题和我们交给Vanna训练RAG model的信息不足
  • 倾向于一次性生成，不便基于上一句SQL进行调优[增、删、改]

根据Vanna.ai官方的未来愿景规划，Vanna旨在成为未来创建AI数据分析师的首选工具。并在准确性（Text2SQL的最大挑战）、交互能力（能够实现交互协作，比如要人类做进一步澄清、解释答案、甚至提出后续问题），与自主性（主动访问必要的系统和数据甚至触发工作流程等）三个方面更加接近人类数据分析师，我们希望Vanna未来能够展示更强大的能力。

6. 训练技巧

利用好 SQL问答对

  • 没添加SQL问答对之前
    问：居住在重庆市的人有哪些？
    答：SQL语句不够准确

    SELECT name 
FROM customer 
WHERE residential_city = '重庆';

    在这里插入图片描述

  • 添加SQL问答对之后
    问：居住在重庆市的人有哪些？
    答：SQL语句可以模糊匹配，可以得到准确的查询结果

    SELECT name 
FROM customer 
WHERE residential_city LIKE '%重庆%';

    在这里插入图片描述

代码自取

import vanna
from vanna.remote import VannaDefault
from vanna.flask import VannaFlaskApp
import pandas as pd
import mysql.connector

api_key = '7acxxx68c'
vanna_model_name = 'community'
vn = VannaDefault(model=vanna_model_name, api_key=api_key)

def run_sql(sql: str) -> pd.DataFrame:
    cnx = mysql.connector.connect(user='root',password='111000',host='localhost',database='Community')
    cursor = cnx.cursor()
    cursor.execute(sql)
    result = cursor.fetchall()
    columns = cursor.column_names
    # print('columns:',columns)
    df = pd.DataFrame(result, columns=columns)
    return df

# 将函数设置到vn.run_sql中
vn.run_sql = run_sql
vn.run_sql_is_set = True

# vn.train(ddl="""
# CREATE TABLE IF NOT EXISTS customer (
#     name INT PRIMARY KEY COMMENT '姓名', 
#     gender INT COMMENT '性别(男性=1/女性=2)', 
#     id_card VARCHAR(100) COMMENT '身份证',
#     mobile VARCHAR(100) COMMENT '手机', 
#     nation VARCHAR(10) COMMENT '民族', 
#     residential_city VARCHAR(100) COMMENT '居住城市',
# ) COMMENT='customer' CHARACTER SET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
# """)

vn.train(question='年龄最大的是哪个？',sql='SELECT name FROM customer ORDER BY age DESC LIMIT 1')
vn.train(question='居住在重庆的人有哪些？',sql="SELECT name FROM customer WHERE residential_city LIKE '%重庆%'")


first_conversation_sql = vn.ask('居住在重庆的人有哪些？')
print(type(first_conversation_sql))

app = VannaFlaskApp(vn)
app.run()

【参考链接】
手把手教你本地部署开源 Text-to-SQL 工具：Vanna
Vanna：10分钟快速构建基于大模型与RAG的SQL数据库对话机器人

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1513172.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

PLC数采网关在实际应用中的效能-天拓四方

PLC数采网关在实际应用中的效能-天拓四方

在工业自动化领域中，PLC扮演着至关重要的角色，它负责控制和监测生产线的各个环节。然而，随着工业4.0的推进和智能制造的快速发展，单纯依靠PLC进行现场控制已无法满足企业对数据集中管理、远程监控和智能分析的需求。因此&#xff…
阅读更多...
立即注册 | 线上讲座：借助 NGINX Plus 优化物联网数据传输和应用安全

立即注册 | 线上讲座：借助 NGINX Plus 优化物联网数据传输和应用安全

原文作者：NGINX 原文链接：立即注册 | 线上讲座：借助 NGINX Plus 优化物联网数据传输和应用安全 转载来源：NGINX 开源社区 NGINX 唯一中文官方社区 ，尽在 nginx.org.cn 基本信息 课程主题 借助 NGINX Plus 优化物联网…
阅读更多...
地理数据 vs. 3D数据

地理数据 vs. 3D数据

在表示我们周围的物理世界时，地理空间数据和 3D 建筑数据是两个最常见的选择。 他们在各个行业和项目中发挥着至关重要的作用。 从构建数字孪生到可视化城市景观和创建沉浸式应用程序。 尽管地理空间和 3D 建筑数据有相似之处，但它们不可互换。 虽然地…
阅读更多...
专升本 C语言笔记-05 常量定义 #define宏定义 const关键字 enum关键字

专升本 C语言笔记-05 常量定义 #define宏定义 const关键字 enum关键字

1.宏定义 #define的使用 1.1.宏定义的概念 宏定义就是用一个标识符来表示一个字符串,如果后面代码出现了该标识符,那么就全部替换成指定的字符串 1.2.宏定义实现案例 #include <stdio.h> #define N 123 int main() {printf("N %d\n",N);printf("N N…
阅读更多...
Linux tcpdump抓包转Wireshark 分析

Linux tcpdump抓包转Wireshark 分析

简介 tcpdump 是Linux系统下的一个强大的命令&#xff0c;可以将网络中传送的数据包完全截获下来提供分析。它支持针对网络层、协议、主机、网络或端口的过滤&#xff0c;本文将展示如何使用 tcpdump 抓包&#xff0c;以及如何用 tcpdump 和 wireshark 分析网络流量 tcpdump指…
阅读更多...
一文带你详解天池医疗数据集

一文带你详解天池医疗数据集

医疗作为和民生健康息息相关的产业&#xff0c;通过天池大赛开放出一批有临床科研价值的数据集&#xff0c;涵盖了预防、辅诊、医学科研等主题。 与此同时&#xff0c;阿里云天池平台也积极推动产学研的共同进步&#xff0c;开源了多个本地生活领域的数据集&#xff0c;如aBea…
阅读更多...
(含代码)利用TensorRT的8位PTQ将Stable Diffusion速度提高 2 倍

(含代码)利用TensorRT的8位PTQ将Stable Diffusion速度提高 2 倍

利用TensorRT的8位PTQ将Stable Diffusion速度提高 2 倍 在生成人工智能的动态领域中&#xff0c;扩散模型脱颖而出&#xff0c;成为生成带有文本提示的高质量图像的最强大的架构。 像稳定扩散这样的模型已经彻底改变了创意应用。 然而&#xff0c;由于需要迭代去噪步骤&#x…
阅读更多...
vulhub靶场-Jangow

vulhub靶场-Jangow

下载&部署 下载 下载链接&#xff1a; https://download.vulnhub.com/jangow/jangow-01-1.0.1.ova 点击下载即可 部署 因为源虚拟机是从virtualbox导出的&#xff0c;为了避免繁琐的操作步骤&#xff0c;用virtualbox来导入 virtualbox下载地址&#xff1a; https:…
阅读更多...
2021年1月1日起四川启动食品经营许可与备案电子证书办理

2021年1月1日起四川启动食品经营许可与备案电子证书办理

12月25日&#xff0c;四川省市场监督管理局、四川省大数据中心发布《关于启用食品经营许可登记电子证书的公告》&#xff08;以下简称《公告》&#xff09;。 《公告》显示&#xff0c;为贯彻落实《食品经营许可证管理办法》、《四川省小食品作坊、小经营店、商贩管理规定》和国…
阅读更多...
常见面试题之计算机网络

常见面试题之计算机网络

1. OSI 五层模型&#xff08;或七层模型&#xff09;是什么&#xff0c;每一层的作用是什么 应用层&#xff1a;又可细分为应用层、表示层、会话层。其中应用层主要做的工作就是为应用程序提供服务&#xff0c;常见的协议为 HTTP、HTTPS、DNS等&#xff1b;表示层主要做的工作…
阅读更多...
PXE自动化安装操作系统

PXE自动化安装操作系统

一、PXE基本介绍 PXE&#xff0c;全名Pre-boot Execution Environment&#xff0c;预启动执行环境&#xff1b; 通过网络接口启动计算机&#xff0c;不依赖本地存储设备&#xff08;如硬盘&#xff09;或本地已安装的操作系统&#xff1b; 由Intel和Systemsoft公司于1999年9月…
阅读更多...
通过一篇文章让你了解什么是函数栈帧

通过一篇文章让你了解什么是函数栈帧

函数栈帧的创建和销毁 前言一、什么是函数栈帧二、 理解函数栈帧能解决什么问题三、 函数栈帧的创建和销毁解析3.1 什么是栈3.2 认识相关寄存器和汇编指令相关寄存器eaxebxebpespeip 相关汇编命令 3.3 解析函数栈帧的创建和销毁3.3.1 预备知识3.3.2 函数的调用堆栈3.3.4 准备环…
阅读更多...
*Javaweb -- MyBatis*

*Javaweb -- MyBatis*

一:介绍: 1.MyBatis是一个优秀的 ①持久层 ②框架,用于简化JDBC的开发! ①:JAVAEE有三层的结构:表现层, 业务层, 持久层. 表现层代表的是页面的展示,业务层则指的是对于相关逻辑的处理, 而持久层, 指的则是对于数据进行持久化,保存在数据库当中. 持久层具体的来说就是负责…
阅读更多...
宏碁又遭网络袭击，菲律宾分公司大量数据被盗

宏碁又遭网络袭击，菲律宾分公司大量数据被盗

近日&#xff0c;宏碁&#xff08;Acer&#xff09;菲律宾公司方面证实&#xff0c;管理该公司员工考勤数据的第三方供应商遭遇网络攻击&#xff0c;部分员工数据被盗。 宏碁&#xff0c;中国台湾计算机硬件和电子产品制造商&#xff0c;以其电脑产品极具性价比而闻名。 据悉&a…
阅读更多...
生成式AI来袭，FOSS全闪对象存储应时而生

生成式AI来袭，FOSS全闪对象存储应时而生

AI大模型正飞速跃进&#xff0c;从引领文本生成革命的ChatGPT到开创文生视频新纪元的Sora&#xff0c;多模态交互技术连续迭代&#xff0c;促进了智算中心的快速落地。在这一过程中&#xff0c;算力的迅猛增长对存储系统提出了更高的要求和挑战。为满足这些日益增长的需求&…
阅读更多...
3_springboot_shiro_jwt_多端认证鉴权_Redis缓存管理器.md

3_springboot_shiro_jwt_多端认证鉴权_Redis缓存管理器.md

1. 什么是Shiro缓存管理器 上一章节分析完了Realm是怎么运作的&#xff0c;自定义的Realm该如何写&#xff0c;需要注意什么。本章来关注Realm中的一个话题&#xff0c;缓存。再看看 AuthorizingRealm 类继承关系 其中抽象类 CachingRealm &#xff0c;表示这个Realm是带缓存…
阅读更多...
【Linux】Centos7上安装MySQL5.7

【Linux】Centos7上安装MySQL5.7

目录 1.下载安装包2. 上传安装包3.将 mysql 解压到/usr/local/4.重命名5.创建mysql用户及用户组6. 进入 mysql 目录修改权限7. 安装依赖库8. 执行安装脚本9. 复制启动脚本到资源目录10. 拷贝 my.cnf&#xff0c;并赋予权限11. 配置环境变量12. 启动 mysqld13. 登录 MySQL&#…
阅读更多...
深度解析：如何运用山海鲸可视化软件制作高效销售数据看板

深度解析：如何运用山海鲸可视化软件制作高效销售数据看板

在数字化时代&#xff0c;数据可视化已经成为企业决策和运营的重要工具。作为一名长期使用山海鲸可视化软件的资深用户&#xff0c;我深知其在制作销售数据可视化看板方面的优势。今天&#xff0c;我想分享一些我在使用山海鲸可视化软件制作销售数据可视化看板过程中的经验和感…
阅读更多...
探索：C++继承中虚表与虚基表的内存存储

探索：C++继承中虚表与虚基表的内存存储

探讨&#xff1a;菱形虚拟继承的虚基表和虚表 在继承和多态里&#xff0c;总是能听到虚表、虚基表这样的词汇&#xff0c;没有洞悉其根本的人很容易将它们混淆&#xff0c;因此&#xff0c;我们对这两个“虚”“表”进行实践&#xff0c;来更好地理解它们。 通俗些说&#xf…
阅读更多...
哪些行业实操会用到PMP的知识？

哪些行业实操会用到PMP的知识？

首先说项目管理适合那些行业。 项目管理覆盖的行业可以说非常广了&#xff0c;就我知道的&#xff0c;医疗啊&#xff0c;互联网啊&#xff0c;机械啊&#xff0c;建筑啊&#xff0c;金融啊&#xff0c;汽车啊&#xff0c;零售啊、广告啊等各行各业都是需要项目管理人员的。 …
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023