API文档

API文档

---

1.自动联想接口

1）基本信息

Path: https://www.woodman-ai.com/api/robots/realtime_predict
Method: POST

2）接口描述

Header：

ContentType:application/json    

QueryParam:

名称	类型	备注
robot_id	string	机器人ID
token	string	机器人token

Body:

名称	类型	备注
question	string	输入的问题

3）返回值

返回为一个list，内容为联想文本

['XXXX','XXXXX','XXXX','XXXX']

4）例子

请求：

url:
https://www.woodman-ai.com/api/robots/realtime_predict?robot_id=1&token=90798d231fd0b146f04438e845f42ea68b59cc7162f3577e6c1f1d3788139576
body:
{question:"养子"}

返回：

[
"养子女可以继承养父母的遗产吗？",
"养子女有继承权么？", 
"子女对父母有赡养义务吗？",
"父母有养老保险，子女是否需要履行赡养义务？", 
"收养孩子应该准备什么材料？"
]

---

2.问题预测

1）基本信息

Path: https://www.woodman-ai.com/api/robots/predict
Method: POST

2）接口描述

Header：

ContentType:application/json    

QueryParam:

名称	类型	备注
robot_id	string	机器人ID
token	string	机器人token

Body:

名称	类型	备注
question	string	输入的问题
session_id	string	会话id，第一次请求可为空，返回值中会带上sessionid返回，此后的请求中将此字段加上

3）返回值

名称	类型	备注
text	list[object]	如果是相似问题，返回数量为3；如果是完全匹配问题，返回数量为1
--problem_text	string	问题文本
--acc	number	语义相似度，范围0-1，如果是问题库中完全匹配的问题，返回1
--questionid	number	知识库中的问题id
--answer	string	答案文本
error	string	错误信息提示
request_id	string	请求id，可不用
type	string	如果是相似问题，返回"faq";如果是完全匹配问题，返回"qa"
session_id	string	会话id，第一次请求可为空，返回值中会带上sessionid返回，此后的请求中将此字段加上

json格式如下

{
    "text":
    [
        {
            "problem_text":"问题1",//类型string
            "acc":0.6,//语义相似度，类型number，范围0-1
            "questionid":473,//问题id，类型number
            "answer":"对应的答案1"//类型string
        },
        {
            "problem_text":"问题2",//类型string
            "acc":0.4,//语义相似度，类型number，范围0-1
            "questionid":473,//问题id，类型number
            "answer":"对应的答案2"//类型string
        },
    ],
    "error":"",//错误信息提示，类型string
    "request_id":"c2b73e77-8907-4a3a-a78e-f2a79bc847f6",//请求id，类型string
    "type":"faq",//请求类型，类型string
    "session_id":"55f65517-7ce9-433d-a971-da43caeaab2a"//会话id，类型string，如果请求中不包含该字段，将重新分配一个session_id;如果请求中已经包含该字段，则返回请求头中的sessionid
}

4）例子1：相似问题

请求：

url:
https://www.woodman-ai.com/api/robots/predict?robot_id=1&token=90798d231fd0b146f04438e845f42ea68b59cc7162f3577e6c1f1d3788139576
body:
{
   question:"养子可以继承财产么？",
   session_id:"6b1e6061-27a3-4476-ab08-caf729ca0c6b"
}

返回：

{
    "text":
    [
        {
            "problem_text":"养子女有继承权么？",
            "acc":0.64620578,
            "questionid":473,
            "answer":"养子女与养父母的婚生子女享有同等的权利，均属于第一顺序继承人。如果养父母死亡，对养父母生前的财产，养子女有继承的权利。"
        },
        {
            "problem_text":"养子女可以继承养父母的遗产吗？",
            "acc":0.24797647,
            "questionid":414,
            "answer":"父母收养的子女与亲生子女有相同的权利和义务，所以养子女可以继承养父母的遗产，继承的份额跟亲生子女的一样。"
        },
        {
            "problem_text":"离婚后子女归我抚养，子女可以继承对方的遗产吗？",
            "acc":0.123340745,
            "questionid":472,
            "answer":"离婚后，不论子女由男方或女方抚养，子女和父母的关系依然存在，一方死亡，子女可以继承死者的财产。"
        }
    ],
    "error":"",
    "request_id":"c2b73e77-8907-4a3a-a78e-f2a79bc847f6",
    "type":"faq",
    "session_id":"55f65517-7ce9-433d-a971-da43caeaab2a"
}

4）例子2：完全匹配问题

请求：

url:
https://www.woodman-ai.com/api/robots/predict?robot_id=1&token=90798d231fd0b146f04438e845f42ea68b59cc7162f3577e6c1f1d3788139576
body:
{
   question:"养子女有继承权么？",
   session_id:"6b1e6061-27a3-4476-ab08-caf729ca0c6b"
}

返回：

{
    "text":
    [
        {
            "problem_text":"养子女有继承权么？",
            "acc":1,
            "questionid":473,
            "answer":"养子女与养父母的婚生子女享有同等的权利，均属于第一顺序继承人。如果养父母死亡，对养父母生前的财产，养子女有继承的权利。"
        },
    ],
    "error":"",
    "request_id":"c2b73e77-8907-4a3a-a78e-f2a79bc847f6",
    "type":"qa",
    "session_id":"55f65517-7ce9-433d-a971-da43caeaab2a"
}

3.反馈接口

1）基本信息

Path: https://www.woodman-ai.com/api/robots/feedback
Method: POST

2）接口描述

Header：

ContentType:application/json    

QueryParam:

名称	类型	备注
robot_id	string	机器人ID
token	string	机器人token

Body:

名称	类型	备注
request_id	string	请求id，2-3中已经返回
chosen_question	string	选择的问题描述，2-3中已经返回
chosen_question_id	number	选择的问题ID，2-3中已经返回

3）返回值

名称	类型	备注
info	string	返回是否反馈成功的标志，成功返回为“thanks”

4）例子

请求：

url:
https:https://www.woodman-ai.com/api/robots/feedback?robot_id=2&token=293e0cb5e8ddb976874655beae7ebc
body:
{
request_id: "ac527bd6-16b2-4b80-948c-6c35a54e62f3"
chosen_question: "收养的孩子有继承权吗"
chosen_question_id: 48
}

返回：

{info: "thanks"}

4.测试

测试时候可以先用下面的robot_id和token：

robot_id: 2
token:293e0cb5e8ddb976874655beae7ebc