# 查询知识库详情（Token认证） #### 功能介绍 该接口用于查询知识库详情信息，包括名称、描述、状态、检索方式、数据集信息等。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-appstage/appstage_07_0008.html)。 #### URI GET https://aiae.appstage.myhuaweicloud.com/v1/unidata/knowledge-bases/{knowledge_base_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | knowledge_base_id | 是 | String | **参数解释：** 知识库ID，获取方式： - 从[创建知识库](https://support.huaweicloud.com/api-appstage/CreateKnowledgeBase.html)接口返回获取。 - 进入[AI原生应用引擎](https://support.huaweicloud.com/usermanual-wiseagent/appstage_04_0638.html#section0)，在左侧导航栏选择"知识中心 \> 知识库"，可从页面知识库ID栏获取。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字以及"-"组成，且长度为36个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [KnowledgeBaseDetail] object | 知识库详情信息。 | 表4KnowledgeBaseDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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生成。 **取值范围：** 不涉及。 | | data_sets | Array of [KnowledgeBaseLinkDataSetDetail] objects | **参数解释：** 知识库关联的数据集信息。 **取值范围：** 不涉及。 | | schedule_config | [ScheduledTaskConfig] object | **参数解释：** 周期性调度配置。 **取值范围：** 不涉及。 | 表5RetrievalConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **默认取值：** 不涉及。 | 表6KnowledgeBaseLinkDataSetDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **取值范围：** 不涉及。 | | knowledge_base_id | String | **参数解释：** 知识库ID。 **取值范围：** 不涉及。 | | data_set_id | String | **参数解释：** 知识数据集ID。 **取值范围：** 不涉及。 | | data_set_version | String | **参数解释：** 知识数据集版本。 **取值范围：** 不涉及。 | | data_set_index_config_id | String | **参数解释：** 知识数据集索引配置ID。 **取值范围：** 不涉及。 | | vector_table_id | String | **参数解释：** 向量表ID。 **取值范围：** 不涉及。 | | graph_id | String | **参数解释：** 图ID。 **取值范围：** 不涉及。 | | data_set_name | String | **参数解释：** 数据集名称。 **取值范围：** 不涉及。 | | data_type | String | **参数解释：** 数据类型。 **取值范围：** 不涉及。 | | data_set_index_config_name | String | **参数解释：** 知识数据集索引配置名称。 **取值范围：** 不涉及。 | 表7ScheduledTaskConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cycle_type | String | **参数解释：** 定时任务周期类型。 **取值范围：** 枚举值： - DAY：按日更新。 - WEEK：按周更新。 | | run_time | String | **参数解释：** 定时任务执行时间。 **取值范围：** 格式为：HH:mm:ss，如：18:30:00。 | | week_day | String | **参数解释：** 定时任务执行日期。 **约束限制：** "cycle_type"为"WEEK"时需传入。 **取值范围：** 枚举值： - SUNDAY：星期天。 - MONDAY：星期一。 - TUESDAY：星期二。 - WEDNESDAY：星期三。 - THURSDAY：星期四。 - FRIDAY：星期五。 - SATURDAY：星期六。 | | execute_immediately | Boolean | **参数解释：** 定时任务是否立即执行一次。 **取值范围：** true或false。 | | version_refresh_mode | String | **参数解释：** 版本刷新模式。 **取值范围：** 枚举值： - ONE_VERSION：每次执行覆盖原版本。 - MULTI_VERSION：每次执行生成新版本。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 异常错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 异常错误信息。 **取值范围：** 不涉及。 | #### 请求示例 无 #### 响应示例 **状态码：200** 知识库详情响应信息。 ``` { "data" : { "last_updated_date" : "2025-07-25T11:49:38.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" : "0725第二次修改", "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", "data_sets" : [ { "last_updated_date" : "2025-07-24T09:23:17.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" : "0de4dd75-35f0-4f62-9bb5-1a044a18205d", "knowledge_base_id" : "febb587f-20fb-4ec2-8431-f5b8858fecde", "data_set_id" : "3971729f-6f0d-4219-b228-6a8d9df6e8da", "data_set_version" : "v2025-07-16T14:14:23Z", "data_set_index_config_id" : "b723287c-ccd7-460e-bbe0-2af6bf486f44", "vector_table_id" : "707a8872-2420-4ac7-a3d1-64121265e546", "data_set_name" : "测试0716_001", "data_type" : "TEXT", "data_set_index_config_name" : "test_0716", "vector_database_type" : "ELASTICSEARCH", "full_text_database_type" : "ELASTICSEARCH" } ], "schedule_config" : null } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 知识库详情响应信息。 | | 400 | 请求错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-appstage/ErrorCode.html)。