Quivr 开源项目使用教程

Quivr 开源项目使用教程

quivr Quivr，作为你的第二大脑，充分利用生成式人工智能（Generative AI）的力量成为你的个人智能助手！ 项目地址: https://gitcode.com/gh_mirrors/qui/quivr

1. 项目介绍

Quivr 是一个开源的 RAG（Retrieval-Augmented Generation）框架，旨在构建生成式 AI 的第二大脑。它可以帮助用户快速构建一个生产力助手，支持与文档（如 PDF、CSV 等）和应用程序进行聊天交互。Quivr 利用了 Langchain、GPT 3.5/4 Turbo 等技术，支持私有部署，并且可以与多种大型语言模型（LLMs）如 Anthropic、VertexAI、Ollama 等集成。

主要特点

• 快速高效：设计时注重速度和效率，确保快速访问数据。
• 安全可靠：用户数据完全由用户控制，始终保持安全。
• 兼容性强：支持 Ubuntu 20 及以上版本，兼容多种文件格式。
• 开源免费：完全开源，免费使用。
• 支持离线模式：即使在没有网络的情况下也能访问数据。

2. 项目快速启动

前提条件

确保你已经安装了以下软件：

• Docker
• Docker Compose

快速启动步骤

步骤 1：克隆仓库

git clone https://github.com/QuivrHQ/quivr.git
cd quivr

步骤 2：复制环境文件

cp .env.example .env

步骤 3：更新环境文件

使用你喜欢的编辑器打开 .env 文件，并更新 OPENAI_API_KEY 变量。

vim .env

步骤 4：启动项目

cd backend
supabase start
cd ../
docker compose pull
docker compose up

步骤 5：访问应用

你可以通过以下地址访问应用：

• 前端应用：http://localhost:3000/login
• 后端 API：http://localhost:5050/docs
• Supabase：http://localhost:54323

3. 应用案例和最佳实践

案例 1：文档助手

Quivr 可以作为一个文档助手，帮助用户快速查找和理解 PDF、CSV 等文件中的信息。用户可以通过自然语言与 Quivr 进行交互，获取所需信息。

案例 2：生产力工具

Quivr 可以集成到生产力工具中，帮助用户管理任务、记录笔记，并通过 AI 生成内容，提高工作效率。

最佳实践

• 数据安全：确保所有敏感数据在本地存储，避免上传到云端。
• 性能优化：根据实际需求调整 Docker 配置，优化系统性能。
• 持续更新：定期拉取最新代码，确保使用最新功能和修复。

4. 典型生态项目

Langchain

Langchain 是一个用于构建语言模型应用的开源框架，Quivr 利用 Langchain 进行自然语言处理和生成。

GPT-3.5/4 Turbo

GPT-3.5 和 GPT-4 Turbo 是 OpenAI 提供的大型语言模型，Quivr 支持与这些模型集成，提供强大的文本生成能力。

Supabase

Supabase 是一个开源的 Firebase 替代品，Quivr 使用 Supabase 进行数据库管理和用户认证。

通过这些生态项目的集成，Quivr 能够提供一个完整且强大的 AI 助手解决方案。

quivr Quivr，作为你的第二大脑，充分利用生成式人工智能（Generative AI）的力量成为你的个人智能助手！ 项目地址: https://gitcode.com/gh_mirrors/qui/quivr