ListKnowledgeBases - 获取知识库列表

获取知识库列表。

服务接入点与授权信息

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

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

请求语法

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

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	所属企业 ID。
query	string	query	否	知识库名称模糊查询。
sceneType	string	query	否	场景类型，支持如下两种场景类型：chat，completion。chat 代表智能问答场景，completion 代表行间生成场景，此字段为空则获取全部场景类型的知识库列表。
orderBy	string	query	否	排序列，支持如下排序字段：name，scene_type，size，file_count，last_activity_time，gmt_created。
sort	string	query	否	排序顺序，支持倒序和正序：desc，asc。
userId	string	query	否	用户 ID：当传入用户 id 时，只会返回此用户有权限的知识库列表；当此字段为空时，获取全部的知识库列表。
page	integer	query	否	当前页，默认1。
perPage	integer	query	否	每页数据条数，默认20。

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases?query={query}&sceneType={sceneType}&orderBy={orderBy}&sort={sort}&userId={userId}&page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
accessLevel	integer	知识库可见性，目前包含以下两种：0，10。0代表私有知识库，10代表公开知识库。
creator	object	知识库创建者。
avatarUrl	string	创建者头像。
displayName	string	创建者登录名。
id	string	创建者 id。
userName	string	创建者昵称。
description	string	知识库描述。
fileCount	integer	知识库内文件数目。
gmtCreate	integer	知识库创建时间。
gmtModified	integer	知识库更新时间。
id	string	知识库唯一 id。
lastActivityTime	integer	知识库上次活跃时间。
memberCount	integer	知识库成员数目。
name	string	知识库名称。
organizationId	string	知识库所属组织 id。
sceneType	string	知识库场景类型，目前包含以下两种：chat，completion。chat 代表智能问答场景，completion 代表行间生成场景。
size	string	知识库大小。
state	string	知识库状态，目前包含以下两种：enable，disable。enable 代表知识库已激活，disable 代表知识库未激活。

返回示例

[
    {
        "accessLevel": 0,
        "creator": {
            "avatarUrl": "",
            "displayName": "",
            "id": "",
            "userName": ""
        },
        "description": "",
        "fileCount": 0,
        "gmtCreate": 0,
        "gmtModified": 0,
        "id": "",
        "lastActivityTime": 0,
        "memberCount": 0,
        "name": "",
        "organizationId": "",
        "sceneType": "",
        "size": "",
        "state": ""
    }
]

响应头

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

错误码

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

results matching ""

No results matching ""