机器人知识库查询·一洽客服系统API

目录

1. 查询知识库列表
2. 查询热点问题
3. 搜索问题
4.搜索建议

1.查询知识库列表

接口地址

 http请求方式: POST
https://${apiServer}/robot/getKnowledgeBaseList/${appId}?accessToken=${accessToken}

访问限制:每个账号24小时内限制请求500000次

get参数说明

参数 是否必须 说明
accessToken 接口调用凭证

返回数据说明: 返回类型:JsonList

参数 类型 说明
kbId int 知识库的ID,在查询当前知识库下热点知识或者问题查询时需使用此ID
kbName string 知识库的名字,例如:客服操作教程
[
    {
        "kbId":123,
        "kbName":"客服解决方案"
    },
    {
        "kbId":234,
        "kbName":"客服操作教程"
    },
    {
        "kbId":345,
        "kbName":"在线客服系统"
    },
    {
        "kbId":567,
        "kbName":"客户投诉"
    }
]

2.查询热点问题

通过此接口开发者可以获取指定知识库或者全账户下的热点问题列表,最多支持返回最大500个热点问题。
接口地址:

 http请求方式: POST
https://${apiServer}/robot/getHotKnowledge/${appId}?accessToken=${accessToken}

访问限制:每个账号24小时内限制请求500000次

get参数说明

参数 是否必须 说明
accessToken 接口调用凭证

Post数据说明 JSON数据:

参数 类型 是否必须 说明
kbId int 要查询热点问题的知识库,如果不指定则查询所有知识库的热点问题
querySize int 要查询最热的前多少条问题,最大不超过500条。会根据知识热度倒序排序,知识热度=知识的命中数。 只返回在有效期内的标准知识

示例:

{
    "kbId":123,
    "querySize":100
}

返回数据说明

返回类型:JsonList

参数 类型 是否必须 说明
kbId int 知识库的ID,当前知识所属知识库ID
docId int 知识的ID,可根据此ID快速查询知识的答案
hitCount int 知识使用次数即热度,指定问题查询答案,或者通过语义检索匹配到此知识知识使用次数会增加
question string 知识的标准问法

返回示例:

[
    {
        "kbId":123,
        "docId":23,
        "hitCount":1024,
        "question":"一洽客服简介"
    },
    {
        "kbId":234,
        "docId":24,
        "hitCount":1024,
        "question":"一洽客服功能介绍"
    },
    {
        "kbId":345,
        "docId":25,
        "hitCount":1024,
        "question":"一洽客服产品组成"
    },
    {
        "kbId":567,
        "docId":26,
        "hitCount":1024,
        "question":"一洽客服支持哪些语言"
    }
]

3.搜索问题

通过此接口开发者可以根据问题ID直接检索问题答案,也可以输入相关内容进行语义匹配后返回对应检索的答案

接口地址

 http请求方式: POST
 https://${apiServer}/robot/queryKnowledge/${appId}?accessToken=${accessToken}

访问限制

每个账号24小时内限制请求500000次

get参数说明

参数 是否必须 说明
accessToken 接口调用凭证

Post数据说明

JSON数据:

参数 类型 是否必须 说明
kbId int 要查询问题的知识库,如果不指定则查询所有知识库,指定后只在当前知识库内查看是否有匹配的知识
docId int 要查询的知识ID,如果指定此ID则直接使用ID检索答案返回。docId和question两者必须有一个值不为空,如果不存在此docId的知识则根据question检索答案
question string 要查询的问题
queryScope int 要查询的知识范围 1(001):基础知识 2(010):引导知识 4:(100):寒暄知识 。指定查询范围时将需要查询的知识编码相加回传即可,比如:要查询基础知识和引导知识 则queryScope=1+2=3
suggestDataSize int 如果没有准确答案,要返回相似问题列表时最多返回多少条。 允许值:1-10.默认为:5

示例:

{
    "kbId":123,
    "question":"一洽客服支持集成业务系统吗"
}

返回数据说明

返回类型:JsonList

对象 参数 类型 是否必须 说明
  segWords string[] 被检索问题的分词结果
  queryResult int 此次检索问题的结果 1: 没有答案 2: 准确答案(系统判定相似度) 3: 准确答案(精准匹配) 4: 有相似问题
  answerType int 答案类型,在queryResult==2 or queryResult==3 时有效.1:基础知识(一问一答的基础知识) 2:引导知识(机器人反问选择者任务型知识)3:寒暄知识
  answerMedia int 问题答案的媒介类型 0:文本类型(纯文本、超文本)
  answer int 问题答案
queryResult=2或3时会返回答案,如果queryResult=1或4则此值为空
  similarity double 语义相似度0.0-1.0,相似度越高说明和查询问题越匹配
  answerKbId int 返回知识的知识库ID,queryResult=2或3时会有此值
knowledgeList   object[] 相关、相似问题列表。
queryResult=2 or queryResult=3时此列表为相关问题列
queryResult=4时此列表为相似问题列表
  question string 问题标准问法
  kbId int 此知识所在的知识库ID
  docId int 此知识的ID,再次检索词知识的答案时可通过此ID快速检索
  similarity double 语义相似度0.0-1.0,相似度越高说明和查询问题越匹配,在queryResult=4时返回每个相似知识的相似度。

返回示例:

{
    "segWords":["一洽客服","支持","集成","业务系统"],
    "queryResult":2,
    "answerType":1,
    "answerMedia":0,
    "answer":"一洽在线客服系统支持集成企页任意业务系统",
    "similarity":0.85,
    "answerKbId":123,
    "knowledgeList":[
        {
            "question":"集成会员系统示例",
            "kbId":123,
            "docId":6
        },
        {
            "question":"集成工单系统示例",
            "kbId":123,
            "docId":78
        },
        {
            "question":"集成库存系统示例",
            "kbId":123,
            "docId":678
        }
    ]
}

4.搜索建议

通过此接口开发者可以根据问题的部分内容返回系统推荐的知识列表

接口地址

 http请求方式: POST
 https://${apiServer}/robot/querySuggestData/${appId}?accessToken=${accessToken}

访问限制

每个账号24小时内限制请求1000000次

get参数说明

参数 是否必须 说明
accessToken 接口调用凭证

Post数据说明

JSON数据:

参数 类型 是否必须 说明
kbId int 要查询问题的知识库,如果不指定则查询所有知识库,指定后只在当前知识库内查看是否有匹配的知识
question string 要搜索建议知识的问题
queryScope int 要查询的知识范围 1(001):基础知识 2(010):引导知识 4:(100):寒暄知识 。指定查询范围时将需要查询的知识编码相加回传即可,比如:要查询基础知识和引导知识 则queryScope=1+2=3
suggestDataSize int 如果没有准确答案,要返回相似问题列表时最多返回多少条。 允许值:1-10.默认为:5

示例:

{
    "kbId":123,
    "question":"一洽客服"
}

返回数据说明

返回类型:JsonList

对象 参数 类型 是否必须 说明
  segWords string[] 被检索问题的分词结果
knowledgeList   object[] 如果有查询到相似的知识列表则会返回此列表
  question string 问题标准问法
  kbId int 此知识所在的知识库ID
  docId int 此知识的ID,再次检索词知识的答案时可通过此ID快速检索
  similarity double 语义相似度0.0-1.0,相似度越高说明和查询问题越匹配

返回示例:

{
    "segWords":[
        "一洽客服"
    ],
    "knowledgeList":[
        {
            "question":"一洽客服如何注册",
            "kbId":123,
            "docId":6,
            "similarity":0.51
        },
        {
            "question":"一洽客服系统集成",
            "kbId":123,
            "docId":78,
            "similarity":0.48
        },
        {
            "question":"一洽客服售后服务热线",
            "kbId":123,
            "docId":678,
            "similarity":0.45
        }
    ]
}