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

创建知识数据集

功能介绍

创建知识数据集

URI

POST /v1/knowledge-datasets

表1 Query参数

参数

是否必选

参数类型

描述

data_set

是

String

创建知识数据集请求体，参数结构请参见“附录 > 知识数据集请求参数说明”

file

否

Array of strings

上传文件，数量不超过10个

请求参数

表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

String

正常返回的结果

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误信息

请求示例

{
  "name" : "测试",
  "description" : "测试",
  "data_type" : "TEXT",
  "tags" : [ "对话问答", "文案生成" ],
  "ingestion_config" : {
    "data_source" : "FILE_UPLOAD",
    "file_types" : [ "txt" ]
  },
  "schedule_config" : {
    "schedule_type" : "ONCE"
  },
  "preprocess_config" : {
    "cleaning_methods" : [ "invisible" ],
    "pdf_preprocess_type" : "NO_PREPROCESS"
  },
  "chunk_config" : {
    "slicing_configs" : {
      "txt" : {
        "slicing_method" : "autoSlicing"
      }
    }
  },
  "extraction_config" : {
    "extraction_example" : "今天天气如何？答：还不错哦。",
    "extraction_mode" : "RULE_EXTRACTION",
    "rule_extraction_configs" : [ {
      "extraction_rule" : "SEPARATOR",
      "field_name" : "question",
      "separator_extraction" : {
        "contain_separator" : false,
        "extraction_code" : 1,
        "separator" : "？"
      }
    }, {
      "extraction_rule" : "TEMPLATE",
      "field_name" : "answer",
      "template_extraction" : {
        "contain_end" : true,
        "contain_start" : false,
        "end_with" : "。",
        "extraction_code" : 1,
        "start_with" : "答"
      }
    } ]
  },
  "index_config" : {
    "description" : "索引配置",
    "long_text_solution" : "TRUNCATE_MODE",
    "name" : "索引配置",
    "retrieval_configs" : [ {
      "category" : "FULL_CHUNK",
      "name" : "chunk",
      "retrieval_return" : false,
      "text_filter" : false,
      "vector_retrieval" : false
    }, {
      "category" : "CHUNK_FRAGMENT",
      "name" : "question",
      "retrieval_return" : true,
      "text_filter" : true,
      "vector_retrieval" : true
    }, {
      "category" : "CHUNK_FRAGMENT",
      "name" : "answer",
      "retrieval_return" : true,
      "text_filter" : true,
      "vector_retrieval" : false
    } ],
    "vector_model_service_key" : "GPT-4"
  }
}

响应示例

状态码： 200

操作成功，返回数据集id

{
  "data" : "3f28e62-xxxxxxxx-a15be0d638a2"
}

状态码： 400

请求错误

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

状态码

状态码

描述

200

操作成功，返回数据集id

400

请求错误

错误码

请参见错误码。

父主题： 知识中心

相关文档