RagApp_API
  1. 文档管理 /documents
RagApp_API
  • 概述
  • 息壤大模型名称列表
  • 数据库连接信息
  • MinerU的APIToken仅14天
  • 用户(弃用)
    • 注册
      POST
    • 登录
      POST
    • 验证邮箱
      GET
    • 重发验证邮件
      POST
    • 获取当前用户信息
      GET
    • 测试用户登录状态
      GET
  • 开发测试接口
    • 简单对话
      POST
    • 简单对话+上下文
      POST
    • 网络延迟测试
      POST
  • RAG 聊天
    • [说明] 关于User-ID
    • 文档管理 /documents
      • [说明] 文件上传指南
      • [说明] 新增is_selected
      • 获取预签名上传 URL
        POST
      • 确认文件上传
        POST
      • (传统)上传文档
        POST
      • 查询文档处理状态
        GET
      • 重新触发索引
        POST
      • 获取文档列表
        GET
      • 获取文档详情
        GET
      • 更新文档选中状态
        PATCH
      • 删除文档
        DELETE
    • 对话 /rag
      • [说明] 完整使用流程示例
      • [说明] /rag/chat的响应
      • (传统RAG) 多轮对话
      • (dev|LightRAG) 对话
  • 数据模型
    • DocumentResponse
  1. 文档管理 /documents

[说明] 新增is_selected

Generated by Claude Opus 4.5😂
一、新增 API
PATCH /documents/selection
更新文档选中状态
请求:
// Headers
X-User-ID: number
Content-Type: application/json
  // Body
  {
    document_id: number,// 文档 ID
    is_selected: boolean  // 是否选中
  }
响应: DocumentResponse(下文略)
interface DocumentResponse {
  document_id: number
  filename: string
  file_type: string
  file_size: number
  status: string
  chunk_count: number | null
  error_message: string | null
  is_selected: boolean          // 新增
  created_at: string
  updated_at: string
}

二、响应结构变更
以下 API 的响应都是DocumentResponse,都新增 is_selected 字段:
GET /documents
GET /documents/{document_id}
PATCH /documents/selection
不包含documents/{document_id}/status,因为刚导入的文档is_selected总是false。这个接口仅用来获取文档处理状态,我认为最好一个接口只干一件事

三、行为变更
POST /rag/chat
请求结构不变,但 document_ids 逻辑变更:
场景行为
传入 document_ids使用指定的文档
不传 document_ids 或传 null/[]自动使用用户所有 is_selected=true 且 status=completed 的文档
修改于 2025-12-08 12:43:08
上一页
[说明] 文件上传指南
下一页
获取预签名上传 URL
Built with