Project Icon

MindSQL

简化数据库交互的智能RAG库

MindSQL是一个Python RAG库,旨在简化数据库交互。它支持PostgreSQL、MySQL和SQLite等主流数据库,并可扩展至Snowflake和BigQuery。通过整合大型语言模型和向量存储,MindSQL实现了自然语言数据查询和可视化。这个库只需几行代码即可使用,适用于数据分析和数据库管理。

🧠 MindSQL

MindSQL 是一个 Python RAG(检索增强生成)库,旨在通过几行代码简化用户与数据库的交互。它可以无缝集成著名的数据库,如 PostgreSQL、MySQL 和 SQLite,同时通过扩展 IDatabase 接口,还支持 Snowflake 和 BigQuery 等主要数据库。该库利用大型语言模型(LLM)如 GPT-4、Llama 2、Google Gemini,并支持 ChromaDB 和 Faiss 等知识库。

MindSQL 图表

🚀 安装

要安装 MindSQL,你可以使用 pip:

pip install mindsql

MindSQL 需要 Python 3.10 或更高版本。

💡 使用方法

# !pip install mindsql

from mindsql.core import MindSQLCore
from mindsql.databases import Sqlite
from mindsql.llms import GoogleGenAi
from mindsql.vectorstores import ChromaDB

# 添加你的配置
config = {"api_key": "你的API密钥"}

# 选择你想要使用的向量存储、LLM 和数据库
# 使用配置的 Llm、向量存储和数据库创建 MindSQLCore 实例
minds = MindSQLCore(
    llm=GoogleGenAi(config=config),
    vectorstore=ChromaDB(),
    database=Sqlite()
)

# 使用指定的 URL 创建数据库连接
connection = minds.database.create_connection(url="你的数据库连接URL")

# 将指定数据库中的所有数据定义语言(DDL)语句索引到向量存储中
minds.index_all_ddls(connection=connection, db_name='数据库名称')

# 从指定的示例路径批量索引问题-SQL 对
minds.index(bulk=True, path="你的问题-SQL示例.json")

# 向数据库提问并可视化结果
response = minds.ask_db(
    question="你的问题",
    connection=connection,
    visualize=True
)

# 从响应中提取并显示图表
chart = response["chart"]
chart.show()

# 关闭数据库连接
connection.close()

📁 代码结构

  • _utils: 包含常量和日志记录器的实用模块。
  • _helper: 帮助模块。
  • core: 主要核心模块,minds_core.py
  • databases: 数据库相关模块。
  • llms: 与语言模型相关的模块。
  • testing: 测试脚本。
  • vectorstores: 与向量存储相关的模块。
  • poetry.lockpyproject.toml: Poetry 依赖和配置文件。
  • tests: 测试用例。

🤝 贡献指南

感谢你考虑为我们的项目做出贡献!请遵循以下指南以确保顺利合作:

  1. 复刻仓库并从主分支创建你的分支。

  2. 确保你的代码符合我们的编码标准和约定。

  3. 彻底测试你的更改,并在 tests 文件夹中添加测试用例。

  4. 提交一个清楚描述问题和解决方案的拉取请求。

    了解更多

🐛 错误报告

如果你在使用 MindSQL 时遇到错误,请按照以下步骤帮助我们解决:

  1. 检查现有问题,看看是否已经报告了该错误。

  2. 如果没有,请打开一个新问题,详细描述错误,包括重现步骤和相关的截图或错误消息。

    了解更多

🚀 功能请求

我们欢迎对 MindSQL 的新功能或改进的建议。以下是请求新功能的方法:

  1. 检查现有的功能请求,避免重复。

  2. 如果你的功能请求是独特的,请打开一个新问题并描述你想看到的功能。

  3. 提供尽可能多的上下文和细节,以帮助我们理解你的请求。

    了解更多

📣 反馈

我们重视你的反馈,并致力于改进 MindSQL。以下是与我们分享你想法的方式:

  • 打开一个问题,提供一般反馈、建议或评论。
  • 提供具有建设性和具体的反馈,以帮助我们更好地理解你的观点。

感谢你对我们项目的兴趣!我们感谢你的支持,并期待与你合作。🚀

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号