通过 OpenAPI 获取通义灵码知识库列表。
适用版本 | 企业专属版、企业标准版 |
服务接入点
获取服务接入点,替换 API 请求语法中的 {domain}
。
授权信息
产品 | 资源 | 所需权限 |
通义灵码 | 知识库 | 只读 |
请求语法
GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases
请求说明 | 企业标准版查询组织下的全部知识库
知识库名称模糊查询
根据场景类型查询知识库
企业专属版查询组织下的全部知识库
知识库名称模糊查询
根据场景类型查询知识库
|
请求头(Headers) | |
x-yunxiao-token 个人访问令牌。您可参考个人访问令牌获取。 示例:pt-0fh3****0fbG_35af****0484。 | |
请求参数 | |
organizationId 所属组织ID。您可以前往组织管理后台的基本信息页面获取organizationId。 | |
query 知识库名称模糊查询。 | |
sceneType 场景类型,支持如下两种场景类型:
| |
orderBy 排序列,支持如下排序字段:
| |
sort 排序顺序:
| |
userId 用户 ID:当传入用户 id 时,只会返回此用户有权限的知识库列表;当此字段为空时,获取全部的知识库列表。 | |
page 当前页。 | |
perPage 每页数据条数的最大值,取值范围: |
返回参数 | 返回示例
|
accessLevel 知识库可见性,目前包含以下两种:
| |
creator 知识库创建者。 | |
description string 描述。 | |
fileCount 知识库内文件数目。 | |
gmtCreate 知识库创建时间。 | |
gmtModified 知识库更新时间。 | |
id string 知识库 ID。 | |
lastActivityTime 知识库上次活跃时间。 | |
memberCount 知识库成员数目。 | |
name 知识库名称。 | |
organizationId 知识库所属组织 ID。 | |
sceneType 知识库场景类型。目前包含以下两种:
| |
size 知识库大小。 | |
state 知识库状态,目前包含以下两种:
|
响应头
参数 | 描述 | 示例值 |
x-next-page | 下一页 | 1 |
x-page | 当前页 | 1 |
x-per-page | 每页大小 | 20 |
x-prev-page | 前一页 | 1 |
x-total | 总数 | 9 |
x-total-pages | 总分页数 | 1 |
错误码
访问错误码中心查看 API 相关错误码。