LSPlatform
  1. 知识库
LSPlatform
  • 【在线调试-使用说明】
  • 大模型接口
    • 标准API
      • 模型对话调用(Completions)
      • 向量计算调用(Embedding)
      • 决策调用(Makes)
    • 提示工程模板
      • Prompt渲染
    • 知识库
      • 创建知识库
        POST
      • 添加文档
        POST
      • 文档分片预览
        POST
      • 知识库问答对话
        POST
      • 获取知识库列表
        GET
      • 获取文档列表
        GET
      • 获取文档详情
        GET
      • 删除文档
        DELETE
      • 删除知识库
        DELETE
      • 知识库文本查询
        GET
      • 知识点溯源查询
        POST
  1. 知识库

获取文档列表

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

请求参数

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

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/knowledge-bases/{{index_id}}/documents?page	=1&size	=20' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

返回响应

🟢200成功
application/json
Body
data
array [object {12}] 
必需
user_id
string 
可选
index_id
string 
可选
doc_name
string 
可选
doc_id
string 
可选
doc_url
string 
可选
text_splitter
object 
可选
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": "成功"
}
修改于 2023-09-07 09:56:04
上一页
获取知识库列表
下一页
获取文档详情
Built with