接口简介
OmniAIServe 智能客服系统 接口说明
基于文档的问答回复接口是一种人工智能技术，通过分析输入的问题和预先准备好的文档集合来回答问题。
接口通常包括两个主要组成部分：检索和答案生成。检索阶段使用自然语言处理技术将问题与文档进行匹配，
找到与问题相关的文档。答案生成阶段使用机器学习和自然语言生成技术从相关文档中提取答案。
这种接口可以用于各种应用程序和情境，例如在线客服、教育和智能搜索引擎。
该技术的优点包括快速、高效和准确回答问题，可以提高用户满意度和减少人力成本。
公共Header参数
| 参数名 | 示例值 | 参数描述 |
|---|---|---|
| X-ID | 123 | 用户标识 |
| X-Token | 456 | 签名 |
| X-Random | 789 | 随机数，保证每次请求的唯一性 |
/docsai/获取文档上传进度
暂无描述
接口URL
http://127.0.0.1:6006/api/task_status?task_id=0dae6e3b-1d24-465e-8ea9-8930c5ed004d1
请求方式
GET
Content-Type
json
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| task_id | 0dae6e3b-1d24-465e-8ea9-8930c5ed004d1 | String | 是 | - |
请求Body参数
成功响应示例
{
"code": 5001,
"status": "can't find document,please upload"
}
/docsai/文档上传
暂无描述
接口URL
请求方式
POST
Content-Type
form-data
请求Body参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| file | xxx.pdf | String | 是 | 上传的文件 |
| user | test001 | String | 是 | 当前用户 |
| name | test_txt | String | 是 | 自定义文件名 |
成功响应示例
{
"code": 0,
"data": "0dae6e3b-1d24-465e-8ea9-8930c5ed004d",
"message": "success"
}
/docsai/获取已上传文档信息
暂无描述
接口URL
请求方式
GET
Content-Type
none
请求Header参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| X-ID | 123 | String | 是 | - |
| X-Token | 123 | String | 是 | - |
| X-Random | 123 | String | 是 | - |
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| user | 11 | String | 是 | - |
成功响应示例
[
{
"date": "default",
"description": "default",
"docLink": "default",
"fullName": "default",
"language": "default",
"location": "local",
"model": "openai_text-embedding-ada-002",
"name": "default",
"version": ""
}
]
/docsai/获取与文档相似内容
暂无描述
接口URL
请求方式
POST
Content-Type
json
请求Body参数
{
"question":"文档内容",
"activae_docs":"indexes/4-2-it02/nankunshanmusijiahuawenquanjiudianjianjie.pdf"
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| question | 文档内容 | String | 是 | - |
| activae_docs | indexes/4-2-it02/nankunshanmusijiahuawenquanjiudianjianjie.pdf | String | 是 | 上传文档的链接地址 |
成功响应示例
{
"code": 0,
"data": "文档助手 \nDocsAI是一种尖端的文档总结解决方案，可简化在项目文档中查找信息的过程。通过集成\n强大的 GPT模型，开发人员可以轻松地提出有关项目的问题并获得准确的答案。 \n告别耗时的手动搜索，让 DocsAI帮助您快速找到所需的信息。尝试一下，看看它如何彻\n底改变您的项目文档体验。 \n \n一： 如何上传 \n1. 支持 pdf，纯文本文件的上传 \n2. 控制文本大小，防止训练费用过高 \n \n二： 如何问答 \n1. 想用相关性强的问题进行咨询 \n例如： 文章主要讲了什么？ 本文讲的内容请用英文归纳并答复我 \n \n三： 如何接入 \n请联系效率工具部，申请试用 \n ",
"msg": "success"
}
/docsai/获取联网内容
暂无描述
接口URL
请求方式
POST
Content-Type
json
请求Body参数
{"q":"广州天气"}
成功响应示例
{
"code": 1,
"msg": "广州天气预报15天_广州15天天气预报-【星座看天气网】:2023年5月24日星座看天气网为大家带来广州天气预报15天,广州15天天气预报等广州天气情况,还有实时发布的气温,风向,天气资讯,每天生活指数等信息查询。更多天气信息请上星座...xingzuokan.com/tianqi227_15day/广州天气:2023年5月24日5月22日15时至23日12时,受低层切变影响,我市出现大到暴雨、局部大暴雨,并伴有短时强降水、6-8级阵风、强雷电等强对流天气。全市共440个站点(94.4%)出现降雨,平...广州天气广州市天气-广州市天气预报30天 - 珍珠号:2023年5月23日3、广州明天天气:多云转晴,北风3-4,全天气温10℃~21℃。 4、最冷月为1月份,月平均气温为9～16℃。平均相对湿度77%,市区年降雨量约为1720毫米。全年中,4至6月为...www.dsxwc.com/lvyou/7180...html雷雨“三连击”,明天广州还有雨【天气】暴雨+强雷电+8级大风即将“杀到”,至于降温……|......未来几天番禺天气……|多云|雷雨|降水|雷阵雨|广州市_...2011年广州市气候公报-广州天气 - 百度文库:2011年广州市气候公报-广州天气百度文库【广州天气预报】广州天气预报一周,广州天气预报15天,30天...:2023年5月22日广州天气[切换城市]2023年06月24日 星期六 癸卯年五月初七 28℃ 阴24 ~ 29℃ 湿度:99%风向:东南风 1级紫外线:很弱空气质量:优 PM: 10日出: 05:42日落: 19:1624...天气网【广州天气预报】广州天气预报15天,30天,一周天气预报,天...:2023年5月25日广州天气 [切换] 06:33 更新 2023年05月25日 星期四 癸卯年四月初七 25°C 阴转小雨 23~31°C 优50 湿度91% 东风2级广州24小时天气预报展开 明天 05/26 小雨...天气网广州天气预报7天_广州7天天气预报-换车网:2023年5月22日广州市7天天气预报2023年05月22日~2023年05月28日 05月22日 星期一 中雨 24℃~35℃ 西南风转无持续风向 3-4级转小于3级 宜嫁娶忌开光黑色,蓝色,灰色05月...换车网"
}
/docsai/与openai问答
暂无描述
接口URL
请求方式
POST
Content-Type
json
请求Body参数
{
"question":"文档内容",
"system_instruct":"你可以先从文档中搜索对应内容进行总结回复，文档内容为:'''xxxxx'''，如果文档无法回复我的要求则可参考联网的内容回答我的要求，联网内容:'''xxxxx'''。 如果联网中的内容与要求无关，请自行理解并答复；我的要求是:文档内容",
"historys":{"a":"hi","q":"hi","doc":"xxxxxx.pdf"}
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| question | 文档内容 | String | 是 | - |
| activae_docs | indexes/4-2-it02/nankunshanmusijiahuawenquanjiudianjianjie.pdf | String | 是 | 上传文档的链接地址 |
成功响应示例
{
"answer": "抱歉，我无法直接访问文档内容。如果您能提供文档的内容，我将尽力为您提供帮助和回答。",
"question": "文档内容"
}
/docsai/与openai问答-流式返回
暂无描述
接口URL
请求方式
POST
Content-Type
json
请求Body参数
{
"question":"文档内容",
"system_instruct":"你可以先从文档中搜索对应内容进行总结回复，文档内容为:'''xxxxx'''，如果文档无法回复我的要求则可参考联网的内容回答我的要求，联网内容:'''xxxxx'''。 如果联网中的内容与要求无关，请自行理解并答复；我的要求是:文档内容",
"historys":{"a":"hi","q":"hi","doc":"xxxxxx.pdf"}
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| question | 文档内容 | String | 是 | - |
| activae_docs | indexes/test02/nankunshanmusijiahuawenquanjiudianjianjie.pdf | String | 是 | 上传文档的链接地址 |
成功响应示例
{
"answer": "抱歉，我无法直接访问文档内容。如果您能提供文档的内容，我将尽力为您提供帮助和回答。",
"question": "文档内容"
}