LSPlatform
  • 【在线调试-使用说明】
  • 大模型接口
    • 标准API
    • 提示工程模板
    • 知识库
      • 创建知识库POST
      • 添加文档POST
      • 文档分片预览POST
      • 知识库问答对话POST
      • 获取知识库列表GET
      • 获取文档列表GET
      • 获取文档详情GET
      • 删除文档DELETE
      • 删除知识库DELETE
  • TTS合成
Powered by Apifox

    获取文档列表

    开发中
    GET/v1/knowledge-bases/{{index_id}}/documents

    请求参数

    Query 参数
    page
    integer 
    页码
    可选
    示例值:
    1
    size
    integer 
    分页数量
    可选
    示例值:
    20
    Header 参数
    Content-Type
    string 
    可选
    示例值:
    application/json
    Authorization
    string 
    可选
    示例值:
    Bearer {{token}}

    示例代码

    返回响应

    成功(200)
    HTTP 状态码: 200
    内容格式: JSON
    数据结构
    data
    array [object {12}] 
    必需
    user_id
    string 
    可选
    index_id
    string 
    可选
    doc_name
    string 
    可选
    doc_id
    string 
    可选
    doc_url
    string 
    可选
    text_splitter
    object {2} 
    可选
    content_length
    integer 
    可选
    status
    integer 
    可选
    created_at
    string 
    可选
    executed_at
    string 
    可选
    executed_id
    string 
    可选
    executed_note
    string 
    可选
    page
    integer 
    必需
    size
    integer 
    必需
    total
    string 
    必需
    message
    string 
    必需
    示例
    {
      "data": [
        {
          "user_id": "16",
          "index_id": "xxx",
          "doc_name": "智能说明书.txt",
          "doc_id": "xxx",
          "doc_url": "https://cdn.iflyos.cn/xxx/智能说明书.txt",
          "text_splitter": {
            "method": "token",
            "options": {
              "chunk_size": 256,
              "chunk_overlap": 20
            }
          },
          "content_length": 9880,
          "status": 1,
          "created_at": "2023-08-16T06:49:55.820Z",
          "executed_at": "2023-08-16T06:49:55.820Z",
          "executed_id": "xxx",
          "executed_note": ""
        }
      ],
      "page": 1,
      "size": 20,
      "total": "1",
      "message": "成功"
    }
    修改时间 3 个月前
    上一页
    GET获取知识库列表
    下一页
    GET获取文档详情