获取文档列表 - 句子 Insight

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

knowledgeBaseId

string

必需

知识库id，可以通过知识库相关接口获取到

示例值:

page

string

当前页码

必需

示例值:

1

pageSize

string

每页数据大小

必需

示例值:

10

keyword

string

可选

搜索关键词，可不传，不传则获取全量列表

示例值:

test

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://insight.juzibot.com/openapi/knowledge-base/doc/list?knowledgeBaseId={{knowledgeBaseId}}&page=1&pageSize=10&keyword=test'

返回响应

🟢200成功

application/json

Body

code

integer

必需

data

array [object {6}]

必需

docId

integer

文档ID

可选

name

string

文档名

可选

文档的名字

extension

string

后缀名

可选

后缀名，如果是通过api或者界面手动创建，则这个值为manual，仅这种后缀名的文档支持通过接口添加更新删除片段数据

createAt

integer

创建时间

可选

创建时间，毫秒级时间戳

createBy

string

创建者

可选

当文档是通过api创建的时候，这个值为api

status

string

状态

可选

枚举，ready和processing，如果是processing，则说明这个文档正在进行向量计算

page

object

必需

total

integer

必需

page

integer

必需

示例

{
  "code": 0,
  "data": [
    {
      "docId": 0,
      "name": "string",
      "extension": "string",
      "createAt": 0,
      "createBy": "string",
      "status": "string"
    }
  ],
  "page": {
    "total": 0,
    "page": 0
  }
}