tencent cloud

文档反馈

无 UI 集成

最后更新时间:2024-02-27 16:23:05

    前提条件

    1. 了解聊天机器人相关术语及相关配置,并已完成以下步骤:
    在控制台创建聊天机器人、配置问答库、闲聊库。
    配置欢迎卡片。
    2. 集成 IM SDK,并跑通登录、发送单聊消息等功能。

    流程说明

    流程说明将描述从接入聊天机器人到和机器人对话的过程。

    步骤1:创建机器人

    请参见 操作指南 ,在 IM 控制上创建一个聊天机器人,并 配置 好问答库、闲聊库以及欢迎卡片。

    步骤2:进入机器人会话触发欢迎卡片

    在用户端首次进入机器人聊天会话时,请对聊天机器人账号发送触发欢迎卡片消息,机器人将返回一条欢迎卡片。

    步骤3:和机器人对话

    用户和聊天机器人对话。机器人对话正常情况下为文本消息,当机器人不理解用户意图,将会发送引导提问消息,引导提问消息为自定义消息,机器人将提供几个问题选项供用户选择。用户端需要解析该自定义消息并在用户做出选择时发送对应的文本消息。此外,欢迎卡片也是自定义消息。

    消息格式描述

    聊天机器人仅支持文本消息和自定义消息。其中用户端触发欢迎卡片、机器人返回欢迎卡片、机器人返回引导提问消息为自定义消息。本文描述的自定义消息格式,为 IM 自定义消息的 data字段经过 JSON 反序列化后的值。不同平台获取自定义消息的 data 字段的方式可见各自平台的文档(Android&iOS&Mac&Windows / Web&小程序&uni-app / Flutter / Unity / React Native)。
    机器人的自定义消息通过 JSON 结构体的 src 字段的值来区分不同类型的消息。下方展示了自定义消息字段的说明与示例:
    字段名
    字段类型
    字段含义
    chatbotPlugin
    Number
    聊天机器人自定义消息标志位,该字段固定为1。
    src
    Number
    聊天自定义消息类型,例如15代表此消息为聊天机器人的分支类型消息。

    触发欢迎卡片

    在用户端首次进入机器人聊天会话时,请对聊天机器人账号发送触发欢迎卡片消息。
    {
    "chatbotPlugin": 1,
    "src": 7
    }

    机器人回复的欢迎卡片消息

    机器人返回的欢迎卡片消息,提供几个用户可能想问的问题。用户端单击某个想问的问题,需要发送对应问题的文本消息给机器人。
    {
    "chatbotPlugin": 1,
    "src": 15,
    "subtype": "welcome_msg",
    "content": {
    "title": "猜你想问",
    "content": "欢迎使用即时通信 IM 智能机器人!",
    "items": [
    {
    "content": "即时通信 IM 图片上传到哪里"
    },
    {
    "content": "即时通信 IM 发送的图片、短视频、语音是否支持鉴黄"
    }
    ]
    }
    }

    机器人引导提问消息

    当机器人不理解用户意图,将会发送 引导提问消息,提供几个问题选项供用户选择。用户端点击某个想问的问题,需要发送对应问题的文本消息给机器人。
    {
    "chatbotPlugin": 1,
    "src": 15,
    "subtype": "clarify_msg",
    "content": {
    "content": "您可能想问",
    "items": [
    {
    "content": "即时通信 IM 图片上传到哪里"
    },
    {
    "content": "即时通信 IM 发送的图片、短视频、语音是否支持鉴黄"
    }
    ]
    }
    }

    流式输出文本

    说明:
    如果您使用 TUIKit 7.7.5282 版本及以上,则原生支持展示流式输出效果,如果您使用自己的 UI 库,则需要解析该自定义消息并在界面上展示流式的输出效果。
    当在控制台开启 Chatbot 的 流式输出开关 时,对于 Chatbot 的回复后台将下发自定义流式输出协议,首次输出的内容格式如下。
    {
    "chatbotPlugin": 1,
    "src": 2,
    "chunks": ["hello"]
    }
    后续内容 Chatbot 后台将调用 修改历史消息 功能,修改该消息将内容追加至 chunks 数组中,当输出完成时,额外设置一个字段"isFinished":1表示已完成。
    {
    "chatbotPlugin": 1,
    "src": 2,
    "chunks": ["hello", " world"],
    "isFinished": 1
    }

    自定义透传内容

    App 可以指定发送透传内容至 App 后台,并由 App 后台代智能机器人回复用户。当 App 发送以下内容时,IM后台将发送 智能机器人单聊消息自定义回调 至 App 后台,App 后台回复时,IM 后台将发送同样格式内容至 App。
    {
    "chatbotPlugin": 1,
    "src": 3,
    "data": "{\\"msg\\":\\"这是自定义透传内容\\"}"
    }
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持