如何使用【知识库构建】

在本入门教程中，我们将演示如何通过我们的 OpenAPI 构建一个简单的知识库。

一、调用前的准备工作

首先，您需要完成一些调用前的准备工作，主要包括：

1. “获取访问密钥”
2. “生成API_TOKEN”

二、创建一个知识库

目前版本（Beta），可按照以下步骤，一步一步调用接口，完成一个知识库的创建：

1. 准备一份给知识库使用的文件，请您注意，当前版本（Beta）对数据格式和文件格式有一些要求，具体要求如下：

   • 对中文支持较好，其他语言的支持后续会逐步完善
   • 1个知识库支持上传50个文件
   • 单个文件大小不能超过20M
   • 此处说明的文件格式为 .json，其余格式请参考创建并上传文件
   • 编码格式为 UTF-8
   • 内容需遵循以下格式

{
    "qa_lst": [ //问答对知识
        {
            "std_q": "xxx", //问题描述
            "simi_qs": ["xxx", "xxx"], //相似问题描述
            "answer": "xxx" //答案描述
        },
        {
            "std_q": "xxx", //问题描述
            "simi_qs": ["xxx", "xxx"], //相似问题描述
            "answer": "xxx" //答案描述
        }
    ],
    "text_lst": [ //文本知识，纯文本数据（当前版本（Beta），建议每条数据尽量是一个独立的语义主题，便于提升检索效率和效果）
        "xxx",
        "xxx"
    ]
}

2. 调用 创建并上传文件 接口，上传知识库文件，获得一个“文件ID”

3. 调用 查询文件详情 接口，查看“文件格式校验状态”：

   • 当 “文件状态” = NOTUPLOADED 时，表明文件正在上传过程中
   • 当 “文件状态” = UPLOADED 时，表明文件已经上传完成
   • 当 “文件状态” = VALID 时，表明文件格式校验通过，可以开始执行下一步
   • 当 “文件状态” = INVALID 时，表明文件格式或数据格式有问题、没通过校验，此时您需要参照详细校验信息（validate_result）调整您的知识库文件，并在调整完成后重新上传

4. 调用 创建知识库 接口，使用步骤2获得的“文件ID”创建知识库，获得一个“知识库ID”

5. 调用 查询知识库详情 接口，查看“知识库状态”：

   • 当 “知识库状态” = PENDING时，表明知识库等待创建中
   • 当 “知识库状态” = LOADING时，表明知识库正在创建过程中
   • 当 “知识库状态” = UNAVAILABLE时，表明知识库创建失败
   • 当 “知识库状态” = AVAILABLE时，表明知识库已经创建成功

三、尝试在对话中使用该知识库

完成创建知识库后，您可以开始调用 对话生成 接口，尝试使用您的知识库，具体使用方法如下：

• 在接口请求体的 know_ids 里，填写您第二步获得的“知识库ID”即可。

到这里，您已经完成了一个简单的知识库的构建和使用，如果过程中出现了以上文档没有解释到的其他问题，欢迎您随时联系我们！