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

查询知识数据集详情

功能介绍

查询知识数据集详情

URI

GET /v1/knowledge-datasets/{data_set_id}

表1 路径参数

参数

是否必选

参数类型

描述

data_set_id

String

知识数据集id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

String

AI原生应用引擎鉴权API Key。

1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。

2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。

3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API Key。

4.在弹出的下载窗口中单击“立即下载”,将API Key下载到本地查看。

5.使用时,需在sk前加上Bearer ,如Bearer sk-xxxxxxxx。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

data

KnowledgeDataSetDetail object

知识数据集详情

表4 KnowledgeDataSetDetail

参数

参数类型

描述

data_set_versions

Array of KdsVersionInfo objects

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

index_configs

Array of KdsIndexConfigInfo objects

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

表5 KdsVersionInfo

参数

参数类型

描述

id

String

版本id

version

String

版本号,格式为:v2024-11-21T11:36:55Z

created_date

String

创建时间

last_updated_date

String

最近更新时间

表6 KdsIndexConfigInfo

参数

参数类型

描述

id

String

索引id

name

String

索引名称

description

String

索引描述

data_set_id

String

知识数据集id

vector_model_service_key

String

向量化模型的service_key

index_vector_config

IndexVectorConfig object

索引向量化配置

表7 IndexVectorConfig

参数

参数类型

描述

long_text_solution

String

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

状态码: 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

请求错误

错误码

请参见错误码

相关文档