文档

ListKbFiles - 获取知识库文件列表

更新时间:
一键部署

通过 OpenAPI 获取通义灵码知识库文件列表。

适用版本

企业标准版、企业专属版

服务接入点与授权信息

请求语法

GET  https://<domain>/oapi/v1/lingma/organizations/<organizationId>/knowledgeBases/<kbId>/files?query=<query>

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

99d1****71d4

kbId

string

path

知识库 ID。

3a41****3eca

query

string

query

文件名称模糊查询。

orderBy

string

query

排序列,支持如下排序字段:gmt_added,kb_id,file_state。

sort

string

query

排序顺序,支持倒序和正序:desc,asc。

page

integer

query

当前页,默认1。

perPage

integer

query

每页数据条数,默认20。

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/99d1****71d4/knowledgeBases/3a41****3eca/files?query=history' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

gmtCreated

integer

创建时间。

1722149052460

gmtModified

integer

修改时间。

1722149055731

gmtAdded

integer

添加时间。

1722149052515

fileId

string

文件 ID。

30d4****aca4

filename

string

文件名称。

history.txt

fileSize

string

文件大小。

5 B

filePath

string

文件路径。

lingma/rag_kb/9a2b****5ef1/3a41****3eca/30d4****aca4/history.txt

fileState

string

文件状态。

PROCESSED

kdId

string

知识库 ID。

3a41****3eca

organizationId

string

所属组织 ID。

9a2****5ef1

uploadUser

object

文件添加者。

id

string

添加者 ID。

d402****9ae6

displayName

string

添加者登录名。

lingma

userName

string

添加者昵称。

lingma

avatarUrl

string

添加者头像。

/objects/ajax/default/avatars/bGluZ21h

返回示例

[
    {
        "fileId": "30d4****aca4",
        "filePath": "lingma/rag_kb/9a2b****5ef1/3a41****3eca/30d4****aca4/history.txt",
        "fileSize": "5 B",
        "fileState": "PROCESSED",
        "filename": "history.txt",
        "gmtAdded": 1722149052515,
        "gmtCreated": 1722149052460,
        "gmtModified": 1722149055731,
        "kbId": "3a41****3eca",
        "organizationId": "9a2b****5ef1",
        "uploadUser": {
            "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h",
            "displayName": "lingma",
            "id": "d402****9ae6",
            "userName": "lingma"
        }
    }
]

响应头

参数

描述

示例值

x-next-page

下一页。

1

x-per-page

每页数据条数。

100

x-prev-page

上一页。

1

x-total

总数据量。

1

x-total-pages

总分页数。

1

响应头示例

 connection: keep-alive 
 content-length: 481 
 content-type: application/json; charset=UTF-8 
 date: Thu,04 Jul 2024 13:44:21 GMT 
 x-next-page: 1 
 x-per-page: 100  //每页大小 
 x-prev-page: 1 
 x-total: 1   //总条数
 x-total-pages: 1  //总页数

错误码

访问错误码中心查看 API 相关错误码。