拉取镜像
docker pull calehh/file_search:latesthttps://hub.docker.com/repository/docker/calehh/file_search
编排参考chart.yml
本地启动参考docker-compose-example.yml：
返回示例：{"code":0, "data":"XXX"}
code为0则成功，data为返回信息。小于0为错误，data为错误信息。
post请求使用表单格式
Content-Type:multipart/form-data
| 请求字段 | 类型 | 备注 |
|---|---|---|
| doc | file文件 | 文件上传 |
| path | string | 文件路径 |
| filename | string | 文件名（可选，默认为上传文件名） |
| content | string | 文本内容（可选，暂时备用） |
文件内容来自doc或者content二选一，doc优先级更高。
{
code: 0,
data : "5c6390bb-abc4-41c1-8e97-8215fe74a066" //添加文件的编号DocID，DocID对应唯一文件
}
post请求使用表单格式
Content-Type:multipart/form-data
| 请求字段 | 类型 | 备注 |
|---|---|---|
| docId | string | 文件编号 DocID |
{
code: 0,
data : "5c6390bb-abc4-41c1-8e97-8215fe74a066" //删除文件的编号DocID
}
post请求使用表单格式
Content-Type:multipart/form-data
| 请求字段 | 类型 | 备注 |
|---|---|---|
| query | string | 查询文本 |
| limit | int | 最大回复数 （暂时不支持分页） |
{
code: 0
data : {
count: 10,
offset : 0,
limit : 10,
items: [
{
index: 'Files', //索引名，为Files或Rss
name: 'aaa.js', //文件名
docId: "5c6390bb-abc4-41c1-8e97-8215fe74a066", //文件编号
where: "/131313/bbb", //路径
type: ".js", //扩展名
size: number, //字节数
created : number, //创建时间戳
snippet: string, //高亮摘要，用<mark>标签标注 例如：…and the second-smallest planet in the <mark>Solar</mark> <mark>System</mark>, larger only than Mercury. In the English language, Mars is named for the Roman god of war. Mars is a terrestrial planet with a thin atmosphere and h…
}
]
}
}
Post Json
{
name: 'aaa',
entry_id : number,
created : number,
feed_infos : [{ // 属于哪个feed列表
feed_id : number,
feed_name : number;
feed_icon : string;
}],
borders: [ // 属于哪个文件夹
{
name:string;
id: number;
}
],
"content": string, //rss内容
}
{
code: 0,
data : "5c6390bb-abc4-41c1-8e97-8215fe74a066" //添加文件的编号DocID，DocID对应唯一文件
}
post请求使用表单格式
Content-Type:multipart/form-data
| 请求字段 | 类型 | 备注 |
|---|---|---|
| docId | string | 文件编号 DocID |
{
code: 0,
data : "5c6390bb-abc4-41c1-8e97-8215fe74a066" //删除文件的编号DocID
}
post请求使用表单格式
Content-Type:multipart/form-data
| 请求字段 | 类型 | 备注 |
|---|---|---|
| query | string | 查询文本 |
| limit | int | 最大回复数 （暂时不支持分页） |
{
code: 0
data : {
count: 10,
offset : 0,
limit : 10,
items: [
{
name: 'aaa',
entry_id : number,
created : number,
feed_infos : [{ // 属于哪个feed列表
feed_id : number,
feed_name : number;
feed_icon : string;
}],
borders: [ // 属于哪个文件夹
{
name:string;
id: number;
}
],
docId: string,
snippet：'' ， // 如果是文件是文字的，显示命中了哪段话
}
]
}
}
AI聊天的过程为用户提问，AI回复，轮流进行。AI会基于之前的聊天记录和新问题做出回复。使用conversactionId标识聊天，使用messageId标识一次回复。
服务端接受请求后检查参数无误，立刻回复ok。随后多次请求回调接口，推送AI回答消息，消息以递增的形式发送。
包含3种方式提问：基于世界知识，基于指定文件，基于Documents目录内的文档知识。使用"type"字段标识，分别为: "basic", "single_doc", "full_doc"。
post请求使用表单格式
Content-Type:multipart/form-data
| 请求字段 | 类型 | 备注 |
|---|---|---|
| message | string | 提问内容 |
| conversationId | string （可选） | 继续一段聊天则填入聊天ID，开始新的聊天则为空 |
| path | string （可选） | 基于该路径的文件回答，为空则仅基于模型知识 |
| ｜type ｜string （可选）｜选择提问方式，默认基于世界知识 | ||
| callback | string | 回调接口URI |
{
code: 0
data : {
conversationId: "3cdaa5d8-1801-4e4f-a672-aaa01da33d62",
messageId: "e3665eb4-68b2-4f3e-bbe7-9f34180cd0db",
}
}
请求格式：Post Content-Type: application/json
请求示例：{"code":0, "data":"XXX"}
code为0则成功，data为返回信息。小于0为错误，data为错误信息。出现错误后，回答结束不会再调用回调接口。
| data对象字段 | 类型 | 备注 |
|---|---|---|
| text | string | 回复内容 |
| messageId | string | 回复ID。同一问题的多次回调的messageID相同。 |
| conversationId | string | 聊天ID。同一问题的多次回调的conversationId相同。 |
| model | string | 模型名 |
| done | bool | true为回复结束 |
text字段的回复内容为递增形式。done字段为true后回复结束，不会再回调。
例如一个问题的连续回调：
{
code: 0
data : {
text:"Elon",
messageId":"e3665eb4-68b2-4f3e-bbe7-9f34180cd0db",
conversationId:"3cdaa5d8-1801-4e4f-a672-aaa01da33d62",
model:"chat_model",
done: false,
}
}
{
code: 0
data : {
text:"Elon M",
messageId":"e3665eb4-68b2-4f3e-bbe7-9f34180cd0db",
conversationId:"3cdaa5d8-1801-4e4f-a672-aaa01da33d62",
model:"chat_model",
done: false,
}
}
{
code: 0
data : {
text:"Elon Mask",
messageId":"e3665eb4-68b2-4f3e-bbe7-9f34180cd0db",
conversationId:"3cdaa5d8-1801-4e4f-a672-aaa01da33d62",
model:"chat_model",
done: false,
}
}
{
code: 0
data : {
text:"Elon Mask is the",
messageId":"e3665eb4-68b2-4f3e-bbe7-9f34180cd0db",
conversationId:"3cdaa5d8-1801-4e4f-a672-aaa01da33d62",
model:"chat_model",
done: false,
}
}
{
code: 0
data : {
text:"Elon Mask is the CEO.",
messageId":"e3665eb4-68b2-4f3e-bbe7-9f34180cd0db",
conversationId:"3cdaa5d8-1801-4e4f-a672-aaa01da33d62",
model:"chat_model",
done: true,
}
}