API概览
Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。
|
类型 |
说明 |
|---|---|
|
知识库管理等相关接口。 |
|
|
将结构化数据文件纳入系统进行管理接口。 |
|
|
用户纳入系统的文档管理接口。 |
|
|
用户自定义的FAQ相关管理接口。 |
|
|
用户自定义的批量FAQ相关管理接口。 |
|
|
Koosearch的搜索与模型问答接口。 |
|
|
用户对话历史接口。 |
|
|
图片管理相关接口。 |
|
|
模型管理的相关接口。 |
|
|
用户文档解析自定义规则配置接口。 |
|
API |
说明 |
|---|---|
|
创建名称为xxx的知识库。 |
|
|
修改知识库配置。包括：
|
|
|
设置知识库搜索问答prompt，该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。 |
|
|
设置通用问答prompt。该prompt包含问题占位符{0}，和对回答的要求。 |
|
|
根据ID开启知识库，知识库开启后为可检索状态。 |
|
|
根据ID关闭知识库，知识库关闭后为不可检索状态。 |
|
|
获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 |
|
|
根据知识库ID获取当前知识库下的所有文件list，包括文档名称、文档类型、文档大小、文档状态、创建人、创建时间等。 |
|
|
根据ID删除知识库。 |
|
API |
说明 |
|---|---|
|
输入问题、相似问题、答案，创建单条FAQ。 |
|
|
更新指定ID的FAQ的问题、答案、相似问题。 |
|
|
根据ID获取FAQ详情，包括问题、答案。 |
|
|
获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 |
|
|
根据知识库ID和FAQ的ID，删除FAQ。 |
|
|
选择多个需要删除的FAQ，根据ID批量删除。 |
|
API |
说明 |
|---|---|
|
上传xlsx/xls文件，用于FAQ的批量导入。 |
|
|
下载给定上传的批量FAQ文件中，上传失败的条目。 |
|
|
列举批量上传faq文件。 |
|
|
下载批量导入FAQ的原始文件。 |
|
|
删除指定的FAQ文件。 |
|
API |
说明 |
|---|---|
|
查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。 |
|
|
根据chat_id获取对话历史，返回历史的question和answer数据。 |
|
|
根据指定ID，删除对应的对话历史。 |
|
|
根据多个ID，批量删除对话历史信息。 |
