智能闲聊

简介

HI,您好,欢迎使用腾讯AI开放平台智能闲聊API接口服务。

本文档主要针对需要集成HTTP API的技术研发工程师,详细描述智能闲聊能力相关的技术内容。

如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:

官方交流一群:581197347

官方交流二群:705874401

官方交流三群:415349651

联系邮箱:aicamp@tencent.com

接口能力

接口名称 接口描述 API地址
基础闲聊 https://api.ai.qq.com/fcgi-bin/nlp/nlp_textchat

更多更强大的接口能力正在开发中,并逐步开放,敬请期待!

协议须知

调用方集成智能闲聊API时,请遵循以下规则。

规则 描述
传输方式 HTTPS
请求方法 GET或POST
字符编码 统一采用UTF-8编码
响应格式 统一采用JSON格式
接口鉴权 签名机制,详情请阅接口鉴权

基础闲聊接口

1. 接口描述

基础闲聊接口提供基于文本的基础聊天能力,可以让您的应用快速拥有具备上下文语义理解的机器聊天功能。

2. 请求参数

参数名称 是否必选 数据类型 数据约束 示例数据 描述
app_id int 正整数 1000001 应用标识(AppId)
time_stamp int 正整数 1493468759 请求时间戳(秒级)
nonce_str string 非空且长度上限32字节 fa577ce340859f9fe 随机字符串
sign string 非空且长度固定32字节 签名信息,详见接口鉴权
session string UTF-8编码,非空且长度上限32字节 10000 会话标识(应用内唯一)
question string UTF-8编码,非空且长度上限300字节 你叫啥 用户输入的聊天内容

3. 响应参数

参数名称 是否必选 数据类型 描述
ret int 返回码; 0表示成功,非0表示出错
msg string 返回信息;ret非0时表示出错时错误原因
data object 返回数据;ret为0时有意义
session string UTF-8编码,非空且长度上限32字节
answer string UTF-8编码,非空

4. 参考示例

假设示例请求数据如下。

参数名称 参数数据 描述
app_id 1000001 仅供参考
session 10000 仅供参考
question 你叫啥 使用UTF-8编码
time_stamp 实时计算
nonce_str 实时计算
sign 实时计算

假设应用密钥为:a95eceb1ac8c24ee28b70f7dbba912bf

下面使用PHP实现该HTTP API调用,其中getReqSigndoHttpPost可以从接口鉴权获取。

// 设置请求数据
$appkey = 'a95eceb1ac8c24ee28b70f7dbba912bf';
$params = array(
    'app_id'     => '1000001',
    'session'    => '10000',
    'question'   => '你叫啥',
    'time_stamp' => strval(time()),
    'nonce_str'  => strval(rand()),
    'sign'       => '',
);
$params['sign'] = getReqSign($params, $appkey);

// 执行API调用
$url = 'https://api.ai.qq.com/fcgi-bin/nlp/nlp_textchat';
$response = doHttpPost($url, $params);
echo $response;

上述echo $response的输出结果即API的响应结果(注意使用UTF-8编码):

{
  "ret": 0,
  "msg": "ok",
  "data": {
      "session": "10000",
      "answer": "我叫小豪豪~"
  }
}

闲聊画像设置

您可对选择了智能闲聊接口的应用进行个性化画像设置。在应用详情页面可找到闲聊画像设置入口(控制台->应用管理->选择已使用智能闲聊接口的应用->能力高级设置->智能闲聊->自定义配置闲聊画像):

alt chat-01

1. 开始设置

点击“开始设置”,您可以开始创建闲聊画像。

alt chat-02

注:画像中的基础设置为必填内容,包括姓名、性别、生日和血型;进阶设置和爱好盘点为选填内容,这些配置可以让您的闲聊画像更加个性化,如果不进行设置,将使用系统默认画像。

各属性的填写规范如下。

属性 填写规范
姓名 不超过40个字
性别 男、女
生日 1940-1-1至今
血型 A型、B型、O型、AB型、Rh型、不便透露
昵称 不超过40个字
好朋友 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
性格 不超过100个字
兴趣 不超过100个字
弱点 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
优点 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的运动 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的球星 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的球队 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的电影 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的游戏 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的动漫 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的饮料 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的食物 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的颜色 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的歌手 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字
喜欢的音乐类型 多个短语用“|”隔开,最多不超过5个短语,每个短语不超过20个字

2. 保存并开启画像

设置完成闲聊画像后,点击“保存并开启画像”,闲聊画像将于1分钟后生效。

3. 编辑画像

您也可以对闲聊画像进行编辑修改,修改完成并点击“保存并开启画像”后,更新的画像将于1分钟后生效。

4. 关闭画像

当您不需要使用您的自定义画像时,您可将闲聊画像关闭,关闭后,将导致设置失效,恢复系统默认画像。若您在关闭后想重新开启闲聊画像,需在该路径(控制台->应用管理->选择已使用智能闲聊接口的应用->详情->基础闲聊画像设置)下查看设置,然后点击“开启画像”或者重新“编辑画像”并开启后,闲聊画像才能在1分钟后生效。

一键接入微信公众号

您可以将智能闲聊能力接入微信公众号。在应用详情页面可找到一键接入的入口(控制台->应用管理->选择已使用智能闲聊接口的应用->能力高级设置->智能闲聊->一键接入微信公众号->授权接入)

alt chat-04

1. 公众号授权

点击“去授权”,跳转到微信的授权页面,出现授权二维码。

alt chat-05

打开公众号管理员的个人微信,扫描授权页面的二维码。
在手机端微信列出的授权页面中确认权限并同意授权。为了保证闲聊能力的正常使用,授权时请务必勾选消息管理权限。
完成授权后,进入公众号使用聊天服务;您对闲聊画像所做的自定义设置,都会同步应用于公众号聊天机器人中。

注:单一应用的闲聊能力最多可接入10个公众号,如需接入更多,请新建应用后再继续使用。

2. 修改权限

对于已经接入的公众号,可以选择“修改权限”,修改已授权的权限,但是不可取消所有权限。

alt chat-06

AI开放平台公众号
关注公众号

打造升级AI项目
推送全球AI热点