RAG API 项目使用教程

RAG API 项目使用教程

1. 项目目录结构及介绍

RAG API 项目是一个基于 FastAPI 的异步、可扩展的文档索引和检索框架，使用 PostgreSQL/pgvector 作为后端存储。以下是项目的目录结构及其介绍：

rag_api/
├── .github/              # GitHub 工作流配置目录
├── .vscode/              # Visual Studio Code 配置目录
├── app/                  # 应用程序代码目录
│   ├── __init__.py
│   ├── main.py           # 主应用程序文件
│   ├── tests/            # 测试模块
│   └── utils/            # 实用工具模块
├── docker/               # Docker 配置文件
├── .dockerignore         # Docker 忽略文件
├── .gitignore            # Git 忽略文件
├── Dockerfile            # Docker 构建文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── api-compose.yaml      # Docker Compose API 服务配置文件
├── db-compose.yaml       # Docker Compose 数据库服务配置文件
└── requirements.txt      # 项目依赖文件

2. 项目的启动文件介绍

项目的主启动文件是 app/main.py。以下是 main.py 文件的主要内容：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"message": "Welcome to the RAG API"}

这个文件创建了一个 FastAPI 实例，并定义了一个简单的路由，用于响应根 URL 的 GET 请求。

要启动项目，可以使用以下命令：

uvicorn main:app

这将启动 FastAPI 服务器，默认监听 0.0.0.0:8000 地址。

3. 项目的配置文件介绍

项目的配置主要通过环境变量进行，这些环境变量可以在 .env 文件中设置，或者直接作为系统环境变量。以下是一些重要的环境变量及其作用：

• RAG_OPENAI_API_KEY: OpenAI API 嵌入的 API 密钥。
• VECTOR_DB_TYPE: 选择向量数据库类型，默认为 pgvector。
• POSTGRES_DB: PostgreSQL 数据库名称。
• POSTGRES_USER: PostgreSQL 数据库用户名。
• POSTGRES_PASSWORD: PostgreSQL 数据库密码。
• DB_HOST: PostgreSQL 数据库服务器的主机名或 IP 地址。
• DB_PORT: PostgreSQL 数据库服务器的端口号。
• RAG_HOST: API 服务器运行的 hostname 或 IP 地址。
• RAG_PORT: API 服务器运行的端口号。

确保在运行应用程序之前设置这些环境变量。可以通过以下命令来加载 .env 文件：

python -m dotenv

然后，可以正常启动应用程序。

以上就是 RAG API 项目的目录结构、启动文件和配置文件的介绍。按照以上步骤，您可以顺利地搭建并运行该项目。