Text2SQL 示例
本演示展示了如何构建一个由 AI 驱动的接口,将自然语言问题转换为 SQL 查询,并在 TiDB 上执行这些查询。它基于 pytidb(TiDB 官方 Python SDK)、OpenAI GPT 和 Streamlit 构建,让你可以使用纯英文查询数据库。
前提条件
开始之前,请确保你具备以下条件:
- Python (>=3.10):安装 Python 3.10 或以上版本。
- 一个 TiDB Cloud Starter 实例:你可以在 TiDB Cloud 上创建一个免费的 TiDB Cloud Starter 实例。
- OpenAI API key:从 OpenAI 获取 OpenAI API key。
运行方式
第 1 步:克隆 pytidb 仓库
git clone https://github.com/pingcap/pytidb.git
cd pytidb/examples/text2sql/
第 2 步:安装所需软件包
python -m venv .venv
source .venv/bin/activate
pip install -r reqs.txt
第 3 步:运行 Streamlit 应用
streamlit run app.py
第 4 步:使用应用
打开浏览器并访问 http://localhost:8501。
- 在左侧边栏中输入你的 OpenAI API key
- 在左侧边栏中输入 TiDB 连接字符串,例如:
mysql+pymysql://root@localhost:4000/test
相关资源
- 源代码:在 GitHub 上查看