开发文档
总目录
接入常见问题
开发者平台使用帮助
HTTP API接口文档
Chatbot接口指令说明文档
Android SDK用户接入指南
微信公众号客服机器人接入教程
灵聚智能助理app开源说明文档
直播数字人系统用户评论回复接口开发文档
灵聚自定义对话训练API接口说明文档
本站点使用 MrDoc 构建
-
+
灵聚自定义对话训练API接口说明文档
# 灵聚自定义对话训练API接口说明文档 ## 概述 本文档主要面向需要自定义对话内容的开发者,文档对灵聚自定义对话训练API进行说明。通过此文档所介绍API,开发者可以接入灵聚自定义对话问答的能力。 灵聚基于灵聚开发者平台,提供自定义对话能力,同时通过API接口实现自定义对话功能。目前此能力满足基础的对话自定义需求,无法满足高级别的自定义对话能力。例如当自定义对话场景复杂,涉及模型微调、问答数量多需要进行训练、RPA能力等,仍需要定制服务。 自定义对话接口支持开发者用户提交:对话名称(name)、问题(question)、回答(response)。详细请见下方详细内容。自定义对话流程简化描述为:创建\-提交\-启用生效。 开发者通过API接口录入问答完成后,调用重启生效自定义对话接口。自定义对话生效后,当终端设备的用户问到对应问题,系统会优先将开发者设计的对话回答回复给用户。而当用户提问的问题,超出开发者设计的范围,则由灵聚的系统来回复答案。 <br/> ## 对接过程常见问题 ### 1\.自定义对话条数限制 每个应用最多支持300条问答。后期可调。 ### 2\.自定义对话重启生效时间 生效时间根据对话库内对话数量不同而不同,一般来讲,不会超过5分钟。 ### 3\.重启生效自定义对话接口有调用时间频率限制 因为重启生效过程中比较耗时,如果频繁调用该接口会影响用户对话。每次调用限制间隔5分钟。 ### 4\.修改自定义对话接口只支持修改回复内容 如果需要修改录入的问题内容,先删除已存在的对话,在调用添加接口新增加一条即可。 ### 5\.录入的问题需尽量精简,且遵循人类日常常用对话方式 不要带太多语气词、口水话表达。灵聚会根据录入问题利用相关技术进行泛化、训练。 ### 6\.批量上传自定义对话 6\.1开发者在自己web页面上提供给用户上传自定义对话的Excel文件或者其它可以支持用户批量录入自定义问答的功能。每个应用最多支持300条问答,开发者需要限制用户批量上传的自定义对话条数不能超过300条。 6\.2当开发者获取到用户批量上传的自定义对话信息后,把用户批量上传的自定义对话信息解析转换为“添加自定义对话接入”接口的“data”参数格式数据,通过“添加自定义对话API接口”发送给灵聚进行泛化、训练。 <br/> ## 1\.添加自定义对话接入配置 ### 接口路径:https://dev\.lingju\.ai/httpapi/addDialog\.do |名称|添加自定义对话API接口| |---|---| |\-|\-| |接口路径|https://dev\.lingju\.ai/httpapi/addDialog\.do| |请求方式|post| ### http post请求示例: ``` post https://dev.lingju.ai/httpapi/addDialog.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "appkey":"xxxxxxxxxxxxxxxxxxxxxx", "data": [{ "name":"xxxxxx", "question":"xxxxxx", "response":"xxxxxx" }, { "name":"xxxxxx", "question":"xxxxxx", "response":"xxxxxx" }] } ``` ### 请求参数说明: |参数|数据类型|可需|描述| | |---|---|---|---|---| |appkey|String|必填|分配给开发者的专属appkey,请妥善保管| | |data|list|必填|自定义对话集合| | | | | |name|对话名(限定32个字符以内。需要确保唯一,增、删、查、改都是通过对话名确定)| | | | |question|问题(限定30个字符以内)| | | | |response|回复(限定1000个字符以内)| ### 接口返回JSON示例: ``` { "status": 900, "description":"插入3条,失败2条", "data": [{ "name":"xxxxxx", "question":"xxxxxx", "response":"xxxxxx", "errorCause":"对话名XXX已存在" }, { "name":"xxxxxx", "question":"xxxxxx", "response":"xxxxxx", "errorCause":"与对话名YYY的问题SSS存在相同记录" }] } ``` ### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |参数|数据类型|描述| | |---|---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| | |data|list|添加失败的自定义对话集合| | | | |name|对话名| | | |question|问题| | | |response|回复| | | |errorCause|添加失败原因| |description|String|通常为空,出错时会有错误信息| | \*灵聚接口不提供文件上传,若开发者开发批量提交对话问答功能,例如开发者允许对应的用户上传excel表格文档进行批量对话自定义,则需自行开发文件上传和转化功能。 ## 2\.修改自定义对话接入配置 只支持修改回复内容。如果录入问题内容需要修改,先调用删除接口删掉该对话,再重新添加即可 ### 接口路径:https://dev\.lingju\.ai/httpapi/updateDialog\.do |名称|修改自定义对话API接口| |---|---| |\-|\-| |接口路径|https://dev\.lingju\.ai/httpapi/updateDialog\.do| |请求方式|post| ### http post请求示例: ``` post https://dev.lingju.ai/httpapi/updateDialog.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "appkey":"xxxxxxxxxxxxxxxxxxxxxx", "name":"xxxxxxxxxxxxxxxxxxxxxx", "response":"xxxxxxxxxxxxxxxxxxxxxx" } ``` ### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |\-|\-|\-|\-| |appkey|String|必填|分配给开发者的专属appkey,请妥善保管| |name|String|必填|对话名(限定32个字符以内)| |response|String|必填|回复(限定1000个字符以内)| ### 接口返回JSON示例: ``` { "status": 0 } ``` ### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |参数|数据类型|描述| |---|---|---| |\-|\-|\-| |status|int|状态码,0=成功,表示修改成功,其它值则为错误码,请参考错误码表| |description|String|通常为空,出错时会有错误信息| ## 3\.删除自定义对话接入配置 ### 接口路径:https://dev\.lingju\.ai/httpapi/deleteDialog\.do |名称|删除自定义对话API接口| |---|---| |\-|\-| |接口路径|https://dev\.lingju\.ai/httpapi/deleteDialog\.do| |请求方式|post| ### http post请求示例: ``` post https://dev.lingju.ai/httpapi/deleteDialog.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "appkey":"xxxxxxxxxxxxxxxxxxxxxx", "names":"xxxxxxxxxxxxxxxxxxxxxx" } ``` ### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |appkey|String|必填|分配给开发者的专属appkey,请妥善保管| |names|String|必填|删除自定义对话对话名,有多个自定义对话需要删除,使用\|符号隔开。| ### 接口返回JSON示例: ``` { "status": 0 } ``` ### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| |---|---|---| |\-|\-|\-| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表请求方式| |description|String|通常为空,出错时会有错误信息| ## 4\.查询自定义对话列表接入配置 ### 接口路径:https://dev\.lingju\.ai/httpapi/findDialog\.do |名称|查询自定义对话列表API接口| |---|---| |\-|\-| |接口路径|https://dev\.lingju\.ai/httpapi/findDialog\.do| |请求方式|post| ### http post请求示例: ``` post https://dev.lingju.ai/httpapi/findDialog.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "appkey":"xxxxxxxxxxxxxxxxxxxxxx" } ``` ### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |\-|\-|\-|\-| |appkey|String|必填|分配给开发者的专属appkey,请妥善保管| ### 接口返回JSON示例: ``` { "status": 0, "data": [{ "name":"xxxxxx", "question":"xxxxxx", "response":"xxxxxx" }, { "name":"xxxxxx", "question":"xxxxxx", "response":"xxxxxx" }] } ``` ### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |参数|数据类型|描述| | |---|---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| | |data|list|自定义对话集合| | | | |name|对话名| | | |question|问题| | | |response|回复| | | |trainingState|当前训练状态:0=等待训练;1=正在训练;2=训练完成;3=训练失败| |description|String|通常为空,出错时会有错误信息| | ## 5\.重启生效自定义对话接口接入配置 重启生效需要耗时较长,每次调用后需要间隔5分钟才能再次调用 ### 接口路径:https://dev\.lingju\.ai/httpapi/resetDialog\.do |名称|重启生效自定义对话API接口| |---|---| |\-|\-| |接口路径|https://dev\.lingju\.ai/httpapi/resetDialog\.do| |请求方式|post| ### http post请求示例: ``` post https://dev.lingju.ai/httpapi/resetDialog.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "appkey":"xxxxxxxxxxxxxxxxxxxxxx" } ``` ### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |\-|\-|\-|\-| |appkey|String|必填|分配给开发者的专属appkey,请妥善保管| ### 接口返回JSON示例: ``` { "status": 0 } ``` ### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| |---|---|---| |\-|\-|\-| |status|int|状态码,0=重启成功,其它值则为错误码,请参考错误码表| |description|String|通常为空,出错时会有错误信息| ## 6\.效果展示 开发者用户通过API接口录入自定义问答后,系统会对录入的问题(question)进行自动泛化,当终端设备的用户问到开发者录入的问题或系统自动泛化的问题后,系统会优先将开发者设计的回答(response)回复给用户。 下面以post请求录入一个“汽车机油”相关的问答为示例,系统自动泛化了20条问题。效果如下: ## 请求示例:  ## 系统自动泛化效果:  ## 7\.错误码列表 |错误码|描述| |---|---| |\-|\-| |0|成功| |\-1|系统异常| |1|其它错误| |4|开发者帐号错误,账户未完成认证或已被禁用| |6|APPKEY无效| |7|model错误| |8|参数错误| |43|应用无效,已被限制使用| |44|应用无效,已废弃| |45|目标对象数量已达上限| |129|应用已被限制| |900|存在部分自定义对话添加失败| |901|问题文本过长| |902|回复文本过长| |903|对话名文本过长| |904|回复文本中包含敏感词| |905|自定义对话条数已达上限| |906|过于频繁调用重启生效自定义对话接口| |907|该对话名不存在| |908|参数值不能为空| |909|自定义对话正在训练中,请稍后再操作|
lingju.ai
2026年10月20日 17:19
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档(打印)
分享
链接
类型
密码
更新密码