j9九游会登录/ 应用平台 appstage/ api参考/ / / 查询知识库详情(token认证)
更新时间:2025-08-06 gmt 08:00

查询知识库详情(token认证)-j9九游会登录

功能介绍

该接口用于查询知识库详情信息,包括名称、描述、状态、检索方式、数据集信息等。

调用方法

请参见。

uri

get https://aiae.appstage.myhuaweicloud.com/v1/unidata/knowledge-bases/{knowledge_base_id}

表1 路径参数

参数

是否必选

参数类型

描述

knowledge_base_id

string

参数解释:

知识库id,获取方式:

约束限制:

不涉及。

取值范围:

只能由英文字母、数字以及“-”组成,且长度为36个字符。

默认取值:

不涉及。

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

string

参数解释:

用户token。通过调用iam服务获取用户token接口获取(响应消息头中x-subject-token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应body参数

参数

参数类型

描述

data

knowledgebasedetail object

知识库详情信息。

表4 knowledgebasedetail

参数

参数类型

描述

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

参数解释:

周期性调度配置。

取值范围:

不涉及。

表5 retrievalconfig

参数

参数类型

描述

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。

默认取值:

不涉及。

表6 knowledgebaselinkdatasetdetail

参数

参数类型

描述

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

参数解释:

知识数据集索引配置名称。

取值范围:

不涉及。

表7 scheduledtaskconfig

参数

参数类型

描述

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

请求错误。

错误码

请参见错误码

相关文档

网站地图