# 查询知识库列表（Token认证） #### 功能介绍 该接口用于查询知识库列表，包括名称、描述、状态、检索方式等信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-appstage/appstage_07_0008.html)。 #### URI GET https://aiae.appstage.myhuaweicloud.com/v1/unidata/knowledge-bases 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 知识库名称。 **约束限制：** 支持中英文、数字、下划线（_），1-50个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | scope | 否 | String | **参数解释：** 知识库范围类型。 **约束限制：** 不涉及。 **取值范围：** 枚举值： - PRIVATE：用户创建知识库。 - PUBLIC：平台预置知识库。 - COMMUNITY：社区内公开，用户指定公开的维度，如按照部门公开。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 偏移量。 **约束限制：** 不涉及。 **取值范围：** 正整数。 **默认取值：** 0。 | | limit | 否 | Integer | **参数解释：** 分页每页的条目数量。 **约束限制：** 不涉及。 **取值范围：** 1-1000的整数。 **默认取值：** 10。 | | data_set_status | 否 | Array of strings | **参数解释：** 数据集记录状态。 **约束限制：** 不涉及。 **取值范围：** 枚举值： - CREATING：创建中。 - DISABLE：状态异常。 - WAITING_SCHEDULE：等待执行。 - SCHEDULING：执行中。 - NORMAL：正常。 - SCHEDULE_FAILED：执行失败。 - FREEZE冻结：CBC触发。 **默认取值：** 不涉及。 | | retrieval_status | 否 | String | **参数解释：** 知识库检索状态。 **约束限制：** 不涉及。 **取值范围：** 枚举值： - ENABLE：已启用。 - DISABLE：已停用 。 **默认取值：** 不涉及。 | | rag_type | 否 | String | **参数解释：** RAG类型。 **约束限制：** 不涉及。 **取值范围：** 枚举值： - VECTOR_RAG：向量RAG。 - GRAPH_RAG：图谱RAG。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释：** 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [PageInfoKnowledgeBaseT] object | 知识库列表信息。 | 表4PageInfoKnowledgeBaseT | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Long | **参数解释：** 知识库总数。 **取值范围：** 不涉及。 | | list | Array of [KnowledgeBaseT] objects | **参数解释：** 知识库信息列表。 **取值范围：** 不涉及。 | | pageNum | Integer | **参数解释：** 当前页。 **取值范围：** 不涉及。 | | pageSize | Integer | **参数解释：** 每页的数量。 **取值范围：** 不涉及。 | | size | Integer | **参数解释：** 当前页的数量。 **取值范围：** 不涉及。 | | startRow | Long | **参数解释：** 当前页面第一个元素在数据库中的行号。 **取值范围：** 不涉及。 | | endRow | Long | **参数解释：** 当前页面最后一个元素在数据库中的行号。 **取值范围：** 不涉及。 | | pages | Integer | **参数解释：** 总页数。 **取值范围：** 不涉及。 | | prePage | Integer | **参数解释：** 前一页。 **取值范围：** 不涉及。 | | nextPage | Integer | **参数解释：** 后一页。 **取值范围：** 不涉及。 | | isFirstPage | Boolean | **参数解释：** 是否为第一页。 **取值范围：** 不涉及。 | | isLastPage | Boolean | **参数解释：** 是否为最后一页。 **取值范围：** 不涉及。 | | hasPreviousPage | Boolean | **参数解释：** 是否有前一页。 **取值范围：** 不涉及。 | | hasNextPage | Boolean | **参数解释：** 是否有下一页。 **取值范围：** 不涉及。 | | navigatePages | Integer | **参数解释：** 导航页总数。 **取值范围：** 不涉及。 | | navigatepageNums | Array of integers | **参数解释：** 所有导航页号。 **取值范围：** 不涉及。 | | navigateFirstPage | Integer | **参数解释：** 导航页上一页。 **取值范围：** 不涉及。 | | navigateLastPage | Integer | **参数解释：** 导航页下一页。 **取值范围：** 不涉及。 | 表5KnowledgeBaseT | 参数 | 参数类型 | 描述 | |:---|:---|:---| | last_updated_date | String | **参数解释：** 最近更新时间。 **取值范围：** 格式为：yyyy-mm-dd hh:mm:ss，如2024-11-21 11:36:55。 | | last_updated_by_user_id | String | **参数解释：** 最近一次更新人ID。 **取值范围：** 不涉及。 | | last_updated_by_user_name | String | **参数解释：** 最近一次更新人名称。 **取值范围：** 不涉及。 | | last_updated_by_nick_name | String | **参数解释：** 最新一次更新人名称。 **取值范围：** 不涉及。 | | tenant_id | String | **参数解释：** 租户ID。 **取值范围：** 不涉及。 | | tenant_name | String | **参数解释：** 租户名称。 **取值范围：** 不涉及。 | | dept_code | String | **参数解释：** 部门编码。 **取值范围：** 不涉及。 | | created_date | String | **参数解释：** 创建日期。 **取值范围：** 不涉及。 | | created_by_user_id | String | **参数解释：** 创建人ID。 **取值范围：** 不涉及。 | | created_by_user_name | String | **参数解释：** 创建人名称。 **取值范围：** 不涉及。 | | created_by_nick_name | String | **参数解释：** 创建人名称。 **取值范围：** 不涉及。 | | deleted | Boolean | **参数解释：** 是否删除。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 知识库ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 知识库名称。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 知识库描述。 **取值范围：** 不涉及。 | | rag_type | String | **参数解释：** 知识库RAG类型。 **取值范围：** 可以为空，为空则使用默认值。 枚举值： - VECTOR_RAG：向量RAG，是一种结合了向量化和大语言模型的RAG技术。 - GRAPH_RAG：知识图谱RAG，是一种结合了知识图谱和大语言模型的RAG技术。 | | retrieval_config | [RetrievalConfig] object | **参数解释：** 数据库检索配置。 **取值范围：** 不涉及。 | | scope | String | **参数解释：** 知识库范围类型。 **取值范围：** 枚举值： - PRIVATE：用户创建知识库。 - PUBLIC：平台预置知识库。 - COMMUNITY：社区内公开，用户指定公开的维度，如按照部门公开。 | | embed_database | String | **参数解释：** 向量数据库名称。 **取值范围：** 不涉及。 | | db_invoke_api | String | **参数解释：** 知识库调用API。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 知识库状态。 **取值范围：** 枚举值： - WAITING_SCHEDULE：等待执行。 - SCHEDULING：执行中。 - NORMAL：正常。 - SCHEDULE_FAILED：执行失败。 - FREEZE冻结：CBC触发。 | | retrieval_status | String | **参数解释：** 知识库检索状态。 **取值范围：** 不涉及。 | | schedule_type | String | **参数解释：** 调度类型。 **取值范围：** 不涉及。 | | schedule_config_id | String | **参数解释：** 周期性调度配置ID。 **取值范围：** 不涉及。 | | schedule_status | String | **参数解释：** 周期性调度状态。 **取值范围：** 生效、暂停。 | | llama_index | Boolean | **参数解释：** 标记是否由LlamaIndex生成。 **取值范围：** 不涉及。 | 表6RetrievalConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | retrieval_modes | Array of strings | **参数解释：** 检索模式，用于设置知识库检索召回时的检索方式。 **约束限制：** 不涉及。 **取值范围：** 可传多个值。枚举值： - SEMANTIC_RETRIEVAL：使用向量进行文本语义查询，即调用向量数据库根据向量的相似性检索。 - FULL_TEXT_RETRIEVAL：使用关键字进行文本匹配，适合查找一些关键词和主题语的数据。 **默认取值：** 不涉及。 | | retrieval_hybrid_mode | String | **参数解释：** 此参数用于指定混合检索的模式。 "retrieval_modes"选择SEMANTIC_RETRIEVAL和FULL_TEXT_RETRIEVAL时，为混合检索。 **约束限制：** "retrieval_modes"选择SEMANTIC_RETRIEVAL和FULL_TEXT_RETRIEVAL。 **取值范围：** 支持RRF，枚举值：RRF。 **默认取值：** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 异常错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 异常错误信息。 **取值范围：** 不涉及。 | #### 请求示例 无 #### 响应示例 **状态码：200** 查询知识库列表响应参数。 ``` { "data" : { "total" : 1, "list" : [ { "last_updated_date" : "2025-07-25T09:03:50.000+00:00", "last_updated_by_user_id" : "f0e1c67f3ee445cb938fb86bfbdf2255", "last_updated_by_user_name" : "developer", "last_updated_by_nick_name" : "developer", "tenant_id" : "1015192394", "tenant_name" : "developer", "dept_code" : "1015192394", "created_date" : "2025-07-24T09:23:17.000+00:00", "created_by_user_id" : "f0e1c67f3ee445cb938fb86bfbdf2255", "created_by_user_name" : "developer", "created_by_nick_name" : "developer", "deleted" : false, "id" : "febb587f-20fb-4ec2-8431-f5b8858fecde", "name" : "测试_0724_003", "description" : "0724第一次修改", "rag_type" : "VECTOR_RAG", "retrieval_config" : { "retrieval_modes" : [ "SEMANTIC_RETRIEVAL" ] }, "scope" : "PRIVATE", "dimension" : null, "community_auth_codes" : [ ], "embed_database" : "CLICK_HOUSE", "db_invoke_api" : "EMBEDDING_API", "status" : "NORMAL", "retrieval_status" : "DISABLE", "schedule_type" : "ONCE", "schedule_config_id" : null, "schedule_status" : null, "llama_index" : true, "type" : "KB1" } ], "pageNum" : 1, "pageSize" : 10, "size" : 2, "startRow" : 0, "endRow" : 1, "pages" : 1, "prePage" : 0, "nextPage" : 0, "isFirstPage" : true, "isLastPage" : true, "hasPreviousPage" : false, "hasNextPage" : false, "navigatePages" : 8, "navigatepageNums" : [ 1 ], "navigateFirstPage" : 1, "navigateLastPage" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询知识库列表响应参数。 | | 400 | 错误请求。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-appstage/ErrorCode.html)。