RAGstack 开源项目安装与配置指南

RAGstack 开源项目安装与配置指南

rag-stack 🤖 Deploy a private ChatGPT alternative hosted within your VPC. 🔮 Connect it to your organization's knowledge base and use it as a corporate oracle. Supports open-source LLMs like Llama 2, Falcon, and GPT4All. 项目地址: https://gitcode.com/gh_mirrors/ra/rag-stack

1. 项目基础介绍

RAGstack 是一个开源项目，旨在在用户的私有虚拟私有云（VPC）中部署一个类似 ChatGPT 的聊天机器人。它可以连接到企业的知识库，用作企业级智能体。该项目支持多种开源大型语言模型（LLM），包括 Llama 2、Falcon 和 GPT4All。

主要编程语言：TypeScript、Python、HCL、Shell、JavaScript、PowerShell

2. 项目使用的关键技术和框架

• Retrieval Augmented Generation (RAG)：一种通过从其他系统中检索信息并插入到大型语言模型（LLM）的上下文窗口中，以增强其能力的技术。
• 大型语言模型 (LLM)：如 GPT4All、Falcon-7b 和 Llama 2。
• 向量数据库：Qdrant，一个高性能、可自托管的向量数据库。
• 服务器和用户界面：用于处理 PDF 上传，使用 Qdrant 和选择的开源 LLM 进行聊天。

3. 项目安装和配置准备工作

在开始安装之前，请确保您已经准备好了以下环境和工具：

• Git：用于克隆项目代码。
• Python：项目中的某些组件需要 Python 环境。
• Node.js 和 npm 或 yarn：用于安装前端依赖项。
• Supabase：一个开源的后端服务，用于处理数据库和其他后端功能。
• Google Cloud Platform (GCP)、Amazon Web Services (AWS) 或 Microsoft Azure：用于部署项目（如果需要云端部署）。

4. 详细安装步骤

克隆项目代码

首先，您需要在您的计算机上克隆项目代码：

git clone https://github.com/psychic-api/rag-stack.git
cd rag-stack

配置本地环境

在项目目录中，您需要复制 .env 文件并进行适当的配置。

对于前端（ragstack-ui）：

cp ragstack-ui/local.env ragstack-ui/.env

对于后端（server）：

cp server/example.env server/.env

在 .env 文件中，您需要将 YOUR_SUPABASE_URL 和 YOUR_SUPABASE_KEY 替换为您的 Supabase 项目 URL 和密钥。

安装依赖项

接着，安装前端和后端的依赖项：

# 安装前端依赖
cd ragstack-ui
npm install # 或者使用 yarn install

# 安装后端依赖
cd ../server
npm install # 或者使用 yarn install

启动服务

在所有依赖项安装完成后，您可以启动服务：

# 启动后端服务
cd server
node server.js # 或者使用其他指定命令

# 启动前端服务
cd ../ragstack-ui
npm start # 或者使用 yarn start

此时，如果一切正常，您应该能够通过浏览器访问前端服务，并开始使用 RAGstack。

注意

• 本指南提供了基本的安装步骤。具体部署到云平台（GCP、AWS 或 Azure）的步骤请参考项目的 README.md 文件。
• 在安装和配置过程中可能会遇到一些问题，这通常是由于环境配置问题或依赖项版本不兼容造成的。请仔细阅读错误信息，并根据需要调整配置或升级依赖项。

以上就是 RAGstack 的详细安装和配置指南。希望对您有所帮助！

rag-stack 🤖 Deploy a private ChatGPT alternative hosted within your VPC. 🔮 Connect it to your organization's knowledge base and use it as a corporate oracle. Supports open-source LLMs like Llama 2, Falcon, and GPT4All. 项目地址: https://gitcode.com/gh_mirrors/ra/rag-stack