snowChat 💬❄️

snowChat 是一款直观且易于使用的应用程序，允许用户通过自然语言查询与 Snowflake 数据进行交互。只需输入您的问题或请求，snowChat 就会生成相应的 SQL 查询并返回所需数据。无需再编写复杂的 SQL 查询或手动翻阅表格——snowChat 让您轻松访问数据！通过让数据更贴近用户，snowChat 使用户能够更快、更高效地做出数据驱动的决策，从而降低用户与所需洞察之间的障碍。

支持的 LLM

• GPT-4o
• Gemini Flash 1.5 8B
• Claude 3 Haiku
• Llama 3.2 3B
• Llama 3.1 405B

https://github.com/kaarthik108/snowChat/assets/53030784/24105e23-69d3-4676-b6d6-d8157dd1580a

🌟 功能

• 对话式 AI：使用 ChatGPT 等模型将自然语言转换为精确的 SQL 查询。
• 对话记忆：保留上下文，实现交互式、动态响应。
• Snowflake 集成：直接从您的 Snowflake 数据库中提供无缝的实时数据洞察。
• 自我修复 SQL：主动建议解决 SQL 错误的方法，简化数据访问流程。
• 交互式用户界面：将数据查询转化为有趣的对话，并提供聊天重置选项。
• 基于代理的架构：利用代理管理交互和工具使用。

🛠️ 安装

1. 克隆此仓库： git clone https://github.com/yourusername/snowchat.git

2. 安装所需的软件包： cd snowchat pip install -r requirements.txt

3. 在项目目录中的 secrets.toml 文件中设置您的 OPENAI_API_KEY、ACCOUNT、USER_NAME、PASSWORD、ROLE、DATABASE、SCHEMA、WAREHOUSE、SUPABASE_URL、SUPABASE_SERVICE_KEY、SUPABASE_STORAGE_URL、CLOUDFLARE_ACCOUNT_ID、CLOUDFLARE_NAMESPACE_ID 和 CLOUDFLARE_API_TOKEN。此处使用 Cloudflare 来缓存 Snowflake 的响应数据。

4. 创建您的模式并将它们存储在与您的数据库匹配的 docs 文件夹中。

5. 从 supabase/scripts.sql 中创建 Supabase 扩展、表和函数。

6. 运行 python ingest.py 以获取嵌入并向索引文件中存储。

7. 运行 Streamlit 应用程序开始聊天： streamlit run main.py

星标历史

[]

🤝 贡献

欢迎通过提交拉取请求或打开议题来参与本项目的开发。您的反馈和建议将不胜感激！

📄 许可证

本项目采用 MIT 许可证授权——详情请参阅 LICENSE 文件。

snowChat 快速上手指南

snowChat 是一款基于 Streamlit 构建的开源工具，允许用户使用自然语言与 Snowflake 数据库进行交互。它利用大语言模型（LLM）将用户问题自动转换为 SQL 查询，并返回结果，无需编写复杂的 SQL 代码。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows
• Python 版本: Python 3.8 或更高版本
• 账号与服务:
  • Snowflake 账号（包含 Account, User, Password, Role, Database, Schema, Warehouse 信息）
  • LLM API Key（支持 OpenAI, Gemini, Claude, Llama 等）
  • Supabase 项目（用于存储扩展、表和函数）
  • Cloudflare 账号（可选，用于 KV 缓存加速）
• 前置依赖: git, pip

安装步骤

1. 克隆项目

将代码仓库克隆到本地：

git clone https://github.com/kaarthik108/snowChat.git
cd snowChat

2. 安装依赖

安装项目所需的 Python 包：

pip install -r requirements.txt

提示：国内开发者如遇下载缓慢，可使用清华源加速： pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

3. 配置密钥

在项目根目录下创建或编辑 secrets.toml 文件（通常位于 .streamlit/ 文件夹下，若不存在可手动创建），填入以下配置信息：

OPENAI_API_KEY = "your_openai_key"
ACCOUNT = "your_snowflake_account"
USER_NAME = "your_username"
PASSWORD = "your_password"
ROLE = "your_role"
DATABASE = "your_database"
SCHEMA = "your_schema"
WAREHOUSE = "your_warehouse"
SUPABASE_URL = "your_supabase_url"
SUPABASE_SERVICE_KEY = "your_supabase_service_key"
SUPABASE_STORAGE_URL = "your_supabase_storage_url"
CLOUDFLARE_ACCOUNT_ID = "your_cloudflare_account_id"
CLOUDFLARE_NAMESPACE_ID = "your_cloudflare_namespace_id"
CLOUDFLARE_API_TOKEN = "your_cloudflare_api_token"

注：Cloudflare 相关配置用于缓存 Snowflake 响应，若不需要可留空或根据实际需求调整。

4. 准备数据库文档

确保您的数据库架构文档已准备好，并将其存放在项目的 docs 文件夹中，文件名需与您的数据库匹配。这将帮助 AI 更准确地理解表结构。

5. 初始化 Supabase

登录您的 Supabase SQL 编辑器，运行 supabase/scripts.sql 文件中的脚本，以创建必要的扩展、数据表和函数。

6. 生成向量索引

运行以下脚本，将文档转换为嵌入向量（Embeddings）并存储为索引文件：

python ingest.py

基本使用

完成上述配置后，即可启动应用进行对话式数据查询。

1. 启动应用 在终端执行以下命令启动 Streamlit 服务：

   streamlit run main.py
   

2. 开始对话 浏览器会自动打开应用界面（通常为 http://localhost:8501）。

   • 在聊天框中输入自然语言问题，例如：“显示上个月销售额最高的前 10 个产品”。
   • snowChat 会自动生成对应的 SQL 查询，执行并从 Snowflake 获取数据返回给您。
   • 支持多轮对话，系统会保留上下文记忆。
   • 若生成的 SQL 出错，系统具备“自愈”功能，会尝试自动修正并提供建议。

3. 重置会话 如需清除当前对话历史，可使用界面上的重置按钮开始新的查询会话。