更新时间:2023-12-06 GMT+08:00
分享

对话机器人服务CBS

用户可通过调用该接口与机器人进行会话,包含“问答机器人”、“热点问题统计”等执行动作。

连接参数

对话机器人服务CBS连接器使用IAM认证,连接参数说明如表1所示。

表1 连接参数说明

名称

必填

说明

示例值/默认值

连接名称

设置连接名称。

问答机器人的连接

描述

对于连接的信息描述说明。

description

租户名

IAM用户所属账号信息。了解账号与IAM用户的关系

domain

用户名

IAM用户名。

name

密码

IAM用户的登录密码。

-

区域

服务所属区域。

cn-north-4

问答机器人

用户可通过调用该接口与机器人进行会话。

  • 输入参数

    问答机器人执行动作,相关参数说明如表2所示。

    表2 问答机器人输入参数说明

    参数

    必填

    说明

    用户问题

    用户输入想要提出的问题。

    问答机器人ID

    通过华为云CBS控制台获取。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表3

    表3 问答机器人输出参数说明

    参数

    说明

    闲聊回复

    闲聊回复。

    答案

    根据问题,查询得出答案。

热点问题统计

获取热点问题列表。

  • 输入参数

    热点问题统计执行动作,相关参数说明如表4所示。

    表4 热点问题统计输入参数说明

    参数

    必填

    说明

    热点问题所属领域

    热点问题所属领域。

    问题类别id列表

    问题类别ID列表,一次最多传入10个。

    查询的起始时间

    查询的起始时间,long,utc时间,默认值为0。

    查询的结束时间

    查询的结束时间,long,utc时间,默认值为当前时间的毫秒数。

    是否根据问答信息展示热点问题

    true:根据问答对信息展示热点问题;false: 不根据问答对信息展示热点问题。

    热点问题最多显示的个数

    热点问题最多显示的个数,默认值为10,取值范围1-20。

    问答机器人ID

    通过华为云CBS控制台获取。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表5

    表5 热点问题统计输出参数说明

    参数

    说明

    热点问题列表

    指定时间范围内,热点问题列表。

    问答对Id

    问答对ID。

    标准问题

    标准问题。

    标准问题所属领域

    标准问题所属领域。

访问统计

获取用户会话统计信息。

  • 输入参数

    访问统计执行动作,相关参数说明如表6所示。

    表6 访问统计输入参数说明

    参数

    必填

    说明

    查询的起始时间

    查询的起始时间,long,utc时间,默认值为0。

    查询的结束时间

    查询的结束时间,long,utc时间,默认值为当前时间的毫秒数。

    统计周期

    统计周期目前支持month、week、day。

    请求所在时区

    请求所在时区,例如:中国东八区为"+08:00";美国西五区为"-05:00";默认为"UTC"。(注意+-:符号需要经过urlEncoder加码)。

    问答机器人ID

    通过华为云CBS控制台获取。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表7

    表7 访问统计输出参数说明

    参数

    说明

    统计周期

    统计周期目前支持month、week、day。

    请求所在时区

    请求所在时区,例如:中国东八区为"+08:00";美国西五区为"-05:00";默认为"UTC"。(注意+-:符号需要经过urlEncoder加码)。

    会话总计统计数据

    会话总计统计数据。

    会话总数

    会话总数。

    独立用户个数

    独立用户个数。

    平均会话轮数

    平均会话轮数,保留小数点后三位。

    平均会话时长

    平均会话时长,保留小数点后三位。

    会话间隔统计数据

    会话间隔统计数据。

    开始时间

    间隔周期开始时间。

    会话总数

    间隔周期会话总数。

    独立用户个数

    间隔周期独立用户个数。

    平均会话轮数

    间隔周期平均会话轮数,保留小数点后三位。

    平均会话时长

    间隔周期平均会话时长,保留小数点后三位。

    开始的utc时间

    统计开始的utc时间。

    结束的utc时间

    统计结束的utc时间。

获取问题提示

获取用户输入问题的提示问题列表。

  • 输入参数

    获取问题提示执行动作,相关参数说明如表8所示。

    表8 获取问题提示输入参数说明

    参数

    必填

    说明

    用户输入的问题

    用户输入的问题。

    最多提示条数

    最多提示条数。

    问答机器人ID

    通过华为云CBS控制台获取。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表9

    表9 获取问题提示输出参数说明

    参数

    说明

    问题列表

    推荐问列表。

关键词统计

用户问关键词统计。

  • 输入参数

    关键词统计执行动作,相关参数说明如表10所示。

    表10 关键词统计输入参数说明

    参数

    必填

    说明

    用户问题关键词列表

    用户问题关键词列表显示的个数。默认值为10,取值范围[1-50]。

    查询的起始时间

    查询的起始时间,long,utc时间,默认值为0。

    查询的结束时间

    查询的结束时间,long,utc时间,默认值为当前时间的毫秒数。

    问答机器人ID

    通过华为云CBS控制台获取。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表11

    表11 关键词统计输出参数说明

    参数

    说明

    用户问题关键词列表

    指定时间范围内,用户问题关键词列表。

    关键词

    关键词。

    关键词频次

    关键词频次。

相关文档