Skip to main content
知识库管理

ListKnowledgeBases - 获取知识库列表

通过 OpenAPI 获取 Qoder CN 知识库列表。
适用版本:企业专属版、企业标准版
服务接入点:获取服务接入点,替换 API 请求语法中的 {domain} 。

授权信息

产品资源所需权限
Qoder CN知识库只读

请求语法

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

请求说明

  • 企业标准版
  • 企业专属版
  • 查询组织下的全部知识库
  • 知识库名称模糊查询
  • 根据场景类型查询知识库
curl -X 'GET' \
  'https://openapi-rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

请求头(Headers)

x-yunxiao-token string (必选) 个人访问令牌。您可参考个人访问令牌获取。 示例:pt-0fh30fbG_35af0484。

请求参数

string
path
required
所属组织ID。您可以前往组织管理后台基本信息页面获取organizationId
string
path
知识库名称模糊查询。
string
path
场景类型,支持如下两种场景类型:
  • chat:智能问答场景。
  • complement:行间生成场景,此字段为空则获取全部场景类型的知识库列表。
string
path
排序列,支持如下排序字段:
  • name:知识库名称。
  • sceneType:知识库场景类型。
  • size:知识库大小。
  • fileCount:知识库内文件数目。
  • lastActivityTime:知识库上次活跃时间。
  • gmtCreate:知识库创建时间。
string
path
排序顺序:
  • desc:倒序。
  • asc:正序。
string
path
用户 ID:当传入用户 id 时,只会返回此用户有权限的知识库列表;当此字段为空时,获取全部的知识库列表。
integer
path
default:"1"
当前页。
integer
path
default:"20"
每页数据条数的最大值,取值范围:[1,20]。

返回参数

  • 返回示例
[
    {
        "accessLevel": 10,
        "creator": {
            "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/113iaf62a4481af4cd44ad46d8c3e9b55851/w/100/h/100",
            "displayName": "fangqian_testcloud_com",
            "id": "66a6f60e368d88cff5a513fc",
            "userName": "test"
        },
        "description": "",
        "fileCount": 0,
        "gmtCreate": 1749712990396,
        "gmtModified": 1749712990396,
        "id": "7d9800958eabaa982de687c8",
        "lastActivityTime": 1749712990396,
        "memberCount": 1,
        "name": "test",
        "organizationId": "6826e1d0516a9f85a08cb522",
        "sceneType": "chat",
        "size": "0 B",
        "state": "disable"
    }
]
integer
知识库可见性,目前包含以下两种:
  • 0:代表私有知识库。
  • 10:代表公开知识库。
object
知识库创建者。
string
创建者头像。
string
创建者登录名称。
string
创建者 ID。
string
创建者昵称。
string
描述。
integer
知识库内文件数目。
integer
知识库创建时间。
integer
知识库更新时间。
string
知识库 ID。
integer
知识库上次活跃时间。
integer
知识库成员数目。
string
知识库名称。
string
知识库所属组织 ID。
string
知识库场景类型。目前包含以下两种:
  • chat:智能问答场景。
  • complement:行间生成场景。
string
知识库大小。
string
知识库状态,目前包含以下两种:
  • enable:知识库已激活。
  • disable:知识库未激活。

响应头

参数描述示例值
x-next-page下一页1
x-page当前页1
x-per-page每页大小20
x-prev-page前一页1
x-total总数9
x-total-pages总分页数1

错误码

访问查看 API 相关错误码。
产品概述
操作指南
实践教程
  • 编码使用实践
开发参考