关注公众号
原创
✅派聪明 RAG 系统的接口文档

一、用户管理模块

01、用户注册接口

  • URL: /api/v1/users/register
  • Method: POST
  • Request Body:
{
  "username": "string",   // 用户名，唯一
  "password": "string"    // 密码（明文传输，后端加密存储）
}
  • Response:
{
  "code": 200,// 成功
  "message": "User registered successfully"
}

{
  "code": 400, // 失败
  "message": "Username already exists"
}

02、用户登录接口

  • URL: /api/v1/users/login
  • Method: POST
  • Request Body:
{
  "username": "string",
  "password": "string"
}
  • Response:
{
  "code": 200,// 成功
  "message": "Login successful",
  "data": {
    "token": "JWT_TOKEN_STRING"
  }
}

{
  "code": 401, // 失败
  "message": "Invalid username or password"
}

03、获取用户信息接口

  • URL: /api/v1/users/me
  • Method: GET
  • Headers:
    • Authorization:...
以下内容需要加入二哥编程星球解锁，即刻绑定星球编号解锁🔐
已加入星球，可直接知识星球授权登录
二哥编程星球目前包含：
企业级Agent工作流编排项目PaiFlow
Vibe Coding版本的PaiAgent
派聪明RAG AI知识库Java版本+Go版本
微服务 PmHub、技术派、MYDB
求职派JobClaw（OpenClaw/Hermes架构
PaiCLI（类似Claude Code的Agent
派简历（代码已完成）
等实战项目。

1. 微信扫右侧的优惠券加入知识星球

2. 解锁星球的实战项目教程和源码： 项目源码+教程获取

二哥的星球

13人已点赞

杠精派
派聪明
0/512

热门评论

清清 2026年03月15日 10:00
@派聪明 文档删除和文件删除有什么区别
点赞
回复1 取消回复
派聪明 2026年03月15日 10:01
根据提供的参考资料，**文档删除**和**文件删除**在功能定位和实现上存在本质区别： ### 1. **文件删除（物理删除）** - **接口位置**：文件上传与处理模块 - URL: `/api/v1/documents/{file_md5}` - Method: `DELETE` - **功能**： 彻底删除存储系统（如MinIO）中的原始文件，释放物理存储空间。 - **适用场景**： 当用户需要从服务器**永久移除文件**时使用。 - **响应示例**： ```json { "status": "success", "message": "文档删除成功" } { "status": "error", "message": "文档不存在" } ``` ### 2. **文档删除（逻辑删除）** - **接口位置**：知识库检索模块 - URL: `/api/documents/{file_md5}` - Method: `DELETE` - **功能**： 仅删除知识库中的**索引记录**，文件本身仍保留在存储系统中，但无法通过检索接口（如`/api/search/hybrid`）被查询到。 - **适用场景**： 当用户需要**移除文件在知识库中的可见性**（如敏感内容处理），但保留原始文件时使用。 - **响应示例**： ```json { "status": "success", "message": "文档删除成功" } { "status": "error", "message": "没有权限删除此文档" } ``` ### 核心区别总结 | **维度** | **文件删除** | **文档删除** | |----------------|----------------------------------|----------------------------------| | **操作对象** | 物理存储的文件（如MinIO） | 知识库索引记录 | | **影响范围** | 彻底移除文件，释放存储空间 | 仅移除检索索引，文件仍存在 | | **接口路径** | `/api/v1/documents/{file_md5}` | `/api/documents/{file_md5}` | | **模块归属** | 文件上传与处理模块 | 知识库检索模块 | ### 使用建议 - 若需**永久删除文件**（如清理存储），使用文件删除接口。 - 若需**隐藏文件在知识库中的可见性**（如权限管理），使用文档删除接口。
1
回复 取消回复

2 条评论

清清 2026年03月15日 10:00
@派聪明 文档删除和文件删除有什么区别
点赞
回复1 取消回复
派聪明 2026年03月15日 10:01
根据提供的参考资料，**文档删除**和**文件删除**在功能定位和实现上存在本质区别： ### 1. **文件删除（物理删除）** - **接口位置**：文件上传与处理模块 - URL: `/api/v1/documents/{file_md5}` - Method: `DELETE` - **功能**： 彻底删除存储系统（如MinIO）中的原始文件，释放物理存储空间。 - **适用场景**： 当用户需要从服务器**永久移除文件**时使用。 - **响应示例**： ```json { "status": "success", "message": "文档删除成功" } { "status": "error", "message": "文档不存在" } ``` ### 2. **文档删除（逻辑删除）** - **接口位置**：知识库检索模块 - URL: `/api/documents/{file_md5}` - Method: `DELETE` - **功能**： 仅删除知识库中的**索引记录**，文件本身仍保留在存储系统中，但无法通过检索接口（如`/api/search/hybrid`）被查询到。 - **适用场景**： 当用户需要**移除文件在知识库中的可见性**（如敏感内容处理），但保留原始文件时使用。 - **响应示例**： ```json { "status": "success", "message": "文档删除成功" } { "status": "error", "message": "没有权限删除此文档" } ``` ### 核心区别总结 | **维度** | **文件删除** | **文档删除** | |----------------|----------------------------------|----------------------------------| | **操作对象** | 物理存储的文件（如MinIO） | 知识库索引记录 | | **影响范围** | 彻底移除文件，释放存储空间 | 仅移除检索索引，文件仍存在 | | **接口路径** | `/api/v1/documents/{file_md5}` | `/api/documents/{file_md5}` | | **模块归属** | 文件上传与处理模块 | 知识库检索模块 | ### 使用建议 - 若需**永久删除文件**（如清理存储），使用文件删除接口。 - 若需**隐藏文件在知识库中的可见性**（如权限管理），使用文档删除接口。
1
回复 取消回复

目录