问答机器人api.md

问答机器人api文档

发送消息

简要说明：

• 发送一条消息给机器人，机器人根据消息回复。

请求url：

• /send

请求方法：

• POST

参数说明：

参数名	必选	类型	说明
sender	是	str	发送者id，可随便输入，字符串即可
message	是	str	发送的消息

参数示例：

{
    "sender": "123",
    "message": "哈哈哈"
}

返回说明：

参数名	类型	说明
code	int	状态码，0为成功，1为失败
messages	array	返回的消息，是一个字符串数组
sender	str	接受用户的id

返回示例：

{
    "code": 0,
    "data": {
        "messages": [
            "您好！"
        ],
        "sender": "123"
    }
}

查询单个用户的对话内容

简要说明：

• 根据用户id，查询该用户与机器人的对话内容

请求url：

• /conversations/{sender_id}

请求方法：

• GET

参数说明：

参数名	必选	类型	说明
sender_id	是	str	发送者id，必须写在url中，替换"{sender_id}"

参数示例：

http://{host}/conversations/123

返回说明：

参数名	类型	说明
code	int	状态码，0为成功，1为失败
conversation	array	包含对话内容的数组
message	str	消息内容
sender	str	发送者，user为用户，bot为机器人

返回示例：

{
    "code": 0,
    "data": {
        "conversation": [
            {
                "message": "怎么戴口罩",
                "sender": "user"
            },
            {
                "message": "戴口罩时，要将折面完全展开，将嘴、鼻、下颌完全包住，然后压紧鼻夹，使口罩与面部完全贴合。戴口罩前要及时洗手，在戴口罩过程中避免手接触到口罩内面，以降低口罩被污染的可能。要分清楚口罩的内外、上下，浅色面为内面，内面应该贴着口鼻，深色面朝外；有金属条（鼻夹）的一端是口罩的上方。口罩不可内外面戴反，更不能两面轮流戴。",
                "sender": "bot"
            },
            {
                "message": "你好呀",
                "sender": "user"
            },
            {
                "message": "您好呀！",
                "sender": "bot"
            },
            {
                "message": "你说的撒",
                "sender": "user"
            },
            {
                "message": "我不太明您什么意思。您可以问我：出现什么症状需要就医？",
                "sender": "bot"
            }
        ]
    }
}

查询所有用户的对话

简要说明：

• 查询与机器人对话过的所有用户及其对话内容。

请求url：

• /conversations

请求方法：

• GET

返回说明：

参数名	类型	说明
code	int	状态码，0为成功，1为失败
sender	str	用户的id

返回示例：

{
    "code": 0,
    "data": [
        {
            "sender": "user4"
        },
        {
            "sender": "21321asfa"
        },
        {
            "sender": "123"
        }
    ]
}

获取关联问题

简要说明：

• 根据用户输入的句子，获取前k个关联性最高的问题。

请求url：

• /suggest

请求方法：

• POST

参数说明：

参数名	必选	类型	说明
question	是	str	用户输入的句子
top	否	int	前k个问题，默认为5

参数示例：

{
    "question": "口罩怎么",
    "top": 5
}

返回说明：

参数名	类型	说明
code	int	状态码，0为成功，1为失败
suggest	array	关联问题的列表

返回示例：

{
    "code": 0,
    "data": {
        "suggest": [
            "怎么戴口罩",
            "口罩应该怎么戴",
            "怎么带口罩",
            "口罩怎么选择？",
            "怎样正确戴口罩"
        ]
    }
}