文档首页/ 应用平台 AppStage/ API参考/ API/ 知识中心/ 查询知识数据集详情
更新时间:2025-08-04 GMT+08:00
分享

查询知识数据集详情

功能介绍

该接口用于查询知识数据集详情。

调用方法

请参见如何调用API

URI

GET https://aiae.appstage.myhuaweicloud.com/v1/knowledge-datasets/{data_set_id}

表1 路径参数

参数

是否必选

参数类型

描述

data_set_id

String

参数解释:

知识数据集id,获取方式:

1.创建知识数据集接口返回值即为知识数据集id。

2.进入AI原生应用引擎,在左侧导航栏选择“知识中心 > 知识库”,选择页面右上角的“... > 知识数据集”,在数据集列表中,单击数据集名称,进入详情页即可获取数据集id。

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

参数解释:

鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

KnowledgeDataSetDetail object

参数解释:

知识数据集详情。

取值范围:

不涉及。

表4 KnowledgeDataSetDetail

参数

参数类型

描述

data_set_versions

Array of KdsVersionInfo objects

参数解释:

知识数据集版本配置信息列表。

取值范围:

列表最大长度100。

index_configs

Array of KdsIndexConfigInfo objects

参数解释:

知识数据集索引配置信息列表。

取值范围:

列表最大长度100。

表5 KdsVersionInfo

参数

参数类型

描述

id

String

参数解释:

数据集版本id。

取值范围:

由数字、字母和中划线组成,长度36。

version

String

参数解释:

数据集版本号。

取值范围:

格式为:vyyyy-mm-ddThh:mm:ssZ,如v2024-11-21T11:36:55Z。

created_date

String

参数解释:

数据集版本创建时间。

取值范围:

格式为:yyyy-mm-dd hh:mm:ss,如2024-11-21 11:36:55。

last_updated_date

String

参数解释:

数据集版本最近更新时间。

取值范围:

格式为:yyyy-mm-dd hh:mm:ss,如2024-11-21 11:36:55。

表6 KdsIndexConfigInfo

参数

参数类型

描述

id

String

参数解释:

索引id。

取值范围:

由数字、字母和中划线组成,长度36。

name

String

参数解释:

索引名称。

取值范围:

由中英文、数字、“_”组成,长度为[2-50]。

description

String

参数解释:

索引描述。

取值范围:

不涉及。

data_set_id

String

参数解释:

知识数据集id。

取值范围:

由数字、字母和中划线组成,长度36。

vector_model_service_key

String

参数解释:

向量化模型的service_key。

取值范围:

不涉及。

index_vector_config

IndexVectorConfig object

参数解释:

索引向量化配置。

取值范围:

不涉及。

表7 IndexVectorConfig

参数

参数类型

描述

long_text_solution

String

参数解释:

知识数据集切片长文本处理方式。

取值范围:

枚举值:

TRUNCATE_MODE(截断模式:如果分片的token长度超过向量化模型的token数,则自动对超长部分进行截断处理)。

SMART_MODE(智能模式:如果分片的token长度超过向量化模型的token数,则知识库向量化失败)。

DEFAULT_MODE(默认模式:如果分片的token长度超过向量化模型的token数,则知识库向量化失败)。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

异常错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

异常错误信息。

取值范围:

不涉及。

请求示例

响应示例

状态码:200

操作成功,返回数据集详情。

{
  "data" : {
    "data_set_versions" : [ {
      "id" : "askdjh28e62-xxxxxxxxx-a15be0d63812",
      "version" : "v2024-11-21T11:36:55Z",
      "created_date" : "2024-11-11 19:36:57",
      "last_updated_date" : "2024-11-21 19:36:57"
    } ],
    "index_configs" : [ {
      "id" : "d3f28e62-xxxxxxx-a15be0d638a2",
      "name" : "索引配置名称",
      "description" : "索引配置",
      "data_set_id" : "d3f28e62-3a81-4018-a48f-a15be0d638a2",
      "vector_model_service_key" : "service_key",
      "index_vector_config" : {
        "long_text_solution" : "TRUNCATE_MODE"
      }
    } ]
  }
}

状态码:400

请求错误。

{
  "error_code" : "AIAE.40001001",
  "error_msg" : "参数xxxx不合法。"
}

状态码

状态码

描述

200

操作成功,返回数据集详情。

400

请求错误。

错误码

请参见错误码

相关文档