ListKnowledgeBases - 获取知识库列表

更新时间:

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

适用版本

企业标准版、企业专属版

服务接入点与授权信息

请求语法

GET  http://<domain>/oapi/v1/lingma/organizations/<organizationId>/knowledgeBases

请求方式

GET

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

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

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

99d1****71d4

query

string

query

知识库名称模糊查询。

sceneType

string

query

场景类型,支持如下两种场景类型:answer,complement。answer代表智能问答场景,complement代表行间生成场景,此字段为空则获取全部场景类型的知识库列表。

orderBy

string

query

排序列,支持如下排序字段:name,scene_type,size,file_count,last_activity_time,gmt_created。

sort

string

query

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

page

integer

query

第几页。

perPage

integer

query

每页条数。

请求示例

curl -X 'GET' \
  'http://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/99d1****71d4/knowledgeBases' \
  -H 'Content-Type: application/json'
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

id

string

知识库 ID。

3a41****3eca

name

string

知识库名称。

企业知识库

description

string

描述。

this is a test

size

string

知识库大小。

5 B

fileCount

integer

知识库内文件数目。

1

sceneType

string

知识库场景类型。目前包含以下两种:answer,complement。answer代表智能问答场景,complement代表行间生成场景。

answer

accessLevel

integer

知识库可见性,目前包含以下两种:0,10。0代表私有知识库,10代表公开知识库。

0

state

string

知识库状态,目前包含以下两种:enable,disable。enable代表知识库已激活,disable代表知识库未激活。

disable

creator

object

知识库创建者。

id

string

创建者 ID。

d402****9ae6

displayName

string

创建者登录名称。

lingma

userName

string

创建者昵称。

lingma

avatarUrl

string

创建者头像。

/objects/ajax/default/avatars/bGluZ21h

organizationId

string

知识库所属组织 ID。

9a2b****5ef1

gmtCreate

integer

知识库创建时间。

1722147833968

gmtModified

integer

知识库更新时间

1722149054399

lastActivityTime

integer

知识库上次活跃时间。

1722149052564

memberCount

integer

知识库成员数目。

3

返回示例

[
  {
        "accessLevel": 0,
        "creator": {
            "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h",
            "displayName": "lingma",
            "id": "d402****9ae6",
            "userName": "lingma"
        },
        "description": "this is a test",
        "fileCount": 1,
        "gmtCreate": 1722147833968,
        "gmtModified": 1722149054399,
        "id": "3a41****3eca",
        "lastActivityTime": 1722149052564,
        "memberCount": 3,
        "name": "企业知识库",
        "organizationId": "9a2b****5ef1",
        "sceneType": "answer",
        "size": "5 B",
        "state": "disable"
    },
    {
        "accessLevel": 0,
        "creator": {
            "avatarUrl": "/objects/ajax/default/avatars/bGluZ21h",
            "displayName": "lingma",
            "id": "d402****9ae6",
            "userName": "lingma"
        },
        "description": "",
        "fileCount": 0,
        "gmtCreate": 1722147486046,
        "gmtModified": 1722147486046,
        "id": "2660****27f5",
        "lastActivityTime": 1722147486046,
        "memberCount": 1,
        "name": "测试专用知识库",
        "organizationId": "9a2b****5ef1",
        "sceneType": "answer",
        "size": "0 B",
        "state": "disable"
    }
]

响应头

参数

描述

示例值

x-next-page

下一页。

1

x-per-page

每页数据条数。

100

x-prev-page

上一页。

1

x-total

总数据量。

2

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: 2   //总条数
 x-total-pages: 1  //总页数

错误码

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