所有文档

          智能客服对话平台 ICS

          NGD开放接口文档

          修改记录

          NO 接口文档版本号 修改内容 修改日期
          1 v1.0 全文 2019/11/05
          2 v1.1 前言角色说明增加 2020/01/06
          3 v1.2 意图返回码、协议增加 2020/02/18
          4 v1.3 1、faq标准问列表增加searchType
          2、faq标准问创建(suggestList只留id,channelAnswer的suggestList移除)
          3、faq更新(suggestList只留id,channelAnswer的suggestList移除)
          4、faq标准问列表,suggestList为空列表;增加修改人字段
          5、faq标准问详情,suggestList中返回增加ID
          6、faq 标准问识别 增加
          7、增加统计高频接口、faq search接口、faq 识别接口
          2020/03/16
          5 v1.4 1. 文档库创建、更新attatchs中增加uid、username参数 2020/06/09
          6 v1.5 1. 增加渠道维度、渠道维度值、特殊渠道值、FAQ特殊答案模块
          2. FAQ标准问模块取消channelAnswer字段
          3.状态码增加
          2020/06/19
          7 v1.6 1. 增加获取会话历史详情接口
          2. 增加系统实体模块
          3. 增加用户实体模块
          4. 增加实体值模块
          5. 增加bot 列表
          6. 增加发布模块
          7. 增加nlu模块
          8. Bot 推荐和
          2020/07/06

          1.使用说明

          1.1 前言

          1. API是NGD开放能力的基础,借助API可以极大的节省人力成本,提高效率,用更高效的方式完成对NGD数据资源的管控。对于开发者来说,使用 API 完成一些重复性强的工作可以极大节约时间和精力;除此之外,API还有便于组合能力、便于自动化、扩展性强等优点。 本文介绍了管理端开放接口的鉴权参数、API请求结构和参数、数据返回结构和参数以及各个模块之间的关系。
          2. 角色说明。NGD服务分为管理端和服务端。 管理端: 用于内部运营使用。管理端数据可以发布推向服务端。 服务端: 最终用于C端用户查询使用 开放能力接口范围定义: /open 开头的都是管理端;/core 开头的是服务端;

          1.2 请求鉴权

          开放能力API调用时,依然需要在HTTP请求的header中加上Authorization字段,值为与Agent相匹配的token。如下:

          key value
          Authorization NGD {token}

          Api的地址格式为:{IP}:{PORT}/open/v{versionId}/{model}" 以ip地址为127.0.0.1,端口为8600,FAQ标准问创建地址为例,API的访问地址地址为:127.0.0.1:8600/open/v1/faq/standard/create

          /open 开头的使用域名:openapi-ngd.baidu.com,/core 开头的域名地址为:api-ngd.baidu.com

          注1:本文请求地址中的未明确写明版本的,versionId默认都为1,其他按照path中的为准

          注2:开放接口服务目前默认关闭,有使用需求的用户可以填写咨询单,备注信息注明“开通开放接口使用”

          1.3 请求返回值

          返回值的格式分为请求正确与请求错误两种: 1、请求正确返回值:

          参数名 类型 父节点 备注
          code int HTTP状态码(请求正确则为200)
          time long 时间
          msg string 状态信息
          data T 返回数据

          2、请求错误返回值:

          参数名 类型 父节点 备注
          code int 错误状态码
          requestId string 请求ID
          msg string 状态信息
          tip string 提示

          2. 状态码

          2.1 OPEN API调用基础状态(100)

          状态编号 说明
          200 请求成功
          100001 Agent无API访问权限
          100002 Agent访问频率超出限制
          100003 SDK版本与服务器版本不匹配
          100004 请求参数格式错误
          100005 已存在同名内容
          100006 数据版本不一致
          100999 处理失败

          2.2 授权错误状态(101)

          状态编号 说明
          101001 token错误
          101002 无权限,访问被拒绝
          101003 没有相关操作权限

          2.3 FAQ&闲聊(102)

          状态编号 说明
          102001 一个渠道最多只能配置一条答案
          102002 已存在相似问题
          102003 相同的答案下有多个标准问
          102004 已存在相似的标准问
          102005 已有其他用户对正在对该问题进行编辑
          102006 编辑的数据已被删除
          102007 问题不存在或无操作权限
          102008 问题版本不一致
          102009 当前问法是问答标准问,无法加入问答不响应问题中
          102010 问答推荐问题不能关联自身
          102011 输入内容包含敏感词
          102012 第一个维度的维度值不能选择默认维度
          102013 渠道值的默认维度的排序不能在在两个其他维度值中间,且默认维度后只能选择默认维度
          102014 特殊答案的渠道维度值顺序错误
          102015 FAQ特殊渠道答案不能为空

          2.4 目录(103)

          状态编号 说明
          103001 同一目录下存在相同名称
          103002 目录结构已变更,请重新操作
          103003 目录不存在
          103004 已有其他用户正在修改此目录
          103005 目录列表数据版本不一致
          103006 目录层级超出限制

          2.5 渠道(104)

          状态编号 说明
          104001 相同编码的渠道维度值已存在
          104002 渠道数据版本不一致
          104003 渠道维度或维度值不存在
          104004 渠道在线应用中,请下线后重试
          104005 渠道维度下有特殊答案配置,不可删除
          104006 同一维度存在多个维度值
          104007 特殊渠道值已存在
          104008 维度数量超出限制
          104009 当前层级存在多个相同的维度值名称
          104010 维度值层级数量超出限制
          104011 当前层级的维度值数量超出限制
          104012 渠道维度不存在
          104013 渠道维度值不存在
          104014 特殊渠道值不存在

          2.6 文档库(105)

          状态编号 说明
          105001 文档不存在或无权限
          105002 相同目录下,不允许同名线上文档
          105003 已有其他用户正在对该文档进行编辑
          105004 文档内容未变化,请修改后再提交
          105005 线上文档数据版本不一致,请重试
          105006 线上文档正在被编辑,禁止删除操作
          105007 文档正在被编辑,禁止移动
          105008 文档不存在或内容为空

          2.7 FAQ模板(106)

          状态编号 说明
          106001 模板不合法
          106002 "|"两边不能为空
          106003 W:a-b中a和b范围为[0,20]
          106004 W:a-b片段中,a<=b
          106005 字符串只支持汉字、字母、数字、下划线和中划线
          106006 实体ID不存在
          106007 关键词/规则不符合规范
          106008 插入失败
          106009 更新失败
          106010 删除失败
          106011 词库ID不存在
          106012 模板的左右中括号不匹配
          106013 模版的“|”不可以嵌套,[[aa|cc]|bb]不合法
          106014 中括号中按“|”分割后,特殊符号@、¥、W必须处在开头的位置
          106015 []中间不能为空
          106016 当前已存在相同模版
          106017 其它已存在相同模版
          106018 系统意图下已存在相同模版
          106019 ?左边不能为空
          106020 模版不能超过140个字符
          106021 FAQ不存在
          106022 模板产生的组合太复杂

          2.8 意图(107)

          状态编号 原始编号 说明
          107001 同名示例已存在
          107002 同名的意图ID已存在
          107003 问题长度过长
          107004 问题不存在
          107005 意图不存在
          107006 问题必须为列表结构
          107007 非法意图ID
          107008 系统意图ID不存在
          107009 该实体类型已经存在
          107010 每个意图别名不超过10个字符
          107011 每个意图最多包含5个别名
          107012 创建别名失败
          107013 意图别名已存在
          107014 意图别名只支持中文、英文、数字
          107015 已经有意图使用过该别名
          107016 意图名称不能为空且不超过20个字符
          107017 意图名称仅支持中英文、数字和下划线,且不能以数字开头
          107018 用户意图不能与系统意图名称重复
          107019 同名的意图名称已存在
          107020 每个意图描述不超过20个字符
          107021 意图示例不能超过140个字符
          107022 Agent下已经存在相同的意图示例

          2.9 审核相关(108)

          状态编号 说明
          108001 已在审核流程中,无法操作
          108002 已有其他用户正在操作

          3. 操作时序

          3.1 总时序图

          API分为两类:

          1. 管理端服务。主要用于数据接入和管理。
          2. 对接线上用户对话服务。 本文主要介绍管理端的开放服务。下图显示的是管理端开放服务在NGD系统中的范围和作用。 图片

          渠道和目录是基础资源,先创建这两个基础资源,才可以继续操作FAQ和文档库。FAQ标准问中用到了渠道和目录;文档库中使用了目录资源;闲聊中未使用这两个资源,可直接进行操作。 备注:该文档中展示了core/query接口,具体接口信息请参见core/query文档。

          83b40ccf464a254d30c739ec55b3bde85744d890.jpeg

          3.2 渠道时序图

          image.png

          3.3 目录时序图

          image.png

          3.4 问答时序图

          Sequence-faq.jpg

          3.5 闲聊时序图

          Sequence-chat.jpg

          3.6 文档库时序图

          image.png

          3.7 意图时序图

          Sequence-intent.jpg

          4. 问答库

          4.1 问答库标准问

          4.1.1 问答库标准问创建

          版本:(since 5.4) 1、接口地址:POST {IP}:{PORT}/open/v2/faq/standard/create 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 父节点 是否可空 备注
          question string 问题
          answer map< string, object> 回答
          type int answer 类型;0 是多答案;1是单答案
          text string answer 如果是单答案,必须传
          list list< map> answer 答案列表(多答案必须传)
          text string answer.list 答案内容【类型为:1 文本 3 富文本 时填写到该字段】
          type int answer.list 类型【候选项: 1文本 3富文本 4图片】
          url string answer.list 图片地址【类型是 4 图片时必传】
          dirId string 目录id,默认是根目录0
          tags list< string> 关键词【字符串列表】
          suggestList list< map> 关联问题
          id string suggestList 问题ID

          请求示例

          POST /open/v{versionId}/faq/standard/create
          {
          	"dirId": "0",
          	"answer": {
          		"list": [{
          			"text": "通用答案1",
          			"type": 1
          		}, {
          			"type": 1,
          			"text": "通用答案2"
          		}],
          		"type": 0
          	},
          	"question": "FAQ测试",
          	"tags": ["标签1", "标签2"],
          	"suggestList": [{
          		"id": "c0eb33d8-1276-4501-9961-fd8154524940"
          	}]
          }

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data 标准问ID

          示例:

          {
          	"data":{"id":"082bde30-f1c2-41aa-8138-d21e8711e227"},
          	"code":200,
          	"time":1568274632887,
          	"msg":"OK"
          }

          4.1.2 问答库标准问更新

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v2/faq/standard/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 父节点 是否可空 备注
          id string id
          editVersion int 编辑的版本
          question string 问题
          answer map< string, object> 回答
          type int answer 类型;0 是多答案;1是单答案
          text string answer 如果是单答案,必须传
          list list< map> answer 答案列表(多答案必传)
          text string answer.list 答案内容。
          url string answer.list 图片地址【类型是 4 图片时必传】
          type int answer.list 类型; 1文本 3富文本 4图片
          dirId string 目录id
          tags list< string> 关键词【字符串列表】
          status int 状态【0 生效;1 失效】
          suggestList list< map> 关联问题
          id string suggestList 问题ID

          请求示例

          POST /open/v{versionId}/faq/standard/update
          {
          	"id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
          	"question": "FAQ测试更新",
          	"answer": {
          		"list": [{
          			"text": "更新通用答案1",
          			"type": 1
          		}, {
          			"type": 1,
          			"text": "更新通用答案2"
          		}],
          		"type": 0
          	},
          	"dirId": "0",
          	"tags": ["标签1", "标签2"],
          	"editVersion": 0,
          	"suggestList": [{
          		"id": "XXXXXXXXXXXXXXX"
          	}],
          }

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          version int data 版本号

          示例:

          {
               "data":{"version":1},
               "code":4002801,
               "time":1568277015660,
               "msg":"OK"
          }

          4.1.3 问答库标准问列表

          版本:(since 5.4)

          1、接口地址:GET {IP}:{PORT}/open/v2/faq/standard 2、入参

          参数名 类型 父节点 是否可空 备注
          status int 未失效 0;失效 1
          pn int 页码,默认为1
          ps int 每页数据条数,默认为10
          dirId string 目录id
          keyword string 关键词
          orderBy string 排序字段【现在支持编辑时间排序和默认排序两种排序方式。默认排序不用传该字段,编辑时间传lastEditTime】
          order string 升序【asc】还是降序【desc】
          searchType string 默认为“default”。如果值为“standard”,则只检索条件变为只匹配标准问问题

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 标准问id
          question string list 问题
          answer map list 答案
          type int answer 0 是多答案;1 是单答案
          text string answer 答案。【当answer下的type是1的时】
          list list answer 答案列表。【当answer下的type字段是0时,单答案没有list属性】
          text string answer.list 答案
          type int answer.list 1文本; 3富文本; 4图片;
          url string answer.list 图片地址
          status int list 状态标识,0 生效,1 失效
          dirId string list 目录id
          tags list list 标签信息
          updated string list 更新时间
          created string list 创建时间
          editVersion int list 编辑版本
          expire string list 过期时间
          effect string list 生效时间
          isActiveHook int list 0 未使用webhook ;1 使用webhook
          instruction string list 指令
          suggestList list list 关联问题列表,默认为空列表
          channelAnswers list list 渠道列表【列表页时,该字段为空list】

          示例:

          {
              "data":{
                  "total":1,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                          "id":"e3980621-748a-4714-b079-ee85a720dd05",
                          "question":"山东济南",
                          "answer":{
                              "list":[
                                  {
                                      "text":"济南是经济强省山东的省会。",
                                      "type":1
                                  },
                                  {
                                      "type":4,
                                      "url":"http://localhost:8080/api/v2/file/download?key=Ym9zXzc5YjE1M2VhLTM5ODEtNGNkNS1iMDBmLTc5MTA0MDYwMmJjNA=="
                                  }
                              ],
                              "type":0
                          },
                          "status":0,
                          "dirId":"bddc9428-01ce-45d9-9d51-7120c02a40ea",
                          "tags":[
                              "省会",
                              "泉城"
                          ],
                          "updated":"2019-09-12 11:02:22",
                          "created":"2019-09-12 11:02:22",
                          "editVersion":0,
                          "expire":"2099-12-31 23:59:59",
                          "effect":"2000-01-01 00:00:00",
                          "isActiveHook":1,
                          "instruction":"9eb5c8d6-34f8-4dba-8bcf-54c4958ff8d9",
                          "suggestList":[]
                      }
                  ]
              },
              "code":200,
              "time":1568257385194,
              "msg":"OK"
          }

          4.1.4 问答库标准问详情

          版本:(since 5.4)

          1、接口地址: GET {IP}:{PORT}/open/v2/faq/standard/detail 2、入参(放到Query Param中)

          参数名 类型 是否可空 备注
          id string 标准问id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data
          question string data 问题
          answer map data 答案
          type int answer 类型 0 多答案;1 单答案
          text string answer 单答案内容
          list list< map> answer 当且仅当answer.type = 0时,出现此字段
          text string answer.list 答案内容
          type string answer.list 答案类型 1文本 3富文本 4图片
          url string answer.list 图片地址,当answer.list.type=4时,出现此字段
          status int data 状态标识,0 生效,1 失效
          dirId string data 目录id
          tags list data 标签信息,内容string类型
          updated string data 更新时间 "2019-09-12 16:30:15"
          created string data 创建时间 "2019-09-12 16:30:15"
          editVersion int data 版本号信息
          expire string data 过期时间 "2099-12-31 23:59:59"
          effect string data 生效时间 "2000-12-31 23:59:59"
          channelAnswers list data 渠道答案(保留字段,为兼容旧版本。如果渠道数据是由旧数据升级而来,且旧版本中的faq有旧渠道数据的,则有内容。如果不是升级来的渠道数据,则无内容。要获取faq多级渠道答案列表需调用特殊渠道答案列表接口)
          id string channelAnswers 渠道答案id
          answer map channelAnswers 答案
          type int channelAnswers.answer 类型 0 多答案;1 单答案
          text string channelAnswers.answer 单答案内容
          list list< map> channelAnswers.answer 当且仅当answer.type = 0时,出现此字段
          text string channelAnswers.answer.list 答案内容
          type string channelAnswers.answer.list 答案类型 1文本 3富文本 4图片
          url string channelAnswers.answer.list 图片地址,当answer.list.type=4时,出现此字段
          channelId string channelAnswers 渠道id
          channelName string channelAnswers 渠道名
          isActiveHook int channelAnswers 0 未使用webhook ;1 使用webhook
          instruction string channelAnswers 指令
          suggestList list data 通用答案中关联问题
          id string suggestList 关联问题ID
          score int suggestList 相似度
          question string suggestList 问题
          isActiveHook int data 0 未使用webhook ;1 使用webhook
          instruction string data 指令
          lastEditUserId string data 最后修改人Id
          lastEditUsername string Data 最后修改人

          示例:

          {
              "data":{
                  "id":"e3980621-748a-4714-b079-ee85a720dd05",
                  "question":"山东济南",
                  "answer":{
                      "list":[
                          {
                              "text":"济南是经济强省山东的省会。",
                              "type":1
                          },
                          {
                              "type":4,
                              "url":"http://localhost:8080/api/v2/file/download?key=Ym9zXzc5YjE1M2VhLTM5ODEtNGNkNS1iMDBmLTc5MTA0MDYwMmJjNA=="
                          },
                          {
                              "type":3,
                              "text":"l这是font-size: 18px;">富文本http://www.baidu.com" target="_blank">百度"
                          }
                      ],
                      "type":0
                  },
                  "status":0,
                  "dirId":"bddc9428-01ce-45d9-9d51-7120c02a40ea",
                  "tags":[
                      "省会",
                      "泉城"
                  ],
                  "updated":"2019-09-12 16:30:15",
                  "created":"2019-09-12 11:02:22",
                  "editVersion":2,
                  "expire":"2099-12-31 23:59:59",
                  "effect":"2000-01-01 00:00:00",
                  "lastEditUserId":"xxxxxx",
                  "lastEditUsername":"xxxxxxx",
                  "channelAnswers":[
                      {
                          "channelId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                          "channelName":"渠道2",
                          "answer":{
                              "text":"答案",
                              "type":1
                          },
                          "id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                          "isActiveHook":0,
                          "instruction":""
                      },
                      {
                          "channelDelete":0,
                          "channelId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                          "channelName":"渠道1",
                          "answer":{
                              "text":"这是font-size: 16px;">渠道1font-size: 16px;">的信息http://www.baidu.com" target="_blank">百度",
                              "type":3
                          },
                          "id":"34926436-6a73-4c92-b164-246359b12140",
                          "isActiveHook":0,
                          "instruction":""
                      }
                  ],
                  "isActiveHook":1,
                  "instruction":"9eb5c8d6-34f8-4dba-8bcf-54c4958ff8d9",
                  "suggestList":[
                      {
                          "score":1,
                          "id": "c0eb33d8-1276-4501-9961-fd8154524940",
                          "question":"北京"
                      }
                  ]
              },
              "code":200,
              "time":1568605316034,
              "msg":"OK"
          }

          4.1.5 问答库标准问删除

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/standard/delete 2、入参(放在query param中)

          参数名 类型 父节点 是否可空备注
          id string 标准问id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          示例:

          {
              "data":null,
              "code":200,
              "time":1568600520307,
              "msg":"OK"
          }

          4.1.6 问答库标准问生效/失效

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/expire 2、入参(虚将json字符串写入到body中)

          参数名 类型 是否可空 备注
          id string 渠道id
          status int 状态标识,0-上线,1-下线,默认为0

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
          	"data":null
          }

          4.1.7 FAQ-标准问识别(算子)

          版本:(since 5.6)

          1、接口地址:GET {IP}:{PORT}/core/v1/faq/recall

          2、入参

          参数名 类型 是否可空 备注
          top int 返回结果数,默认返回5条,最大不能超过10条, 超过按照10条返回
          query string 查询语句

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          questions list data 查询页数
          question string questions 问题
          confidence double questions 相似度
          answers map questions 回答内容
          channel string questions 渠道
          dir string questions 目录标识
          list list answer 答案
          text string list 答案内容
          type string list 答案类型 1文本 3富文本 4图片
          url string list 图片地址,当answer.list.type=4时,出现此字段
          detail list questions 扩展问详情 最大值3个
          question string detail 扩展问
          confidence double detail 相似度
          type int detail 问题的类型 0是扩展问 3是模板

          示例:

          {
              "time": 1573721580227,
              "data": {
                  "total": 2,
                  "questions": [
                      {
                          "question": "我爱中国",
                          "confidence": 1,
          				"dir" : "0",
                          "answers": [
                              {
                                  "channel": "c1",
                                  "list": [
                                      {
                                          "type": 1,
                                          "text": "渠道答案",
                                          "url": null
                                      }
                                  ]
                              },
                              {
                                  "channel": "通用渠道",
                                  "list": [
                                      {
                                          "type": 1,
                                          "text": "通用答案",
                                          "url": null
                                      }
                                  ]
                              }
                          ],
                          "detail": [
                              {
                                  "question": "我爱中国首都",
                                  "confidence": 0.06000000238418579,
          						"type": 0
                              },
                              {
                                  "question": "我爱北京",
                                  "confidence": 0.03333333507180214,
          						"type": 0
                              }
                          ]
                      },
                      {
                          "question": "我爱上海",
                          "confidence": 0.03333333507180214,
          				"dir" : "0",
                          "answers": [
                              {
                                  "channel": "通用渠道",
                                  "list": [
                                      {
                                          "type": 1,
                                          "text": "通用答案",
                                          "url": null
                                      }
                                  ]
                              }
                          ],
                          "detail": []
                      }
                  ]
              },
              "code": 200,
              "msg": "OK"
          }

          4.1.8 FAQ高亮搜索

          版本:(since 5.6)

          1、接口地址: (GET) {IP}:{PORT}/open/v1/faq/search

          2、入参

          参数名 类型 是否可空 备注
          keyword String 关键字
          pn int 查询页数,默认为1
          ps int 每页条数,默认为20

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 闲聊标准问ID
          question string list 问题
          dirId string list 目录Id
          created string list 创建时间
          updated string list 修改时间
          lastEditTime string list 最后编辑时间
          lastEditUsername string list 最后编辑人
          status int list 0 生效 、1 失效
          tags string[] list 标签数组
          answer map<string, object> list 答案
          type int answer 类型 0 多答案;1 单答案t
          text string answer 单答案
          list list< map> answer 当且仅当answer.type = 0时,出现此字段
          text string answer.list 答案文本
          type int answer.list 答案类型 1文本 3富文本 4图片
          url string answer.list 答案类型 1文本 3富文本 4图片

          示例:

          {
          	"time": 1582191583052,
          	"data": {
          		"list": [{
          			"id": "XXXXXXXX",
          			"question": "<aicp_em_highlight>多渠道</aicp_em_highlight>测试",
          			"dirId": "0",
          			"lastEditTime": "2020-01-19 11:16:18",
          			"lastEditUserId": "XXXXXXXX",
          			"lastEditUsername": "XXXXXXXX",
          			"status": 0,
          			"tags": [],
          			"answer": {
          				"text": "111",
          				"type": 1
          			}
          		}, {
          			"id": "XXXXXXXX",
          			"question": "<aicp_em_highlight>多渠道</aicp_em_highlight>测试1",
          			"dirId": "0",
          			"lastEditTime": "2020-01-19 11:44:29",
          			"lastEditUserId": "XXXXXXXX",
          			"lastEditUsername": "XXXXXXXX",
          			"status": 0,
          			"tags": [],
          			"answer": {
          				"text": "111",
          				"type": 1
          			}
          		}],
          		"total": 2,
          		"ps": 10,
          		"pn": 1
          	},
          	"code": 200,
          	"msg": "OK"
          }

          4.2 问答库渠道答案

          4.2.1 问答库渠道答案创建

          版本:(since 6.0)

          1、接口地址:POST {IP}:{PORT}/open/v2/faq/channel/answer/create 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 父节点 是否可空 备注
          faqId string FAQ标准问ID
          instruction string 指令
          isActiveHook int 是否启用WebHook,0:关闭 1:开启
          answer map 特殊渠道答案
          list list answer 特殊答案列表
          type int answer.list 类型; 1:纯文本;3:富文本;4:图片;
          url string answer.list 图片地址【类型是 4 图片时必传】
          text string answer.list 答案内容。如果类型为1、3,则必须传
          channels list 特殊答案渠道值列表。如存在多个元素,则表示创建多个具有不同的渠道值组合,但是答案相同的FAQ特殊答案。
          channel list channels 答案渠道值列表,维度值个数为维度的数量,维度值需按序传递,顺序为Agent级别维度值列表中的维度顺序。
          code string channels.channel 维度值编码
          name string channels.channel 维度值名称
          dimensionCode string channels.channel 维度编码
          dimensionName string channels.channel 维度名称

          示例:

          "faqId": "022fd161-d291-492c-b5b1-f73e95b0f8ca",
          "answer": [
              {
              "list": [
                  {"type": 1, "text": "特殊答案"}
                  ]
              }
          ],
          "channels": [
              {"channel":[
                  {"code": "code1",
                  "name": "name1",
                  "dimensionCode": "code",
                  "dimensionName": "name"}
              ]}
          ],
          "isActiveHook":0,
          "instruction": ""

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          string data 特殊答案id

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
          	"data":{"id": "12bec642-8f92-4f95-acbd-0b6d43841d38"}
          }

          4.2.2 问答库渠道答案更新

          版本:(since 6.0)

          1、接口地址:POST {IP}:{PORT}/open/v2/faq/channel/answer/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 父节点 是否可空 备注
          id String 渠道答案id
          faqId string FAQ标准问ID
          instruction string 指令
          isActiveHook int 是否启用WebHook,0:关闭 1:开启
          version Int 版本号
          answer map 特殊渠道答案
          list list answer 特殊答案列表
          type int answer.list 类型; 1:纯文本;3:富文本;4:图片;
          url string answer.list 图片地址【类型是 4 图片时必传】
          text string answer.list 答案内容。如果类型为1、3,则必须传
          channels list 特殊答案渠道值列表。如存在多个元素,则表示创建多个具有不同的渠道值组合,但是答案相同的FAQ特殊答案。
          channel list channels 答案渠道值列表,维度值个数为维度的数量,维度值需按序传递,顺序为Agent级别维度值列表中的维度顺序。
          code string channels.channel 维度值编码
          name string channels.channel 维度值名称
          dimensionCode string channels.channel 维度编码
          dimensionName string channels.channel 维度名称

          示例:

          "id": "00aba423-5159-4672-9f28-3db8132761b7",
          "faqId": "022fd161-d291-492c-b5b1-f73e95b0f8ca",
          "answer": [
              {
              "type": 0,
              "list": [
                  {"type": 1, "text": "特殊答案"}
                  ]
              }
          ],
          "channels": [
              "channel":[
                  {"code": "code1",
                  "name": "name1",
                  "dimensionCode": "code",
                  "dimensionName": "name"}
              ]
          ],
          "isActiveHook":0,
          "instruction": "",
          "version": 0

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          version data 更新后版本

          示例:

          {
              "data":{"version": 1},
              "code":4002801,
              "time":1568274632887,
              "msg":""
          }

          4.2.3 问答库渠道答案列表

          版本:(since 6.0)

          1、接口地址:GET {IP}:{PORT}/open/v2/faq/channel/answer
          2、入参(放到query param)

          参数名 类型 是否可空 备注
          pn string 查询页数,默认为1
          ps string 每页条数,默认为20
          keyword string 搜索关键词
          channel string 渠道维度值code,用作筛选条件
          orderBy string 以何字段排序。预留字段,暂时没有使用
          faqId string FAQ ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 特殊答案ID
          faqId string list faqID
          answer map list 特殊渠道答案
          type int answer 类型; 0:多答案 1:纯文本;3:富文本;4:图片
          text string answer 单答案文本
          url string answer 图片地址。如果类型为4,则有内容
          list list answer 特殊答案列表
          text string answer.list 答案内容
          type int answer.list 类型; 1:纯文本;3:富文本;4:图片
          url string answer.list 图片地址
          channels list list 特殊答案渠道值列表
          channel list channels 答案渠道值列表,维度值个数为维度的数量,顺序为agent级别维度值列表中的维度顺序。
          code string channels.channel 维度值编码
          name string channels.channel 维度值名称
          dimensionCode string channels.channel 维度编码
          dimensionName string channels.channel 维度名称
          isActiveHook int list 是否开启WebHook
          instruction string list 指令
          version int list 版本号

          示例:

          {
              "code":4002801,
              "time":1568274632887,
              "msg":"",
              "data":{
                  "pn": 1,
                  "ps": 20,
                  "total": 1
                  "list": [
                      {
                      "id": "00aba423-5159-4672-9f28-3db8132761b7",
                      "faqId": "022fd161-d291-492c-b5b1-f73e95b0f8ca",
                      "answer": [
                          {
                          "type": 0,
                          "list": [
                              {"type": 1, "text": "特殊答案"},
                              ]
                          }
                      ],
                      "channels": [
                          "channel":[
                              {"code": "code1",
                              "name": "name1",
                              "dimensionCode": "code",
                              "dimensionName": "name"}
                          ]
                      ],
                      "isActiveHook":0,
                      "instruction": "",
                      "version": 0   
                      }
                  ]
               }
           }

          4.2.4 问答库渠道答案删除

          版本:(since 6.0)

          1、接口地址:POST {IP}:{PORT}/open/v2/faq/channel/answer/delete 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 父节点 是否可空 备注
          id String 渠道答案ID
          faqId string FAQ标准问ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据

          示例:

          {
              "data":null,
              "code":4002801,
              "time":1568274632887,
              "msg":""
          }

          4.3 问答库扩展问

          4.3.1 问答库扩展问创建

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/extend/create 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          question string FAQ扩展问问题
          faqId string FAQ标准问ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          id string 扩展问ID

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
          	"data":{"id":"08a43c53-4406-4d14-a91f-97e8af587567"}
          }

          4.3.2 问答库扩展问更新

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/extend/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          question string FAQ扩展问问题
          faqId string FAQ标准问ID
          id string FAQ扩展问ID
          editVersion int FAQ扩展问版本号

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          version int data 版本号

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
          	"data":{"version":1}
          }

          4.3.3 问答库扩展问列表

          版本:(since 5.4)

          1、接口地址:GET {IP}:{PORT}/open/v1/faq/extend
          2、入参(放到query param)

          参数名 类型 是否可空 备注
          faqId string FAQ ID
          keyword string 关键字
          pn int 查询页数,默认为1
          ps int 每页条数,默认为20

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 闲聊标准问ID
          question string list 问题
          faqId string list faqID
          created string list 创建时间
          updated string list 修改时间
          editVersion int list FAQ扩展问版本号

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"",
          	"data":{
          		"total": 245,
          		"pn": 1,
          		"ps": 10,
          		"list": [
          			{	
          				"id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
          				"question": "问题1",
          				"faqId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f",
          				"created": "2019-07-22 17:52:09",	
          				"updated": "2019-07-22 17:52:09",
                          "editVersion": 1					
          			},
          			······
          		]
          	}
          }

          4.3.4 问答库扩展问删除

          版本:(since 5.4)

          1、接口地址: POST {IP}:{PORT}/open/v1/faq/extend/delete 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 扩展问ID
          faqId string FAQ标准问ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
          	"data":null
          }

          4.4 问答库不响应问

          4.4.1 问答库不响应问创建

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/noresp/create" 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          question string 不响应问问题

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id int 不响应问ID

          示例:

          {
              "code":4002801,
              "time":1568613825147,
              "msg":"OK",
              "data":{"id":"08a43c53-4406-4d14-a91f-97e8af587567"}
          }

          4.4.2 问答库不响应问更新

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/noresp/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          question string 不响应问问题
          version string 不响应问版本
          id string 不响应问ID

          4、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          version int data 版本号

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
              "data":{"version":1}
          }

          4.4.3 问答库不响应问列表

          版本:(since 5.4)

          1、接口地址:GET {IP}:{PORT}/open/v1/faq/noresp 2、入参 (Query param)

          参数名 类型 是否可空 备注
          ps string 页面大小,默认20
          pn string 页码,默认1
          keyword string 问题关键词

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据
          total int data 数据总量
          ps int data 页面大小
          pn int data 页码
          list list data 数据列表
          id string list 不响应问ID
          question string list 不响应问问题
          created string list 创建时间
          update string list 更新时间
          version int list 不响应问数据版本

          示例:

          {
              "data":{
                  "total":3,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                          "id":"6fee54bf-4d5b-4b59-81b6-d9a9f61fabe9",
                          "question":"不响应问1",
                          "created":"2019-09-16 14:03:44",
                          "updated":"2019-09-16 14:14:27",
                          "version":1
                      },
                      {
                          "id":"b55ba26a-2a5e-46ee-a2e5-06d6b8360ffb",
                          "question":"不响应问2",
                          "created":"2019-09-10 15:22:28",
                          "updated":"2019-09-10 15:22:28",
                          "version":0
                      
                      },
                      {
                          "id":"c824edc1-3c20-4cdf-9abb-66d9259e3e30",
                          "question":"不响应问3",
                          "created":"2019-09-10 15:22:00",
                          "updated":"2019-09-10 15:22:08",
                          "version":1            
          			 }
                  ]
              },
              "code":200,
              "time":1568614468691,
              "msg":"OK"
          }

          4.4.4 问答库不响应问删除

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/noresp/delete" 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 不响应问ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
              "data":null
          }

          4.5 问答库模板

          4.5.1 问答库模板创建

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/template/create 2、入参(json格式放到body中)

          参数名 类型 是否可空 备注
          faqId string FAQ标准问ID
          template string FAQ模板内容

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id int data 模板ID

          示例:

          {
              "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          4.5.2 问答库模板更新

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/template/update 2、入参(json格式放到body中)

          参数名 类型 是否可空 备注
          id string 模板ID
          faqId string FAQ标准问ID
          template string FAQ模板
          version int 版本号

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据
          version int data 版本号

          示例:

          {
              "data":{"version":1},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          4.5.3 问答库模板列表

          版本:(since 5.4)

          1、接口地址:GET {IP}:{PORT}/open/v1/faq/template 2、入参

          参数名 类型 是否可空 备注
          faqId string FAQ标准问id
          pn int 页码,默认为1
          ps int 每页数据条数,默认为20
          keyword string 检索关键字

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 模板ID
          faqId string list FAQ标准问ID
          template string list 模板字符串
          created tring list 创建时间
          update string list 修改时间

          示例:

          {
              "data":{
                  "total":1,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                       "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
                       "faqId": "2bc7647e-ab25-47c0-915a-e7e5d95d4472",
                       "template": "[W:0-4]",
                       "created": "2019-07-24 19:22:57",
                       "update": "2019-07-24 19:23:29"
                      } 
              },
              "code":200,
              "time":1568257385194,
              "msg":"OK"
          }

          4.5.4 问答库模板删除

          版本:(since 5.4)

          1、接口地址:POST {IP}:{PORT}/open/v1/faq/template/delete 2、入参(json格式放到body中)

          参数名 类型 是否可空 备注
          id string 模板ID
          faqId tring FAQ标准问ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          示例:

          {
              "data":null,
              "code":200,
              "time":1568274632887,
              "msg":"OK "
          }

          4.6 FAQ-推荐问题查询列表【BOT级别】

          版本:(since 5.4)

          1、header

          key value
          Authorization NGD {token}

          这个接口的token 与其他接口不同,这个token是bot级别的token 2、接口地址:GET {IP}:{PORT}/core/v1/faq/bot/standardSuggest 3、入参

          参数名 类型 是否可空 备注
          top int 返回结果数,默认返回5条
          query string 查询语句

          4、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          questions list data 查询页数
          id string questions id
          question string questions 问题
          suggestions list< string> questions 关联列表
          confidence double questions 相似度
          isChannelAnswer boolean questions 是否是渠道答案
          answer list questions 回答内容
          list list questions.answer 答案列表
          text string questions.answer.list 答案内容
          type string questions.answer.list 答案类型
          url string questions.answer.list 图片地址,当answer.list.type=4时,出现此字段

          示例:

          {
              "time":1573721580227,
              "data":{
                  "total":1,
                  "questions":[
                      {
                          "id":"c51676e3-4ff6-463a-a8b7-5512281104a3",
                          "question":"测试问答",
                          "answer":{
                              "list": [{
                                  "type":1,
                                  "text":"答案",
                                  "url":null
                              }]
                          },
                          "suggestions":null,
                          "confidence":0.6871752738952637,
                          "isChannelAnswer":false
                      }
                  ]
              },
              "code":200,
              "msg":"OK"
          }

          4.7 问答库标准问推荐列表【AGENT级别】

          版本:(since 5.4)

          1、接口地址:GET {IP}:{PORT}/core/v1/faq/agent/standardSuggest 2、入参(json格式放到body中)

          参数名 类型 是否可空 备注
          top int 返回结果数,默认返回5条
          query string 查询语句

          4、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          questions list data 查询页数
          id string questions id
          question string questions 问题
          suggestions list questions 关联列表
          confidence double questions 相似度
          isChannelAnswer boolean questions 是否是渠道答案
          answer map questions. 回答内容
          list list questions.answer 答案列表
          text string questions.answer.list 答案内容
          type string questions.answer.list 答案类型
          url string questions.answer.list 图片地址,当answer.list.type=4时,出现此字段

          示例:

          {
              "time":1573721580227,
              "data":{
                  "total":1,
                  "questions":[
                      {
                          "id":"c51676e3-4ff6-463a-a8b7-5512281104a3",
                          "question":"测试问答",
                          "answer":{
                              "list": [{
                                  "type":1,
                                  "text":"答案",
                                  "url":null
                              }]
                          },
                          "suggestions":null,
                          "confidence":0.6871752738952637,
                          "isChannelAnswer":false
                      }
                  ]
              },
              "code":200,
              "msg":"OK"
          }

          5. 闲聊库

          5.1 闲聊库标准问

          5.1.1 闲聊库标准问新建

          版本:(since 5.4)

          1.接口地址: (POST) {IP}:{PORT}/open/v1/chitchat/standard/create 2.入参(需生成JSON字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          answer list< map> 答案Map列表
          text string 答案文本
          type string 答案类型(只能传数字,目前只可为1,为纯文本)
          question string 问题

          示例:

          {
              "answer":[
                  {
                      "text":"答案1",
                      "type":"1" 
                  },
                  ......
              ]
              "question":“问题1”
          }

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          id int data 闲聊标准问id

          示例:

          {
              "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          5.1.2 闲聊库标准问更新

          版本:(since 5.4)

          1.接口地址:(POST) {IP}:{PORT}/open/v1/chitchat/standard/update
          2.入参(需生成JSON字符串,放到请求的body中)

          参数名 类型 是否可空 父节点 备注
          id string 标准问ID
          question string 问题
          version int 闲聊标准问版本号
          answer list< map> 答案列表
          text string answer 答案文本
          type string answer 答案类型(只能传数字,目前只可为1,为纯文本)

          示例:

          {
          	"id":"003ecd4f-344c-4187-8b14-f12737161ef31",
          	"version":1,
              "answer":[
                  {
                      "text":"答案1",
                      "type":"1" 
                  },
                  ......
              ]
              "question":“问题1”
          }

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          version int 版本号

          示例:

          {
              "data":{"version":1},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          5.1.3 闲聊库标准问删除

          版本:(since 5.4)

          1.接口地址:(POST) {IP}:{PORT}/open/v1/chitchat/standard/delete
          2.入参(需生成JSON字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 标准问ID

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          5.1.4 闲聊库标准问列表

          版本:(since 5.4)

          1.接口地址:(GET) {IP}:{PORT}/open/v1/chitchat/standard
          2.入参(写入到param中)

          参数名 类型 是否可空 备注
          pn int 查询页数,默认为1
          ps int 每页数量,默认为10

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 当前页数
          ps int data 每页数量
          list list data 数据列表
          id string list 闲聊标准问ID
          answer list< map> list 答案列表
          text string 答案文本
          type string 答案类型(目前只可为1,为纯文本)
          question string list 问题
          created string list 创建时间
          updated string list 修改时间
          version int list 版本号

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
              "data":{
                  "total": 245,
                  "pn": 1,
                  "ps": 10,
                  "list": [
                      {   
                          "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
                          "answer": [{"text":"答案1","type":1}],
                          "question": "问题1",
                          "created": "2019-07-22 17:52:09",   
                          "updated": "2019-07-22 17:52:09",   
                          "version": 1               
                      },
                      ······
                  ]
              }
          }

          5.1.5 闲聊库标准问题检索

          版本:(since 5.4)

          1.(GET) {IP}:{PORT}/open/v1/chitchat/standard/keyword
          2.入参(写入param中)

          参数名 类型 是否可空 备注
          pn int 查询页数,默认为1
          ps int 每页数量,默认为10
          keyword string 关键字

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 当前页数
          ps int data 每页数量
          list List data 数据列表
          id itring list 闲聊标准问ID
          answer list< map> list 答案列表
          text string 答案文本
          type string 答案类型(只能传数字,目前只可为1,为纯文本)
          question string list 问题
          created string list 创建时间
          updated string list 修改时间
          version int list 版本号

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
              "data":{
                  "total": 245,
                  "pn": 1,
                  "ps": 10,
                  "list": [
                      {   
                          "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
                          "answer": [{"text":"答案1","type":1}],
                          "question": "问题1",
                          "created": "2019-07-22 17:52:09",   
                          "updated": "2019-07-22 17:52:09",   
                          "version": 1               
                      },
                      ······
                  ]
              }
          }

          5.2 闲聊库扩展问

          5.2.1 闲聊库扩展问新建

          版本:(since 5.4)

          1.接口地址: (POST) {IP}:{PORT}/open/v1/chitchat/extend/create

          1. 入参(需生成JSON字符串,放到请求的body中)
          参数名 类型 是否可空 备注
          question string 扩展问问题
          standardId string 标准问ID

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          id int data 闲聊扩展问ID

          示例:

          {
              "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          5.2.2 闲聊库扩展问更新

          版本:(since 5.4)

          1.接口地址: (POST) {IP}:{PORT}/open/v1/chitchat/extend/update

          1. 入参(需生成JSON字符串,放到请求的body中)
          参数名 类型 是否可空 备注
          question string 扩展问问题
          standardId string 标准问ID
          id string 闲聊扩展问ID
          version int 版本号

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          version int data 版本号

          示例:

          {
              "data":{"iversion":1},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          5.2.3 闲聊库扩展问删除

          版本:(since 5.4)

          1.接口地址: (POST) {IP}:{PORT}/open/v1/chitchat/extend/delete

          2.入参(需生成JSON字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 扩展问ID
          standardId string 标准问ID

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          5.2.4 闲聊库扩展问列表

          版本:(since 5.4)

          1.接口地址:(GET) {IP}:{PORT}/open/v1/chitchat/extend 2.入参(写入param中)

          参数名 类型 是否可空 备注
          pn int 查询页数,默认为1
          ps int 每页数量,默认为10
          standardId string 标准问ID

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 当前页数
          ps int data 每页数量
          list List data 数据列表
          id string list 闲聊扩展问ID
          question string list 问题
          standardId string list 标准问ID
          extendId string list 扩展问ID
          created string list 创建时间
          updated string list 修改时间
          version int list 版本号

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
              "data":{
                  "total": 245,
                  "pn": 1,
                  "ps": 10,
                  "list": [
                      {   
                          "id":"001f1522-015d-4831-9cf6-0f8b11a78028",
                          "question": "问题1",
                          "standardId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f",
                          "extendId": "001f1522-015d-4831-9cf6-0f8b11a78028",
                          "created": "2019-07-22 17:52:09",   
                          "updated": "2019-07-22 17:52:09",
                          "version": 1                   
                      },
                      ······
                  ]
              }
          }

          5.2.5 闲聊库标准问题检索

          版本:(since 5.4)

          1.接口地址:(GET) {IP}:{PORT}/open/v1/chitchat/extend/keyword
          2.入参(写入param中)

          参数名 类型 是否可空 备注
          pn int 查询页数,默认为1
          ps int 每页数量,默认为10
          standardId string 标准问ID
          keyword string 关键字

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 当前页数
          ps int data 每页数量
          list List data 数据列表
          id string list 闲聊扩展问ID
          question string list 问题
          standardId string list 标准问ID
          extendId string list 扩展问ID
          created string list 创建时间
          updated string list 修改时间
          version int list 版本号

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
              "data":{
                  "total": 245,
                  "pn": 1,
                  "ps": 10,
                  "list": [
                      {   
                          "id":"001f1522-015d-4831-9cf6-0f8b11a78028",
                          "question": "问题1",
                          "standardId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f",
                          "extendId": "001f1522-015d-4831-9cf6-0f8b11a78028",
                          "created": "2019-07-22 17:52:09",   
                          "updated": "2019-07-22 17:52:09",
                          "version": 1                   
                      },
                      ······
                  ]
              }
          }

          6. 目录

          6.1 目录创建

          版本:(since 5.4)

          1.接口地址:(POST) {IP}:{PORT}/open/v1/directory/create
          2.入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          name string 目录名称
          parentId string 父节点ID【备注:根目录id是0】
          version int 目录版本号

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          id string data 目录ID
          version int data 版本号

          示例:

          {
              "data":{"version":1, "id":"0a3d1e60-809a-4266-82f9-ba65ec4452d8"},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          6.2 目录更新

          版本:(since 5.4)

          1.接口地址: (POST) {IP}:{PORT}/open/v1/directory/update 2.入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          name string 目录名称
          id string 目录ID
          version int 目录版本号

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          version int data 版本号

          示例:

          {
              "data":{"version":1},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          6.3 目录删除

          版本:(since 5.4)

          1.接口地址: (POST) {IP}:{PORT}/open/v1/directory/delete

          1. 入参(需生成JSON字符串并放入请求的body中)
          参数名 类型 是否可空 备注
          id string 目录ID

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          6.4 目录列表

          版本:(since 5.4)

          1.接口地址:(GET) {IP}:{PORT}/open/v1/directory
          2.入参(写入param中) 无 3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data list 返回数据
          id string data 目录ID
          name string data 目录名称
          parentId string data 父节点ID
          sort int data 排序顺序
          version int data 版本号
          hasPerm int data 是否具有权限

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"",
              "data":[
                      {   
                          "id":"008ac842-082f-4492-b765-f12d19bf1fd5",
                          "name": "一级目录",
                          "hasPerm": 1,   
                          "parentId": "00e01f9a-7ea3-401c-a8a0-8d8aee42fd44",
                          "sort": 1, 
                          "version": 1,
           
                      },
                      ······
                  ]
          }

          7. 渠道

          7.1 渠道维度

          7.1.1 渠道维度创建

          版本:(since 6.0)

          1.接口地址:(POST) {IP}:{PORT}/open/v2/channel/dimension/create

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 备注
          name string 维度名称,2~50个字符,只能包含中英文、数字和下划线
          code string 维度编码,2~50个字符,只能包含英文、数字和下划线,且不能以数字开头
          description string 维度描述,1~100个字符
          inherit int 是否继承上一级答案,0-不继承;1-继承

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          id string data 渠道ID

          示例:

          {
              "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.1.2 渠道维度更新

          版本:(since 6.0)

          1.接口地址:POST {IP}:{PORT}/open/v2/channel/dimension/update

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 备注
          id string 维度ID
          name string 维度名称,2~50个字符,只能包含中英文、数字和下划线
          description string 维度描述,1~100个字符
          inherit int 是否继承上一级答案,0-不继承;1-继承
          version int 维度版本号

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          version int data 维度更新后版本号

          示例:

          {
              "data":{"version":1},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.1.3 渠道维度删除

          版本:(since 6.0)

          1.接口地址:(POST) {IP}:{PORT}/open/v2/channel/dimension/delete

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 备注
          id string 维度ID

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据

          示例:

          {
              "data":null,
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.1.4 渠道维度优先级更新

          版本:(since 6.0)

          1.接口地址:(POST) {IP}:{PORT}/open/v2/channel/dimension/priority/update

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 父节点 备注
          list list 维度列表
          id string list 渠道维度ID
          priority int list 渠道维度优先级。所有列表中优先级的数值,需为从1开始的连续正整数,不能有重复,不能有断层。元素的数量需与已经创建的维度数量保持一致。
          version int list 维度版本号

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据

          示例:

          {
              "data":null,
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.1.5 渠道维度列表

          版本:(since 6.0)

          1.接口地址:(GET) {IP}:{PORT}/open/v2/channel/dimension
          2.入参(写入param中)

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          list list data 数据列表
          id string list 维度ID
          name string list 维度名称
          code string list 维度编码
          description string list 维度描述
          inherit int list 未设置答案时,是否继承上一级答案,0-不继承;1-继承
          priority int list 渠道维度优先级
          created string list 创建时间
          update string list 修改时间
          version int list 版本号

          示例:

          {
              "code":200,
              "time":1568274632887,
              "msg":"新建模板成功",
                   "data":{
                            "list":[{
                                    "id": "9e8b8efe-ba54-4e02-b03d-34b2db33b960",
                                    "name": "维度1",
                                    "code": "code1",
                                    "description": "描述",
                                    "inherit":  1,
                                    "priority": 1,
                                    "created": "2020-04-10 11:43:29",
                                    "updated": "2020-04-10 11:43:29",
                                    "version": 0}
                            ]
                   }

          7.2 渠道维度值

          7.2.1 渠道维度值创建

          版本:(since 6.0)

          1.接口地址:(POST) {IP}:{PORT}/open/v2/channel/dimension/value/create

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 备注
          name string 维度值名称,只能存在中英文,数字和下划线,2~50个字符
          code string 维度值编码,只能存在英文,数字和下划线,且不能以数字开头,2~50个字符
          parentId string 父维度值ID
          dimensionId string 渠道维度ID

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          id string data 渠道ID

          示例:

          {
              "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.2.2 渠道维度值更新名称

          版本:(since 6.0)

          1、接口地址:{IP}:{PORT}/open/v2/channel/dimension/value/update

          2、入参(需生成JSON字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 维度值ID
          responseType int 维度值名称,只能有中英文,数字和下划线组成,2~50个字符
          version int 版本号

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          version int data 更新后版本号

          示例:

          {
              "data":{"version":1},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.2.3 渠道维度值删除

          版本:(since 6.0)

          1、接口地址:(POST) {IP}:{PORT}/open/v2/channel/dimension/value/delete

          2、入参(需生成JSON字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 维度值ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据

          示例:

          {
              "data":null,
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.2.4 渠道维度值列表

          版本:(since 6.0)

          1.接口地址:(GET) {IP}:{PORT}/open/v2/channel/dimension/value
          2.入参(写入param中)

          参数名 类型 是否可空 备注
          dimensionId string 渠道维度id

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          list list data 数据列表
          id string list 维度值ID
          name string list 维度值名称
          code string list 维度值编码
          dimensionId string list 维度ID
          parentId string list 父维度值Id
          created string list 创建时间
          updated string list 更新时间
          version int list 维度值版本号

          示例:

          {
              "code":200,
              "time":1568257385194,
              "msg":"OK"
              "data":{
                  "list": [
                          {
                             "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
                             "name": "中国",
                             "code": "CHINA_",
                             "dimensionId": "75b70de8-cd61-49cb-9465-0b2e940ebff4",
                             "parentId": "",
                             "created": "2019-07-24 19:22:57",
                             "updated": "2019-07-24 19:23:29",
                             "version": 0  
                         }, 
                         {
                             "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
                             "name": "湖北",
                             "code": "XXXXXXX",
                             "dimensionId": "75b70de8-cd61-49cb-9465-0b2e940ebff4",
                             "parentId": "0849962b-7622-4cc6-9928-d1186784f8f7",
                             "created": "2019-07-24 19:22:57",
                             "updated": "2019-07-24 19:23:29",
                             "version": 0  
                         }
                  ]
              }
          }

          7.2.5 渠道维度值列表(Agent级别)

          版本:(since 6.0)

          1.接口地址:(GET) {IP}:{PORT}/open/v2/channel/dimension/value/all
          2.入参(写入param中)

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          list list data 数据列表
          dimension string data 维度名称
          values list data 维度值列表
          id string list 维度值ID
          name string list 维度值名称
          code string list 维度值编码
          dimensionId string list 维度ID
          parentId string list 父维度值Id
          created string list 创建时间
          updated string list 更新时间
          version int list 维度值版本号

          示例:

          {
              "code":200,
              "time":1568257385194,
              "msg":"OK"
              "data":{
                  "list": [
                  {
                       "dimension": "地域",
                       "values":[
                       {
                             "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
                             "name": "中国",
                             "code": "CHINA_",
                             "dimensionId": "75b70de8-cd61-49cb-9465-0b2e940ebff4",
                             "parentId": "",
                             "created": "2019-07-24 19:22:57",
                             "updated": "2019-07-24 19:23:29",
                             "version": 0  
                       }, 
                       {
                             "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
                             "name": "湖北",
                              "code": "XXXXXXX",
                             "dimensionId": "75b70de8-cd61-49cb-9465-0b2e940ebff4",
                             "parentId": "08499622b-7622-4cc6-9928-d1186784f8f7",
                             "created": "2019-07-24 19:22:57",
                             "updated": "2019-07-24 19:23:29",
                             "version": 0  
                       }] 
                  }]
              }
          }

          7.3 特殊渠道值

          7.3.1 特殊渠道值创建

          版本:(since 6.0)

          1.接口地址:(POST) {IP}:{PORT}/open/v2/channel/special/value/create

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 父节点 备注
          dimensionValueList List 维度值CODE列表。列表中的元素需按agent级别渠道维度值列表中的维度顺序排序,每个code需要排在它所在的维度的位置上。当元素为"defult_code"时表示该维度上选择"默认"。在列表中,"defult_code"只能排列在其他非默认的维度值的后面。当出现第一个"default_code"后,后面的元素都默认为"default_code"。当传入数量少于当前维度数量时,剩余的都将默认填充为"default_code"。不允许全部都为"default_code"。
          code string dimensionValueList 维度值编码
          status int 特殊渠道值状态 0:上线 1:下线
          responseType int 无答案时回复内容 0: 无答案 1:通用答案

          示例:

          {
              "dimensionValueList": [{"code": "CODE1"}, {"code": "CODE2"}],
              "status": 0,
              "responseType": 1
          }

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          id string data 渠道ID

          示例:

          {
              "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.3.2 特殊渠道值更新

          版本:(since 6.0)

          1.接口地址:(POST) {IP}:{PORT}/open/v2/channel/special/value/update

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 父节点 备注
          id string 特殊渠道值ID
          dimensionValueList List 维度值CODE列表。列表中的元素需按agent级别渠道维度值列表中的维度顺序排序,每个code需要排在它所在的维度的位置上。当元素为"defult_code"时表示该维度上选择"默认"。在列表中,"defult_code"只能排列在其他非默认的维度值的后面。当出现第一个"default_code"后,后面的元素都默认为"default_code"。当传入数量少于当前维度数量时,剩余的都将默认填充为"default_code"。不允许全部都为"default_code"。
          code string dimensionValueList 维度值编码
          status int 特殊渠道值状态 0:上线 1:下线
          responseType int 无答案时回复内容 0: 无答案 1:通用答案
          version int

          示例:

          {
          		"id": "c86fe5a5-df76-4807-aba0-1e07609fc5fc",
              "dimensionValueList": [{"code": "CODE1"}, {"code": "CODE2"}],
              "status": 0,
              "responseType": 1,
              "version": 0
          }

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据
          version string data 更新后的版本号

          示例:

          {
              "data":{"version": 1},
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.3.3 特殊渠道值删除

          版本:(since 6.0)

          1.接口地址:(POST) {IP}:{PORT}/open/v2/channel/special/value/delete

          2.入参(需生成JSON字符串并放入请求的body中)

          参数名 类型 是否可空 备注
          id string 特殊渠道值ID

          示例:

          {
          		"id": "c86fe5a5-df76-4807-aba0-1e07609fc5fc"
          }

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data map 返回数据

          示例:

          {
              "data":null,
              "code":200,
              "time":1568274632887,
              "msg":"OK"
          }

          7.3.4 特殊渠道值列表

          版本:(since 6.0)

          1、接口地址:(GET) {IP}:{PORT}/open/v2/channel/special/value

          2、入参(写入到param中)

          参数名 类型 是否可空 备注
          pn int 当前页数
          ps int 每页数量
          channel string 筛选code组合,将需要筛选的code按维度创建顺序以“,”隔开

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 数据数量
          ps int data 每页数量
          pn int data 当前页数
          list list data 数据列表
          id string list 特殊渠道值ID
          dimensionValueList list list 渠道维度值列表
          dimensionName string dimensionValueList 渠道维度名称
          dimensionCode string dimensionValueList 渠道维度编码
          name string dimensionValueList 渠道维度值名称
          code string dimensionValueList 渠道维度值编码
          status int list 渠道状态标识,0-上线;1-下线
          responseType int list 无答案时回复内容 0: 无答案 1:通用答案
          version int list 版本号

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"OK",
              "data":{
              		"total": 1,
              		"pn": 0,
              		"ps", 20,
              		"list":[
              				{
              						"id": "00ace67f-43c4-43e0-a7fa-b436af338d99",
              						"dimensionValueList": [
              								{
              										"dimensionName": "地域",
              										"dimensionCode": "DOMAIN_",
              										"name": "中国",
              										"code": "CHINA_"
              								}
              						],
              						"status": 0,
              						"responseType": 1,
              						"version": 0
              				}
              		]
              }
          }

          8. 文档库

          8.1 文档库新建

          版本:(since 5.4)

          1、接口地址:(POST) {IP}:{PORT}/open/v1/document/create 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 父节点 备注
          dirId string 目录id
          title string 标题
          richText string 富文本数据
          plainText string 纯文本数据【如果有富文本的情况下,需要把富文本中的纯文字提取出来,放到这个字段中;如果富文本中包含图片,纯文本中需要加"[图片]",以支持图片检索和搜索的显示】
          attaches list 关联的附件列表
          uid string attaches 附件上传者id
          username string attaches 附件上传者名称
          url string attaches 地址
          name string attaches 名称
          key string attaches 获取预览地址时使用
          size string attaches 文件大小
          faqs list< string> 关联标准问的id列表
          tags list< string> 标签列表
          linkNum int 链接数【页面展示用】
          pictureNum int 图片数【页面展示用】
          wordNum int 文档字符数(如果richText不为空,则此字段必传,数量为richText去掉标签和空格后所剩长度)

          示例

          POST /open/v{versionId}/document/create
          {
          	"dirId": "0",
          	"richText": "<p>文档库内容<a href=\"http://www.xxxx.com\" target=\"_blank\">www.xxxx.com</a></p>",
          	"plainText": "文档库内容www.xxxx.com",
          	"title": "文档库测试",
          	"attaches": [{
          		"url": "http://127.0.0.1:8888/api/v2/file/download?key=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
          		"name": "测试图.jpg",
          		"key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
          		"size": 23663,
          	}],
          	"faqs": ["id1"],
          	"tags": ["标签1", "标签2"],
          	"wordNum": 17,
          	"pictureNum": 0,
          	"linkNum": 1
          }

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data 文档库ID

          8.2 文档库更新

          版本:(since 5.4)

          1、接口地址:(POST) {IP}:{PORT}/open/v1/document/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 父节点 备注
          id string 文档id
          contentVersion string 内容版本号
          dococEditStatus short 更新状态,0表示未正在编辑,1表示正在编辑
          dirIds string 目录id
          title string 关联的标题(如果未更改标题,则传入原标题)
          richText string 富文本数据
          plainText string 纯文本数据【如果有富文本的情况下,需要把富文本中的纯文字提取出来,放到这个字段中。纯文本不可单独存在】
          attaches list 关联的附件列表
          uid string attaches 附件上传者id
          username string attaches 附件上传者名称
          url string attaches 地址
          name string attaches 名称
          key string attaches 获取预览地址时使用
          size string attaches 文件大小
          faqs list< string> 关联标准问的id列表
          tags list< sring> 标签列表
          linkNum int 链接数【页面展示用】
          pictureNum int 图片数【页面展示用】
          wordNum int 文档字符数(如果richText不为空,则此字段必传,数量为richText去掉标签和空格后所剩长度)

          请求示例

          POST /open/v{versionId}/document/update
          {
          	"attaches": [{
          		"url": "http://127.0.0.1:8080/api/v2/file/downloadkey=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
          		"name": "测试图.jpg",,
          		"size": 23663,
          		"key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw=="
          	}],
          	"contentVersion": 0,
          	"dirId": "0",
          	"docEditingStatus": 2,
          	"faqs": ["id1"],
          	"id": "xxxxxxxxxxxxxxxxxxx",
          	"linkNum": 1,
          	"pictureNum": 1,
          	"richText": "<p>文档库内容<a href=\"http://www.xxxx.com\" target=\"_blank\">www.xxxx.com</a><img src=\"http://cp01-mk-se0.epc.baidu.com:8499/api/v2/file/download?key=Ym9zX2E1ZDczZWQ3LTgzNWEtNDJkNy05NzBmLWUwZjM1MThmMDc1Nw==\" style=\"\"></p>",
          	"tags": ["标签1", "标签2"],
          	"title": "文档库测试更新",
          	"wordNum": 17,
          	"plainText": "文档库内容www.xxxx.com[图片]"
          }

          3.返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          contentVersion int 文档内容版本

          8.3 文档库删除

          版本:(since 5.4)

          1、接口地址:(POST) {IP}:{PORT}/open/v1/document/delete 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id String 文档库ID

          3、返回值

          参数名 类型可空 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T --- 返回数据

          8.4 文档库搜索

          版本:(since 5.4)

          1、接口地址:(GET) {IP}:{PORT}/open/v1/document/search 2、入参(写入到param中)

          参数名 类型 是否可空 备注
          keyword string 关键词
          ps int 页面大小【默认20】
          pn int 页码【默认1】

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 当前页数
          ps int data 每页数量
          list list data 数据列表
          id string list 文档ID
          agendId string list 文档ID
          title string list 文档标题
          plainText string list 富文本内容
          updated string list 更新时间
          tags list< string> list 标签列表
          dirId string list 目录id

          示例:

          {
              "time":1571137306169,
              "data":{
                  "total":1,
                  "ps":20,
                  "list":[
                      {
                          "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
                          "plainText":"富文本的回答内容。表头<aicp_em_highlight>1</aicp_em_highlight>表头2回答<aicp_em_highlight>1</aicp_em_highlight>回答2[图片]链接地址www",
                          "dirId":"ff7c8a87-420e-499b-afdf-27ff0040c317",
                          "id":"617d60e1-c05c-48c4-a3f7-ceacd2eb0a01",
                          "title":"<aicp_em_highlight>文档</aicp_em_highlight><aicp_em_highlight>库</aicp_em_highlight><aicp_em_highlight>1</aicp_em_highlight>",
                          "lastEditTime":"2019-10-15 17:26:36",
                          "lastEditUserId":"32500597715",
                          "lastEditUsername":"aicp",
                          "updated":"2019-10-15 17:26:36",
                          "tags":[
                              "标签1",
                              "标签2",
                              "标签3",
                              "标签4"
                          ]
                      }
                  ],
                  "pn":1
              },
              "code":200,
              "msg":"OK"
          }

          8.5 文档库列表

          版本:(since 5.4)

          1、接口地址:(GET) {IP}:{PORT}/open/v1/document 2、入参 (写入到param中)

          参数名 类型 是否可空 备注
          dirId string 目录ID
          title string 关联的标题
          keyword string 关键字
          tagKeyword string 标签关键字标签关键字(与keyword联合使用。当keyword与tagKeyword同时存在时,标题,纯文本,附件按keyword搜索,标签按tagKeyword搜索。tagKeyword单独存在不生效)
          pn int 查询页数,默认为1
          ps int 每页数据条数,默认为20
          order string 排序顺序("desc"为降序,“asc为升序”)
          orderBy string 以何字段排序,候选值为“created_username”和“title”

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 当前页数
          ps int data 每页数量
          list list data 数据列表
          id string list 文档ID
          title string list 文档标题
          lastEditTime string list 最后编辑时间戳
          lastEditUsername string list 最后修改人名称
          updated string list 修改时间戳

          示例:

          {
              "code":200,
              "time":1568257385194,
              "msg":"OK"
              "data":{
                  "total":1,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                       "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
                       "title": "这是一个文档",
                       "lastEditTime": "2019-11-05 11:36:38",
                       "lastEditUsername": "MOCK_USER_NAME",
                       "updated": "2019-11-05 11:36:38" 
                      } 
              },   
          }

          8.6 文档库详情

          版本:(since 5.4)

          1、接口地址: (GET) {IP}:{PORT}/open/v1/document/detail
          2、入参(写入到param中)

          参数名 类型 是否可空 备注
          id string 文档库ID
          action string 当前动作。(如果传值为“edit”,则表示是编辑类型的详情查询,则需要登记编辑状态和账户信息,其他值不生效)
          log string log类型。(如果值为"statistics",则使用静态操作记录,其他值不生效)

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data 文档ID
          contentVersion int data 内容的version;原来的version用于判断目录的变更;
          created string data 创建时间
          createdUsername string data 创建者用户名
          dirId string data 目录ID
          version int data 版本号
          docEditingStartTime string data 文档编辑开始时间
          docEditingStatus short data 文档编辑状态
          docEditingUserid string data 文档编辑者用户ID
          docEditingUsername string data 文档编辑者用户名
          faqs list data faqID列表
          lastEditTime string data 最近一次编辑时间
          lastEditUsername string data 最近一次编辑者用户名
          linkNum int data 链接数量
          overtime int data 超时次数
          pictureNum int data 图片数量
          richText string data 富文本
          tags list data 标签列表
          title string data 标题
          wordNum int data 字数
          attaches list data 附件
          url string attaches 附件url
          name string attaches 附件名称
          originAddress string attaches 原始地址
          originFile string attaches 原始文件
          size int attaches 文件大小
          key string attaches 预览地址使用的键
          uid string attaches 用户ID
          username string attaches 用户名称
          time long attaches 毫秒级时间戳
          created string attaches 创建日期

          示例:

          {
              "code":200,
              "time":1567998660176,
              "msg":"",
              "data":{
                  "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
                  "contentVersion": 0,
                  "created": "2019-07-22 17:52:09",  
                  "createdUsername": "MOCK_USER_NAME",
                  "dirId": "8034e73a-16e9-4d8e-b61f-33b1eff858d4",
                  "docEditingStartTime": "",
                  "docEditingStatus": 0,
                  "docEditingUserId": "MOCK_USER_ID",
                  "docEditingUserName": "MOCK_USER_NAME",
                  "faqs":["23084a68-b7b9-43c8-b014-194fa2348b29"],
                  "lastEditTime": "2019-07-16 11:02:22",
                  "lastEditUserName": "MOCK_USER_NAME",
                  "linkNum": 0,
                  "overtime": 0,
                  "pictureNum": 0,
                  "richText": "<p><span style="background-color: rgb(255, 255, 0);">test</span></p>",
                  "tags": ["测试", "文档"],
                  "title": "这是一个文档",
                  "version": 0,
                  "wordNum": 200,
                  "attaches": [
                      {                "url":"http://cp01mkse0.epc.baidu.com:8499/api/v2/file/downloadkey=Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
                          "name": "我的文档.xlsx",
                          "originAddress": "http://cp01-mk-se0.epc.baidu.com:8499/api/v2/file/download?key=Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
                          "originFile": "我的文档.xlsx",
                          "size": 200,
                          "key": "Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
                          "uid": "MOCK_USER_NAME",
                          "username": "MOCK_USER_ID",
                          "time": 1563417098146,
                          "created": "2019-11-25 22:31:43"	
                      },
                      ......
               
                  ]
              }
          }

          9. 意图

          9.1 意图不响应

          9.1.1 意图不响应问题列表

          版本:(since 5.6)

          1、接口地址: (GET) {IP}:{PORT}/open/v1/intent/noresp 2、入参

          参数名 类型 是否可空 备注
          keyword string 问题关键字
          pn int 页码,默认为1
          ps int 每页数据条数,默认为10

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 意图不响应问题id
          question string list 意图不响应问题
          agentId string list agent ID
          lastModifyUser string list 最后一次修改的用户
          createUser string list 创建者用户
          created string list 创建时间
          updated string list 最后修改时间
          version int list 版本号

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"",
          	"data":{
          		"total": 245,
          		"pn": 1,
          		"ps": 10,
          		"list": [
          			{	
          				"id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
          				"question": "一个问题",
          				"agentId": "53639538-1519-4a0b-bcfd-a6ee8f970173",
          				"lastModifyUser": "user1",
          				"createUser": "user1",
          				"created": "2019-07-22 17:52:09",	
          				"updated": "2019-07-22 17:52:09",
          				"version": 1,
          			},
          			······
          		]
          	}
          }

          9.1.2意图不响应问题删除

          版本:(since 5.6)

          1、接口地址: (POST) {IP}:{PORT}/open/v1/intent/noresp/delete 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图不响应问题ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.1.3 意图不响应问题创建

          版本:(since 5.6)

          1、接口地址: {IP}:{PORT}/open/v1/intent/noresp/create 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          question string 意图不响应问题

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          id string id

          示例:

          {
          	"code":200,
          	"data":{"id":"xxxxx"},
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.1.4 意图不响应问题更新

          版本:(since 5.6)

          1、接口地址: (POST) {IP}:{PORT}/open/v1/intent/noresp/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图不响应问题ID
          question string 意图不响应问题
          version string 意图不响应问题版本

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          version int 版本号

          示例:

          {
          	"code":200,
          	"data":{"version":1},
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.2 意图模板

          9.2.1 意图模板列表

          版本:(since 5.6)

          1、接口地址: (GET) {IP}:{PORT}/open/v1/intent/template 2、入参

          参数名 类型 是否可空 备注
          intentId string 意图ID
          keyword string 意图关键字
          pn int 页码,默认为1
          ps int 每页数据条数,默认为10

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 意图id
          template string list 意图模板
          updated string list 最后更新时间
          created string list 创建时间
          intentId string list 意图ID
          version int list 意图模板版本号

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"",
          	"data":{
          		"total": 245,
          		"pn": 1,
          		"ps": 10,
          		"list": [
          			{	
          				"id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
          				"template": "模板",
          				"created": "2019-07-22 17:52:09",	
          				"updated": "2019-07-22 17:52:09",
          				"intentId": "1fe0ed0f-6e4a-45a4-bdf8-78928f58519c",
                  "version": 0
          			},
          			······
          		]
          	}
          }

          9.2.2 意图模板删除

          版本:(since 5.6)

          1、接口地址: (POST) {IP}:{PORT}/open/v1/intent/template/delete 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图模板ID
          intentId string 意图ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.2.3 意图模板新建

          版本:(since 5.6)

          1、接口地址: (POST) {IP}:{PORT}/open/v1/intent/template/create 2、说明:用于意图模板的新建 3、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          template string 意图模板
          intentId string 意图ID

          4、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          id string id

          示例

          	"data":{"id":"xxxxxxx"},
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.2.4 意图模板更新

          版本:(since 5.6)

          1、接口地址: (POST) {IP}:{PORT}/open/v1/intent/template/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图模板ID
          template string 意图模板
          intentId string 意图ID
          version int 意图模板版本号

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          version int data 更新后意图模板版本号
          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
            "data":
               {
                   "version":1
               }
           }

          9.3 意图示例

          9.3.1 意图示例修改

          版本:(since 5.6)

          1、接口地址:(POST) {IP}:{PORT}/open/v1/intent/example/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图示例Id
          intentId string 意图id【数据存储Id】
          value String 意图示例修改值
          version int 版本号

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          version int 版本信息

          示例:

          {
             
              "data":{"version":1},
              "code":4002801,
              "time":1568613825147,
              "msg":"编辑意图示例成功"
          }

          9.3.2 意图示例列表

          版本:(since 5.6)

          1、接口地址:GET {IP}:{PORT}/open/v1/intent/example 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          intentId string 意图Id
          ps int 页面大小【默认是10】
          pn int 页码【默认是1】
          keyword string 搜索关键词

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data object 数据
          list list data 数据列表
          id string list 意图示例id
          value string list 意图示例示例值
          updated string list 更新时间
          created string list 创建时间
          intentId string list 意图Id
          agentId string list agentId
          version int list 版本号

          示例:

          {
              "time":1572334765237,
              "data":{
                  "total":2,
                  "ps":10,
                  "list":[
                      {
                          "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
                          "created":"2020-03-20 18:57:41",
                          "intentId":"6dfe3f25-2a51-4928-9bf1-ac360abf992a",
                          "id":"fa6893b6-befc-472e-9e88-2a63a4dc8c4e",
                          "value":"智能客服",
                          "version":1,
                          "updated":"2020-03-20 18:57:41"
                      },
                      {
                          "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
                          "created":"2020-03-20 18:57:41",
                          "intentId":"6dfe3f25-2a51-4928-9bf1-ac360abf992a",
                          "id":"ceeca60d-44d0-4234-8ea7-7e9fd06ab090",
                          "value":"智能秘书",
                          "version":1,
                          "updated":"2020-03-20 18:57:41"
                      }
                  ],
                  "pn":1
              },
              "code":200,
              "msg":"OK"
          }

          9.3.3 意图示例创建

          版本:(since 5.6)

          1、接口地址:(POST) {IP}:{PORT}/open/v1/intent/example/create 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          example string 意图示例
          intentId string 意图id【数据存储ID】

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          id string data id

          示例:

          {
              "code":4002801,
              "time":1568613825147,
              "msg":"新建意图示例成功",
              "data":{"id":"xxxxx"}
          }

          9.3.4 意图示例删除

          版本:(since 5.6)

          1、接口地址:POST {IP}:{PORT}/open/v1/intent/example/delete 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图示例id
          intentId string 意图id【数据存储ID】

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息

          示例:

          {
              "code":4002801,
              "time":1568613825147,
              "msg":"删除意图示例成功"
          }

          9.4 用户意图

          9.4.1 用户意图列表

          版本:(since 5.6)

          1、接口地址: (GET) {IP}:{PORT}/open/v1/user/intent 2、入参

          参数名 类型 是否可空 备注
          keyword string 意图关键字
          pn int 页码,默认为1
          ps int 每页数据条数,默认为20

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总大小
          pn int data 查询页数
          ps int data 每页大小
          list list data 数据列表
          id string list 意图id
          name string list 意图名称
          description string list 意图描述
          updated string list 最后更新时间
          created string list 创建时间
          agentId string list agentID
          alias string list 意图别名
          nameZh string list 意图中文名称
          version int list 版本号
          createdUserId string list 创建者id
          createdUsername string list 创建者
          lastEditUsername string list 最后编辑者名称
          lastEditUserId string list 最后编辑者id

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"",
          	"data":{
          		"total": 245,
          		"pn": 1,
          		"ps": 10,
          		"list": [
          			{	
          				"id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
          				"name": "intent__name",
          				"created": "2019-07-22 17:52:09",	
          				"updated": "2019-07-22 17:52:09",
          				"description": "意图描述",
          				"agendId": "1fe0ed0f-6e4a-45a4-bdf8-78928f58519c",
          				"alias": "别名",
          				"nameZh": " 中文名称",
          				"version": 1,
                  "createdUserId": "32500597715",
                  "createdUsername": "aicp",
                  "lastEditUsername": "aicp",
                  "lastEditUserId": "32500597715",
          			},
          			······
          		]
          	}
          }

          9.4.2 用户意图删除

          版本:(since 5.6)

          1、接口地址: (POST) {IP}:{PORT}/open/v1/user/intent/delete 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.4.3 用户意图新建

          版本:(since 5.6)

          1、接口地址:(POST) {IP}:{PORT}/open/v1/user/intent/create
          2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          name string 意图名称
          nameZh string 意图中文名称
          alias string 意图别名
          description string 描述

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          id string data id信息

          示例:

          {
          	"data":{"id":"xxxxxxx"}
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.4.4 用户意图更新

          版本:(since 5.6)

          1、接口地址: (POST) {IP}:{PORT}/open/v1/user/intent/update 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 意图ID
          name string 意图名称
          nameZh string 意图中文名称
          alias string 意图别名(多个别名以“,”隔开)
          description string 描述
          version int 版本号

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据信息
          version int data 版本号

          示例:

          {
          	"data":{"version": 1},
          	"code":200,
          	"time":1567998660176,
          	"msg":"OK",
           }

          9.4.5 用户意图详情

          版本:(since 5.6)

          1、接口地址: (GET) {IP}:{PORT}/open/v1/user/intent/detail 2、入参(写入到param中)

          参数名 类型 是否可空 备注
          id string 意图ID

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data 意图id
          name string data 意图名称
          description string data 意图描述
          alias string data 意图别名
          nameZh string data 意图中文名称

          示例:

          {
          	"code":200,
          	"time":1567998660176,
          	"msg":"",
          	"data":{
                         "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
                          "name": "intent__name",
                          "description": "意图描述",
                          "alias": "别名",
                          "nameZh": " 中文名称"
          	}
          }

          9.5 系统意图

          9.5.1 系统意图列表

          版本:(since 5.6)

          1、接口地址:(GET) {IP}:{PORT}/open/v1/sys/intent 2、入参(query param)

          参数名 类型 是否可空 备注
          ps int 页面大小【默认20】

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data object 数据
          total int data 数据总量
          ps int data 页面大小
          pn int data 页码
          list list data 数据列表
          agentId string list agentId
          created long list 创建时间戳
          nameZh string list 意图中文名称
          intro string list 系统意图示例,类似这些对话会被识别为该意图,以“\x01”分割
          name string list 意图ID
          description string list 意图描述
          id string list 数据存储id
          updated string list 数据更新时间戳
          addedSystem boolean list 当前agent是否已启用该系统意图

          示例:

          {
          
              "time":1572255991674,
          
              "data":{
                  "total":6,
                  "ps":20,
                  "list":[
                      {
                          "agentId":"sys_agent_id",
                          "created":"",
                          "nameZh":"挂断意图",
                          "intro":"挂断 \x01exit",
                          "name":"sys_exit",
                          "description":"挂断意图",
                          "id":"sys_intent_9",
                          "updated":""
                      },
                      {
                          "agentId":"sys_agent_id",
                          "addedSystem":true,
                          "created":1560280513000,
                          "nameZh":"转人工意图",
                          "intro":"转人工",
                          "name":"sys_manual_service",
                          "description":"转人工意图",
                          "id":"sys_intent_7",
                          "updated":""
                      }
                  ],
                  "pn":1
              },
          
              "code":200,
          
              "msg":"OK"
          
          }

          9.5.2 系统意图失效

          版本:(since 5.6)

          1、接口地址:POST {IP}:{PORT}/open/v1/sys/intent/disable 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 系统意图id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息

          示例:

          {
              "code":200,
              "time":1568613825147,
              "msg":"禁用系统意图成功"
          }

          9.5.3 系统意图生效

          版本:(since 5.6)

          1、接口地址:POST {IP}:{PORT}/open/v1/sys/intent/enable 2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 系统意图id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息

          示例:

          {
              "code":200,
              "time":1568613825147,
              "msg":"启动系统意图成功"
          }

          9.5.4 系统意图详情

          版本:(since 5.6)

          1、接口地址:GET {IP}:{PORT}/open/v1/sys/intent/detail 2、入参(query param)

          参数名 类型 是否可空 备注
          intentId int 意图Id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data object 数据
          nameZh string data 意图中文名称
          intro string data
          name string data 意图ID
          description string data
          id string data 数据存储id

          示例:

          {
              "time":1572264401019,
              "data":{
                  "enable":true,
                  "nameZh":"挂断意图",
                  "intro":"挂断 \x01exit",
                  "name":"sys_exit",
                  "description":"挂断意图",
                  "id":"sys_intent_9"
              },
              "code":200,
              "msg":"OK"
          }

          10 统计

          10.1 高频意图和FAQ统计协议

          版本:(since 5.6)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/statistics

          2、入参 (json 格式放到body里面)

          参数名 类型 是否可空 备注
          startDate string 开始时间
          endDate string 结束时间
          botId string[] botId 数组
          type string 类型:intentTop:高频意图 ;faqTop:高频faq

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long | 时间
          msg string | 状态信息
          data T 数据
          intentTops list data 高频意图数据列表
          count int intentTops 数量
          intentName string intentTops 意图名称
          intentId string intentTops 意图Id
          faqTops list data 高频faq数据列表
          count int faqTops 数量
          faqId string faqTops faqId
          question string faqTops 问题

          示例:

          {
          	"time": 1582256123243,
          	"data": {
          		"intentTops": [{
          			"count": 1,
          			"intentName": "",
          			"intentId": "kpxxcc"
          		}],
          		"faqTops": [{
          			"count": 1,
          			"faqId": "678708ab-a8b8-4a5e-aa04-ec988ddf85c7",
          			"question": "北京"
          		}]
          	},
          	"code": 200,
          	"msg": "OK"
          }

          10.2 会话历史详情

          版本:(since 6.0)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}//conversation/history/detail

          2、入参

          参数名 类型 是否可空 备注
          sessionId string 对话id
          pn int 页码
          ps int 页面大小

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据
          list list data 数据列表
          queryText string list 用户问题
          suggestAnswer string list 意图名称
          queryTime string list 查询时间
          confidence list list 置信度
          source int list 来源
          kg: 知识图谱对话;
          faq:问答式对话;
          task_based:任务式对话
          chitchat:闲聊式对话;
          clarify:澄清;
          none:未匹配;system:系统指令,静默、打断、挂机、停用
          faqId string list faqId
          question string list 问题

          示例:

          {
              "time": 1587452955688,
              "data": {
                  "total": 2,
                  "pn": 1,
                  "ps": 30,
                  "list": [
                      {
                          "queryText": "",
                          "suggestAnswer": "",
                          "confidence": 0.0,
                          "queryTime": "2020-04-21 14:52:22",
                          "solved": true,
                          "source": "system",
                          "welcome": "您好,很高兴为您服务!",
                          "qaRecommend": [],
                          "vad": "",
                          "clarifyQuestions": {}
                      },
                      {
                          "queryText": "租车",
                          "suggestAnswer": "抱歉,我不太理解您的意思",
                          "confidence": 0.0,
                          "queryTime": "2020-04-21 14:52:26",
                          "solved": false,
                          "source": "none",
                          "welcome": "",
                          "qaRecommend": [],
                          "vad": "",
                          "clarifyQuestions": {}
                      },
                      {
                          "queryText": "百度",
                          "suggestAnswer": "",
                          "confidence": 0.0,
                          "queryTime": "2020-04-21 15:36:27",
                          "solved": true,
                          "source": "clarify",
                          "welcome": "",
                          "qaRecommend": [],
                          "vad": "",
                          "clarifyQuestions": {
                              "voice": {
                                  "questions": [
                                      "请问您想问的是百度公司吗?"
                                  ],
                                  "content": "请问您想问的是百度公司吗?"
                              },
                              "text": {
                                  "questions": [
                                      "百度公司"
                                  ],
                                  "title": "请问您想咨询的是?"
                              }
                          }
                        
                      }
                  ]
              },
              "code": 200,
              "msg": "OK"
          }

          11.文件服务

          11.1 文件上传服务

          版本:(since 5.6)

          1、接口地址:POST {IP}:{PORT}/open/{versionId}/file/upload

          2、入参(放到请求的body中,form-data格式)

          参数名 类型 是否可空 父节点 备注
          file file 文件

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data object 返回数据
          url string 上传的文件地址
          key string 文件key值

          示例:

          {
              "time":1572838587049,
              "data":{
                  "url":"http://localhost:8080/api/v2/file/download?key=xxxxxxxx",
          
                  "key":"xxxxxxxxxxxxxxx"
              },
              "code":200,
              "msg":"OK"
          }

          12.实体

          12.1 系统实体

          12.1.1系统实体列表

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/sys/entity 2、入参【请求的param中】

          参数名 类型 是否可空 备注
          ps int 页面大小[默认20]
          pn int 页码

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          list list data 数据列表
          ps int list 页面大小
          pn int list 页码
          sysEntityId string list 系统实体id
          name string list 实体名称
          nameZh string list 实体中文名
          description string list 描述
          intro string list 示例

          示例:

          {
              "time":1590412948169,
              "data":{
                  "total":27,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                          "sysEntityId":"05dc9f87-5e4d-408b-a75d-2894eac69f14",
                          "name":"sys_money_range",
                          "nameZh":"货币范围实体",
                          "description":"货币范围实体",
                          "openConfigure":false,
                          "intro":"五六百 \x01 一万八九 \x01 4000到5000"
                      },
                      {
                          "sysEntityId":"0b1702d2-b908-4e13-94e5-9ba449afd354",
                          "name":"sys_money",
                          "nameZh":"货币实体",
                          "description":"货币实体",
                          "openConfigure":false,
                          "intro":"人民币500 \x01 二十元5角  \x01 $20k \x01 15块3"
                      }
                  ]
              },
              "code":200,
              "msg":"OK"
          }

          12.1.2 系统实体启用

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/sys/entity/enable

          2、入参(请求的body中)

          参数名 类型 是否可空
          sysEntityId string

          3、返回值

          参数名 类型 父节点
          code int
          time long
          msg string
          data T

          示例:

          {
              "time":1590412948169,
              "data":null,
              "code":200,
              "msg":"OK"
          }

          12.1.3 系统实体禁用

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/sys/entity/disable

          2、入参(请求的body中)

          参数名 类型 是否可空 备注
          sysEntityId string 系统实体id

          3、返回值

          参数名 类型
          code int
          time long
          msg string
          data T

          示例:

          {
              "time":1590412948169,
              "data":null,
              "code":200,
              "msg":"OK"
          }

          12.2 用户实体

          12.2.1 用户实体创建

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/user/entity/create

          2、入参【请求的body中】

          参数名 类型 是否可空 备注
          name string 实体名称
          nameZh string 实体中文名称
          description string 描述

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data id

          示例:

          {
              "time":1572405713583,
              "data":{
                  "id":"xxxxxxxxxxxxxxxxxxxxxxx"
              },
              "code":200,
              "msg":"OK"
          }

          12.2.2 用户实体更新

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/user/entity/update

          2、入参【请求的body中】

          参数名 类型 是否可空 备注
          name string 实体名称
          nameZh string 实体中文名称
          description string 描述
          id string id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          version int data 版本号

          示例:

          {
              "time":1572405713583,
              "data": {"version":1},
              "code":200,
              "msg":"OK"
          }

          12.2.3 用户实体删除

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/user/entity/delete

          2、入参【请求的body中】

          参数名 类型 是否可空 备注
          id string id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          id string data id

          示例:

          {
              "time":1572405713583,
              "data":null,
              "code":200,
              "msg":"OK"
          }

          12.2.4 用户实体详情

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/user/entity/detail

          2、入参【请求的param中】

          参数名 类型 是否可空 备注
          id string id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data id
          name string data 实体名称
          nameZh string data 实体中文名
          description string data 描述
          updated string data 更新时间
          created string data 创建时间
          version int data 版本号

          示例:

          {
              "time":1590410896044,
              "data":{
                  "id":"d8bea0bd-0479-4d14-a609-457b61ed1a72",
                  "name":"car_type",
                  "nameZh":null,
                  "description":"",
                  "updated":"2020-05-18 16:05:45",
                  "created":"2020-05-18 16:05:45",
                  "version":0
              },
              "code":200,
              "msg":"OK"
          }

          12.2.5 用户实体列表

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/user/entity

          2、入参【请求的param中】

          参数名 类型 是否可空 备注
          ps int 页面大小[默认20]
          pn int 页码
          keyword string 关键词

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          list list data 数据列表
          ps int list 页面大小
          pn int list 页码
          id string list id
          name string list 实体名称
          nameZh string list 实体中文名
          description string list 描述
          updated string list 更新时间
          created string list 创建时间
          version int list 版本号

          示例:

          {
              "time":1590410642858,
              "data":{
                  "total":1,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                          "id":"d8bea0bd-0479-4d14-a609-457b61ed1a72",
                          "name":"car_type",
                          "nameZh":"车型",
                          "description":"",
                          "updated":"2020-05-18 16:05:45",
                          "created":"2020-05-18 16:05:45",
                          "version":0
                      }
                  ]
              },
              "code":200,
              "msg":"OK"
          }

          12.3 实体值

          12.3.1 实体值创建

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/entity/entry/create

          2、入参【请求的body中】

          参数名 类型 是否可空 备注
          entityId string 实体id
          value string 实体值
          synonyms string 同义词 ","英文逗号分割

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data id

          示例:

          {
              "time":1572405713583,
              "data":{
                  "id":"xxxxxxxxxxxxxxxxxxxxxxx"
              },
              "code":200,
              "msg":"OK"
          }

          12.3.2 实体值更新

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/entity/entry/update

          2、入参【请求的body中】

          参数名 类型 是否可空 备注
          id string 实体值id
          entityId string 实体id
          version int 版本号
          value string 实体值
          synonyms string 同义词 ","英文逗号分割

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          version int data 版本号

          示例:

          {
              "time":1572405713583,
              "data":{
                  "version":1
              },
              "code":200,
              "msg":"OK"
          }

          12.3.3 实体值详情

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/entity/entry/detail

          2、入参

          参数名 类型 是否可空 备注
          id string 实体值id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          id string data 实体值id
          agentId string data agentId
          value string data 实体值
          synonyms string data 同义词 【"," 英文逗号分割】
          created string data 创建时间
          updated string data 更新时间
          version int data 版本号

          示例:

          {
              "time":1594109297847,
              "data":{
                  "id":"a0746240-b5b1-4aae-ad7d-4df5a421033d",
                  "agentId":"7880c4be-af69-4af3-9701-acbe4ef3b891",
                  "value":"大法师 地方",
                  "synonyms":"",
                  "created":"2020-07-02 11:47:34",
                  "updated":"2020-07-02 11:47:34",
                  "version":0
              },
              "code":200,
              "msg":"OK"
          }

          12.3.4 实体值列表

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/entity/entry

          2、入参

          参数名 类型 是否可空 备注
          entityId string 实体id
          ps string 页面大小
          pn string 页码
          keyword string 关键词

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据
          total int data 总数量
          ps int data 页面大小
          pn int data 页码
          list list data 数据列表
          id string list 实体值id
          agentId string list agentId
          value string list 实体值
          synonyms string list 同义词 【"," 英文逗号分割】
          created string list 创建时间
          updated string list 更新时间
          version int list 版本号

          示例:

          {
              "time":1593689531326,
              "data":{
                  "total":4,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                          "id":"xxxxxxxxxxxxxxxxx",
                          "agentId":"xxxxxxxxxxxxxxx",
                          "value":"aaaa",
                          "synonyms":"",
                          "created":"2020-07-02 11:47:34.0",
                          "updated":"2020-07-02 11:47:34.0",
                          "version":0
                      }
                  ]
              },
              "code":200,
              "msg":"OK"
          }

          12.3.5 实体值删除

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/entity/entry/delete

          2、入参【请求的body中】

          参数名 类型 是否可空 备注
          id string 实体值id
          entityId string 实体id

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 返回数据

          示例:

          {
              "time":1572405713583,
              "data":null,
              "code":200,
              "msg":"OK"
          }

          13.发布

          13.1 知识发布

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/publish/knowledge

          2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          category string 逗号分割的字符串。全部则是all 可选值为entity【实体】,intent【意图】faq【faq】chitchat【闲聊】t 。样例比如:{"category":"faq,chitchat"}

          4、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T
          id string data id
          botId string data botId
          status string data 状态
          msg string data 标准问id
          createUserId string data 创建者id
          createUserName string data 创建者名称

          示例:

          {
              "time":1590391112518,
              "data":{
                  "id":"0eca8312bb6a4383a3c50c519933cb4f",
                  "botId":"b68fb02b-584b-4501-bc45-a4af53e0099d",
                  "status":"CREATE",
                  "msg":"task is created",
                  "createUserId":"32500597715",
                  "createUserName":"aicp"
              },
              "code":200,
              "msg":"OK"
          }

          13.2 BOT 发布

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/publish/bot

          2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          botId string botId

          4、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T
          id string data id
          botId string data botId
          status string data 状态
          msg string data 标准问id
          createUserId string data 创建者id
          createUserName string data 创建者名称

          示例:

          {
              "time":1590391112518,
              "data":{
                  "id":"0eca8312bb6a4383a3c50c519933cb4f",
                  "botId":"b68fb02b-584b-4501-bc45-a4af53e0099d",
                  "status":"CREATE",
                  "msg":"task is created",
                  "createUserId":"32500597715",
                  "createUserName":"aicp"
              },
              "code":200,
              "msg":"OK"
          }

          13.3 发布取消

          版本:(since 6.1)

          1、接口地址:POST {IP}:{PORT}/open/v{versionId}/publish/cancel

          2、入参(需生成json字符串,放到请求的body中)

          参数名 类型 是否可空 备注
          id string 发布id

          4、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T
          canceled boolean data 是否触发取消动作

          示例:

          {
              "time":1590391112518,
              "data":{
                  "canceled":true
              },
              "code":200,
              "msg":"OK"
          }

          13.4 发布状态监控

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/publish/status

          2、无需传参

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T
          running boolean data 是否正在发布

          示例:

          {
              "time":1590391112518,
              "data":{
                  "running": true
              },
              "code":200,
              "msg":"OK"
          }

          14.BOT

          14.1 BOT 列表

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/bot

          2、入参(query param中)

          参数名 类型 是否可空 备注
          ps string 页面大小
          pn string 页码
          keyword string 关键字
          startTime string 开始时间
          endTime string 结束时间
          timeType string 时间类型创建时间:created发布时间:publish

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T
          list list data 数据列表
          id string list id
          accessToken string list bot token
          agentId string list agentId
          name string list bot 名称
          description string list 描述
          createdUserId string list 创建者id
          createdUserName string list 创建者名称

          示例:

          {
              "time":1591169163529,
              "data":{
                  "total":1,
                  "pn":1,
                  "ps":20,
                  "list":[
                      {
                          "id":"1c8edc5e-68cd-4256-8aef-a9e2955a99ec",
                          "name":"aa",
                          "description":null,
                          "created":"2020-05-27 16:29:57",
                          "createdUserId":"32500597715",
                          "createdUserName":"aicp",
                          "agentId":"be1c0d74-41ca-482a-a1c7-f40d6cc4fbb2",
                          "accessToken":"3d272eb0-10e3-4eec-b6c0-9068c6a2f5fc"
                  ]
              },
              "code":200,
              "msg":"OK"
          }

          15.NLU

          15.1 nlu 分析

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/nlu

          2、入参(query param中)

          参数名 类型 是否可空 备注
          query string 请求文本

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T
          nluQuery string data 处理过的 nlu 请求文本
          sensitiveWords list< string> data 敏感词列表
          attitude map<string, object> list 态度
          prob float attitude 置信度
          name string attitude 态度英文名
          nameZh string attitude 态度中文名
          intents list< map< string, object>> data 意图
          id string intents
          name string intents 意图名称
          nameZh string intents 意图中文名
          confidence double intents 置信度
          source string intents 来源 :template 意图模板
          knn 意图示例
          aicp || ensemble 意图模型
          industry 内置行业模型
          clarifyIntents list< map< string, object>> data 澄清意图【格式字段同intents】
          sentiment map< string, object> data 情感
          prob float sentiment 置信度
          source string sentiment 来源
          name string sentiment 情感英文名
          nameZh string sentiment 情感中文名
          entities map< string, object> data 识别到的实体 【具体可以参照表格下方示例】
          xxxx string entities 实体英文名【不固定】
          name string entities 实体Id
          entryId string entities 实体值id
          value string entities 实体值
          original string entities 原始值
          name string entities 实体英文名【NGD页面显示为实体ID】
          nameZh string entities 实体中文名
          offset string entities 标志位
          system boolean entities 是否是系统实体
          combineValue string entities 组合值【复合实体用】
          extra map<string, object> entities 实体额外属性信息
          clarifyEntities map<string, object> data 澄清实体【与entities 互斥,两者不会同时存在】
          xxxx string clarifyEntities 实体英文名【名称不固定】
          name string clarifyEntities 实体英文名
          type int clarifyEntities 实体类型,1 : 系统实体;2 : 规则实体;3:复合实体
          candidateList list< string> clarifyEntities 候选值列表
          nluEntityClarifyList list< map < string, object>> data 澄清实体【与entities 互斥,两者不会同时存在】
          entityId string nluEntityClarifyList 实体Id
          entryId string nluEntityClarifyList 实体值id
          value string nluEntityClarifyList 实体值
          original string nluEntityClarifyList 原始值
          name string nluEntityClarifyList 实体英文名【NGD页面显示为实体ID】
          nameZh string nluEntityClarifyList 实体中文名
          offset string nluEntityClarifyList 标志位
          system boolean nluEntityClarifyList 是否是系统实体
          combineValue string nluEntityClarifyList 组合值【复合实体用】
          extra map<string, object> nluEntityClarifyList 实体额外属性信息
          entityAutoFillVoMap map<string, object> data 复合实体填充字段

          示例:

          {
              "time":1590398524411,
              "data":{
                  "rawQuery":"我是中国人",
                  "nluQuery":"我是中国人",
                  "sensitiveWords":[
          
                  ],
                  "attitude":null,
                  "intents":[
          
                  ],
                  "clarifyIntents":[
          
                  ],
                  "sentiment":{
                      "prob":0.9999964,
                      "source":"model",
                      "name":"neutral",
                      "nameZh":"中立"
                  },
                  "clarifyEntities":{
                      "sys_location":{
                          "name":"sys_location",
                          "type":1,
                          "candidateList":[
                              "北京市朝阳区",
                              "吉林省长春市朝阳区"
                          ]
                      }
                  },
                  "nluEntityClarifyList":[
                      {
                          "entityId":null,
                          "entryId":null,
                          "value":"吉林省长春市朝阳区",
                          "original":"朝阳区",
                          "name":"sys_location",
                          "nameZh":"地点实体",
                          "offset":0,
                          "system":true,
                          "type":0,
                          "combineValue":null,
                          "extra":{
                              "area":"朝阳区",
                              "country":"中国",
                              "province":"吉林省",
                              "city":"长春市",
                              "isUnique":true,
                              "location":"吉林省长春市朝阳区",
                              "type":"区",
                              "list":[
                                  {
                                      "country":"中国",
                                      "province":"吉林省",
                                      "city":"长春市",
                                      "area":"朝阳区",
                                      "reserved":false
                                  }
                              ]
                          }
                      }
                  ]
              },
              "code":200,
              "msg":"OK"
          }

          15.2 关键词提取

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/nlu/keyword/fetch

          2、入参

          参数名 类型 是否可空 备注
          query string 请求文本

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data list< map< string, object>> 数据列表

          示例:

          {
              "time":1590394646206,
              "data":[
                  {
                      "中国人":1.1057613751765798
                  },
                  {
                      "是":0.7954663624674271
                  },
                  {
                      "我":0.1506923505089506
                  }
              ],
              "code":200,
              "msg":"OK"
          }

          15.3 文本分析提取

          版本:(since 6.1)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/nlu/similarity

          2、入参

          参数名 类型 是否可空 备注
          query string 请求文本
          candidate string 比较文本

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T 数据列表
          similarity float data 相似度

          示例:

          {
              "time":1594290630115,
              "data":{
                  "similarity":0.6930621
              },
              "code":200,
              "msg":"OK"
          }

          15.4 FAQ NLU 分析

          版本:(since 5.6)

          1、接口地址:GET {IP}:{PORT}/open/v{versionId}/nlu/faq/recognize

          2、入参

          参数名 类型 是否可空 备注
          query string 请求文本

          3、返回值

          参数名 类型 父节点 备注
          code int HTTP状态码
          time long 时间
          msg string 状态信息
          data T
          total int data 返回总数量
          list list data 数据列表
          id string list id
          question string list 问题
          faqId string list 标准问id
          standardQuestion string list 标准问问题
          template string list 模板
          source string list 来源
          score string list 置信度

          示例:

          {
              "time":1585021517982,
              "data":{
                  "list":[
                      {
                          "id":"6cddd214-9a9a-4894-9a0f-9d2751b8c743",
                          "question":"测试德",
                          "faqId":"7af4c95b-16d3-4e0d-91db-71a821d88c6e",
                          "standardQuestion":"nlu 测试吧",
                          "template":null,
                          "source":"extend",
                          "score":1
                      }
                  ],
                  "total":1
              },
              "code":200,
              "msg":"OK"
          }
          上一篇
          更新日志
          下一篇
          v5.6版本