1. 概述
vanna是一个可以将天然语言转为sql的工具。简朴的demo如下:
- !pip install vanna
- import vanna
- from vanna.remote import VannaDefault
- vn = VannaDefault(model='chinook', api_key=vanna.get_api_key('my-email@example.com'))
- vn.connect_to_sqlite('https://vanna.ai/Chinook.sqlite')
- vn.ask("What are the top 10 albums by sales?")
复制代码 执行下面的代码运行图形界面
- from vanna.flask import VannaFlaskApp
- VannaFlaskApp(vn).run()
复制代码 2. 配置
数据库可以是任何数据库,好比mysql如下:
- import pandas as pd
- import psycopg2
- def run_sql(sql):
- conn = psycopg2.connect(
- host="localhost",
- database="my_database",
- user="my_user",
- password="my_password"
- )
- return pd.read_sql(sql, conn)
- vn.run_sql = run_sql
- vn.run_sql_is_set = True
复制代码 向量数据库稍微贫苦一些,目前支持的包括:
参考代码如下:
- from vanna.chromadb.chromadb_vector import ChromaDB_VectorStore
- class MyVanna(ChromaDB_VectorStore):
- def __init__(self, config=None):
- ChromaDB_VectorStore.__init__(self, config=config)
- vn = MyVanna(config={'path': '/path/to/chromadb'})
复制代码 3. 训练
训练数据可以是:DDL、documentation、sql以及Question-SQL Pairs
- vn.train(ddl="CREATE TABLE my_table (id INT, name TEXT)")
- vn.train(documentation="Our business defines XYZ as ABC")
- vn.train(sql="SELECT col1, col2, col3 FROM my_table")
复制代码 可以设置auto_train = True
4. 询问
- vn.ask("What are the top 10 customers by sales?")
复制代码 它包罗下列几个函数:
- vn.generate_sql
- vn.run_sql
- vn.generate_plotly_code
- vn.get_plotly_figure
复制代码 visualize=False
5. 启用服务
参考https://github.com/vanna-ai/vanna-flask,将LLM、embedding、vectorStore都改造成自己的代码。
首先是LLM,改造框架为:
- from vanna.base import VannaBase
- class MyLLM(VannaBase):
- def __init__(self,config=None):
- VannaBase.__init__(self, config=config)
- ...
- def system_message(self, message: str) -> any:
- return {"role": "system", "content": message}
- def user_message(self, message: str) -> any:
- return {"role": "user", "content": message}
- def assistant_message(self, message: str) -> any:
- return {"role": "assistant", "content": message}
- def submit_prompt(self, prompt, **kwargs) -> str:
- ...
复制代码 然后是embedding,必要定义encode_documents和encode_queries两个函数,比方:
- class BgeM3:
- def __init__(self, url):
- self.url = url
- def encode_documents(self, docs):
- ....
- def encode_queries(self, queries):
- ....
复制代码 接下来是vectorStore,我们使用milvus,它会主动调用config中的embedding_function,我们把它定义成上面的BegM3即可:
- class MyVanna(Milvus_VectorStore, QwenLLM):
- def __init__(self, config=None):
- Milvus_VectorStore.__init__(self, config=config)
- QwenLLM.__init__(self, config=config)
- vn = MyVanna(config={'milvus_client': MilvusClient(...),'embedding_function':BgeM3(...)})
复制代码 然后定义毗连的数据库,可以换成恣意的其他数据库:
- def run_sql(sql: str) -> pd.DataFrame:
- cnx = mysql.connector.connect(...)
- cursor = cnx.cursor()
- cursor.execute(sql)
- result = cursor.fetchall()
- columns = cursor.column_names
- df = pd.DataFrame(result, columns=columns)
- return df
-
- vn.run_sql = run_sql
- vn.run_sql_is_set = True
复制代码 接着执行python app.py即可启用服务,访问localhost:5000可以打开页面:
同时也可以调用接口:
- import requests
- response = requests.get(url+'/api/v0/get_training_data',headers={'Content-Type':'application/json'})
- response.json()
复制代码 所有可用的接口清单可以参考app.py。
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。 |