Rag API项目安装与配置指南

Rag API项目安装与配置指南

rag_api ID-based RAG FastAPI: Integration with Langchain and PostgreSQL/pgvector 项目地址: https://gitcode.com/gh_mirrors/ra/rag_api

1. 项目基础介绍

Rag API是一个开源项目，它集成了Langchain与FastAPI，提供了一个异步、可扩展的框架，用于文档索引和检索，使用PostgreSQL/pgvector作为后端存储。该项目主要适用于需要基于ID进行文档管理的场景，如LibreChat等。

项目主要使用的编程语言是Python。

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

• FastAPI: 一个用于构建API的现代、快速（高性能）的Web框架，使用Python 3.6及以上的异步特性。
• Langchain: 一个用于自然语言处理（NLP）的框架，提供向量存储和检索等功能。
• PostgreSQL/pgvector: PostgreSQL的一个扩展，用于高效存储和检索高维向量。
• Docker: 用于容器化应用程序，简化部署和运行环境。

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

在开始安装之前，请确保您的系统满足了以下要求：

• Python 3.6或更高版本
• Docker和Docker Compose
• PostgreSQL数据库

详细安装步骤

步骤1：克隆项目仓库

首先，您需要在您的计算机上克隆该项目仓库：

git clone https://github.com/danny-avila/rag_api.git
cd rag_api

步骤2：设置环境变量

在项目根目录下创建一个.env文件，并设置以下环境变量：

# PostgreSQL数据库配置
POSTGRES_DB=your_database_name
POSTGRES_USER=your_database_user
POSTGRES_PASSWORD=your_database_password
DB_HOST=your_database_host
DB_PORT=your_database_port

# API服务器配置
RAG_HOST=0.0.0.0
RAG_PORT=8000
JWT_SECRET=your_jwt_secret

# 文档处理配置
CHUNK_SIZE=1500
CHUNK_OVERLAP=100
RAG_UPLOAD_DIR=./uploads/

# 其他配置
EMBEDDINGS_PROVIDER=openai
EMBEDDINGS_MODEL=text-embedding-3-small

请根据实际情况替换上述变量中的值。

步骤3：构建和运行Docker容器

使用以下命令构建并启动Docker容器：

docker-compose up

这个命令会启动PostgreSQL数据库和Rag API服务。

步骤4：安装Python依赖

在项目根目录下运行以下命令安装Python依赖：

pip install -r requirements.txt

步骤5：启动API服务

安装完依赖后，运行以下命令启动API服务：

uvicorn main:app --host 0.0.0.0 --port 8000

现在，Rag API服务应该已经在您的本地环境中运行了。

以上就是Rag API项目的详细安装和配置指南。按照上述步骤操作，您应该能够成功部署该项目。

rag_api ID-based RAG FastAPI: Integration with Langchain and PostgreSQL/pgvector 项目地址: https://gitcode.com/gh_mirrors/ra/rag_api