项目	值	描述
机器人名称	小松	机器人的名字
描述	机器人示例	机器人的描述
语言	zh_CN	机器人的语言，目前支持中文(zh_CN)和英文(en_US)

【提示】其它项如兜底回复，问候语可以在创建后，设置页面修改。

下载知识库文件

下载知识库示例文件chatopera_faq_samples.json，保存文件名为chatopera_faq_samples.json。

知识库文件格式

在该示例文件中，用 JSON 数组的形式存储了 100 个问答对，字段含义如下：

key	type	required	description
categories	[string]	false	分类名称，支持层级比如 `["一级", "二级"]`，服务器端自动创建对应分类
enabled	boolean	true	是否启用，代表该问答对导入后是否支持来访者检索
post	string	true	问答对的标准问
replies	[object]	true	问答对的回答，数组长度大于 0, `content`是文本内容，`rtype`为`plain`表示`content`为纯文本; `rtype`为`html`表示`content`为富文本
similarQuestions	[string]	false	问答对里的相似问

导入知识库

上传知识库文件

选择chatopera_faq_samples.json，这时，会显示问答对列表，点击“提交”，在进度条完成后，知识库导入成功。

测试知识库

知识库测试窗口

输入： 下雨天在屋外烧电焊注意什么

确认得到回复。

获取ClientId和Secret

集成机器人服务的方式是通过 SDK，每个机器人实例需要通过ClientId和Secret初始化，完成认证和授权。打开机器人【设置】页面，拷贝ClientId和Secret。

显示Secret

执行示例程序

假设您已经:

准备好ClientId和Secret了；
安装了chatopera/sdk，

那么，可以用以下代码测试。

<?php

include_once __DIR__ . "/vendor/autoload.php";

$appId = "YOUR CLIENT ID";
$secret = "YOUR SECRET";

$chatbot = new Chatopera\SDK\Chatbot($appId, $secret);
print_r($chatbot->command("GET", "/"));

返回结果示例

接口概述

各接口的详细描述请访问开发者平台文档中心。

同时提供PHP Docs为使用参考。

贡献

单元测试

./vendor/bin/phpunit --bootstrap vendor/autoload.php test/ChatbotTest.php

卸载

从项目中卸载 SDK。

composer remove chatopera/sdk

开源许可协议

Apache License Version 2.0

Copyright 2018-2021, 北京华夏春松科技有限公司. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

chatopera / sdk

Maintainers

Details

README

安装

创建机器人

点击“立即使用”

创建聊天机器人