API概览

知识库管理接口

知识库管理等相关接口。

结构化数据接口

将结构化数据文件纳入系统进行管理接口。

文件管理接口

用户纳入系统的文档管理接口。

FAQ管理接口

用户自定义的FAQ相关管理接口。

FAQ批量管理接口

用户自定义的批量FAQ相关管理接口。

搜索与问答接口

Koosearch的搜索与模型问答接口。

对话历史接口

用户对话历史接口。

图片管理接口

图片管理相关接口。

模型管理接口

模型管理的相关接口。

用户的文档解析规则定义接口

用户文档解析自定义规则配置接口。

创建知识库

创建名称为xxx的知识库。

修改知识库配置

修改知识库配置。包括：

1. 解析设置：是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。
2. 文档拆分设置：
   • 自动分段
   • 长度分段（按文本长度分段）
   • 层级分段（按小标题分段，可自定义小标题解析规则
3. 搜索模型设置：rerank模型配置。
4. NLP模型设置。
5. 其他设置：召回数量、参考文档数量、精排开关、Query改写开关、意图分类。

设置知识库搜索问答prompt

设置知识库搜索问答prompt，该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。

设置通用问答prompt

设置通用问答prompt。该prompt包含问题占位符{0}，和对回答的要求。

开启知识库

根据ID开启知识库，知识库开启后为可检索状态。

关闭知识库

根据ID关闭知识库，知识库关闭后为不可检索状态。

获取知识库列表

获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。

查询知识库详情

根据知识库ID获取当前知识库下的所有文件list，包括文档名称、文档类型、文档大小、文档状态、创建人、创建时间等。

删除知识库

根据ID删除知识库。

结构化数据上传

将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。

下载失败的条目

下载一个JSON文件，该文件包含给定上传Field的失败条目。

结构化数据文件搜索

根据文件名搜索目标文件。

上传文件

上传文件至某个知识库。

查询文件

在当前知识库查询名称为xx的文件。

下载文件

下载指定ID的文件。

删除文件

删除指定ID的文件。

创建FAQ

输入问题、相似问题、答案，创建单条FAQ。

更新FAQ

更新指定ID的FAQ的问题、答案、相似问题。

获取FAQ

根据ID获取FAQ详情，包括问题、答案。

查询FAQ列表

获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。

删除FAQ

根据知识库ID和FAQ的ID，删除FAQ。

批量删除FAQ

选择多个需要删除的FAQ，根据ID批量删除。

批量FAQ上传

上传xlsx/xls文件，用于FAQ的批量导入。

下载上传失败的FAQ

下载给定上传的批量FAQ文件中，上传失败的条目。

列举批量上传faq文件

列举批量上传faq文件。

下载批量导入FAQ原文件

下载批量导入FAQ的原始文件。

删除批量导入FAQ文件

删除指定的FAQ文件。

搜索知识库

根据query，在指定知识库中搜索得到topN相关的结果。

生成答案

将content输入给模型，使用模型能力生成答案。

查询对话历史列表

查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。

获取对话历史

根据chat_id获取对话历史，返回历史的question和answer数据。

删除对话历史

根据指定ID，删除对应的对话历史。

批量删除对话历史

根据多个ID，批量删除对话历史信息。

上传图片

上传图片入库。

获取图片内容

根据ID获取图片内容。

新增模型

新增配置模型，包括模型名称、模型描述、模型endpoint、模型配置。

修改模型配置

修改模型。

列举模型

列举模型。

删除模型

删除模型。

创建用户解析规则

列用于创建用户自定义的解析规则，解析规则用于解析需要作为subtitle的文本，规则由上而下依次校验。

修改用户解析规则

用于修改已配置的解析规则。

列举用户规则列表

列举用户配置的所有解析规则列表。

删除用户定义规则解析接口

用于删除用户定义的某种规则。