ListKbFiles - 获取知识库文件列表

获取知识库文件列表。

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。

产品	资源	所需权限
通义灵码	知识库文件	只读

请求语法

GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/files

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	所属企业 ID。
kbId	string	path	是	知识库 id。
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/{organizationId}/knowledgeBases/{kbId}/files?query={query}&orderBy={orderBy}&sort={sort}&page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
fileId	string	文件唯一 id。
filePath	string	文件路径。
fileSize	string	文件大小。
fileState	string	文件状态。
filename	string	文件名称。
gmtAdded	integer	文件添加时间。
gmtCreated	integer	文件创建时间。
gmtModified	integer	文件修改时间。
kbId	string	知识库唯一 id。
organizationId	string	文件所属组织 id。
uploadUser	object	文件添加者。
avatarUrl	string	添加者头像。
displayName	string	添加者登录名。
id	string	添加者 id。
userName	string	添加者昵称。

返回示例

[
    {
        "fileId": "",
        "filePath": "",
        "fileSize": "",
        "fileState": "",
        "filename": "",
        "gmtAdded": 0,
        "gmtCreated": 0,
        "gmtModified": 0,
        "kbId": "",
        "organizationId": "",
        "uploadUser": {
            "avatarUrl": "",
            "displayName": "",
            "id": "",
            "userName": ""
        }
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。
x-page	当前页。
x-per-page	每页数据条数。
x-prev-page	上一页。
x-total	总数据量。
x-total-pages	总分页数。

错误码

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

results matching ""

No results matching ""