chore(addon/aikefu): 更新文档说明及功能

This commit is contained in:
2025-12-06 16:24:55 +08:00
parent 0b6e6914fd
commit 4d2467ae36
5 changed files with 678 additions and 260 deletions

View File

@@ -26,6 +26,9 @@ return [
'KefuChatStream' => [
'addon\aikefu\event\KefuChatStream'
],
'KefuGetInfo' => [
'addon\aikefu\event\KefuGetInfo'
],
],
'subscribe' => [

View File

@@ -0,0 +1,127 @@
<?php
namespace addon\aikefu\event;
use addon\aikefu\model\Config as KefuConfigModel;
/**
* 获取智能客服配置信息
*/
class KefuGetInfo
{
/**
* 处理获取配置信息事件
* @param array $data 事件数据
* @return array
*/
public function handle($data)
{
$site_id = $data['site_id'] ?? 0;
$member_id = $data['member_id'] ?? 0;
$client_info = $data['client_info'] ?? [];
try {
// 获取智能客服配置
$kefu_config_model = new KefuConfigModel();
$config_info = $kefu_config_model->getConfig($site_id);
$response_data = [
'service_info' => [
'name' => '智能客服',
'version' => '1.0.0',
'enabled' => false,
'status' => 'disabled'
],
'features' => [],
'limits' => [
'max_message_length' => 4000,
'max_conversation_history' => 100,
'rate_limit' => [
'requests_per_minute' => 60,
'requests_per_hour' => 1000
]
],
'endpoints' => [
'chat' => '/api/chat',
'chat_stream' => '/api/chatStream',
'create_conversation' => '/api/createConversation',
'get_history' => '/api/getHistory',
'clear_conversation' => '/api/clearConversation',
'health' => '/api/health',
'info' => '/api/info'
],
'client_info' => $client_info,
'server_info' => [
'php_version' => PHP_VERSION,
'server_time' => date('Y-m-d H:i:s'),
'timezone' => date_default_timezone_get()
]
];
// 处理配置信息
if (!empty($config_info['data']['value'])) {
$config = $config_info['data']['value'];
// 服务状态
$response_data['service_info']['enabled'] = $config['status'] == 1;
$response_data['service_info']['status'] = $config['status'] == 1 ? 'enabled' : 'disabled';
// 可用功能
if ($config['status'] == 1) {
$response_data['features'] = [
'chat' => true,
'chat_stream' => true,
'conversation_management' => true,
'history_management' => true
];
}
// API端点信息仅在启用时显示详细配置
if ($config['status'] == 1) {
$response_data['api_config'] = [
'base_url' => $config['base_url'] ?? '',
'chat_endpoint' => $config['chat_endpoint'] ?? '',
'supports_streaming' => true,
'authentication' => 'bearer_token'
];
}
// 限制配置(如果有的话)
if (isset($config['max_message_length'])) {
$response_data['limits']['max_message_length'] = intval($config['max_message_length']);
}
if (isset($config['rate_limit_per_minute'])) {
$response_data['limits']['rate_limit']['requests_per_minute'] = intval($config['rate_limit_per_minute']);
}
}
// 添加使用统计信息(如果需要的话)
if ($member_id > 0) {
$response_data['user_stats'] = [
'can_use_service' => $response_data['service_info']['enabled'],
'member_id' => $member_id,
'site_id' => $site_id
];
}
return [
'code' => 0,
'message' => '获取配置信息成功',
'data' => $response_data
];
} catch (\Exception $e) {
return [
'code' => -1,
'message' => '获取配置信息失败:' . $e->getMessage(),
'data' => [
'service_info' => [
'name' => '智能客服',
'status' => 'error'
],
'error' => $e->getMessage()
]
];
}
}
}

View File

@@ -125,6 +125,82 @@ class AI extends BaseApi
}
}
/**
* 获得AI服务的配置信息发送给客户端
* @return \think\response\Json
*/
public function info()
{
// (可选获取站点ID和会员ID可以通过事件数据传递
$site_id = $this->params['uniacid'] ?? $this->site_id;
$member_id = $this->params['member_id'] ?? $this->member_id;
$token = $this->params['token'] ?? $this->token;
try {
// 准备事件数据
$event_data = [
'site_id' => $site_id,
'member_id' => $member_id,
'token' => $token,
'client_info' => [
'user_agent' => $_SERVER['HTTP_USER_AGENT'] ?? '',
'ip' => $this->getClientIp(),
'timestamp' => time()
]
];
// 触发获取配置信息事件
$result = Event::trigger('KefuGetInfo', $event_data);
// 处理事件结果
$response = [
'code' => 0,
'message' => 'success',
'data' => []
];
if (is_array($result) && !empty($result)) {
foreach ($result as $res) {
if (isset($res['code']) && $res['code'] < 0) {
$response = $res;
break;
}
if (isset($res['data'])) {
$response['data'] = array_merge($response['data'], $res['data']);
}
}
}
return $this->response($response);
} catch (\Exception $e) {
return $this->response($this->error('请求失败:' . $e->getMessage()));
}
}
/**
* 获取客户端IP地址
*/
private function getClientIp()
{
$ip = '';
if (isset($_SERVER['HTTP_X_FORWARDED_FOR']) && !empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
$ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
} elseif (isset($_SERVER['HTTP_X_REAL_IP']) && !empty($_SERVER['HTTP_X_REAL_IP'])) {
$ip = $_SERVER['HTTP_X_REAL_IP'];
} elseif (isset($_SERVER['REMOTE_ADDR']) && !empty($_SERVER['REMOTE_ADDR'])) {
$ip = $_SERVER['REMOTE_ADDR'];
}
// 处理多个IP的情况X-Forwarded-For可能包含多个IP
if (strpos($ip, ',') !== false) {
$ips = explode(',', $ip);
$ip = trim($ips[0]);
}
return $ip;
}
/**
* 清除会话历史
*/

View File

@@ -1,187 +0,0 @@
<?php
namespace app\api\controller;
use app\api\controller\BaseApi;
use think\facade\Event;
/**
* 智能客服API控制器
*/
class Kefu extends BaseApi
{
/**
* 智能客服聊天接口
* @return \think\response\Json
*/
public function chat()
{
// 获取请求参数
$message = $this->params['message'] ?? '';
$user_id = $this->params['user_id'] ?? $this->member_id;
$conversation_id = $this->params['conversation_id'] ?? '';
$stream = $this->params['stream'] ?? false;
// (可选获取站点ID和会员ID可以通过事件数据传递
$site_id = $this->params['uniacid'] ?? $this->site_id; // 使用 uniacid, 方便以后迁移而且uniacid 是唯一的, site_id 不是同时被params给过滤了
$member_id = $this->params['member_id'] ?? $this->member_id;
$token = $this->params['token'] ?? $this->token;
// 验证参数
if (empty($message)) {
return $this->response($this->error('请输入消息内容'));
}
try {
// 准备事件数据
$event_data = [
'message' => $message,
'user_id' => $user_id,
'conversation_id' => $conversation_id,
'stream' => $stream,
'site_id' =>$site_id,
'member_id' => $member_id,
'token' => $token,
];
// 触发智能客服聊天事件
$result = Event::trigger('KefuChat', $event_data);
// 处理事件结果
$response = [
'code' => 0,
'message' => 'success',
'data' => []
];
if (is_array($result) && !empty($result)) {
foreach ($result as $res) {
if (isset($res['code']) && $res['code'] < 0) {
$response = $res;
break;
}
if (isset($res['data'])) {
$response['data'] = array_merge($response['data'], $res['data']);
}
}
}
return $this->response($response);
} catch (\Exception $e) {
return $this->response($this->error('请求失败:' . $e->getMessage()));
}
}
/**
* 创建新会话
* @return \think\response\Json
*/
public function createConversation()
{
// 获取请求参数
$user_id = $this->params['user_id'] ?? $this->member_id;
// (可选获取站点ID和会员ID可以通过事件数据传递
$site_id = $this->params['uniacid'] ?? $this->site_id; // 使用 uniacid, 方便以后迁移而且uniacid 是唯一的, site_id 不是同时被params给过滤了
$member_id = $this->params['member_id'] ?? $this->member_id;
$token = $this->params['token'] ?? $this->token;
try {
// 准备事件数据
$event_data = [
'user_id' => $user_id,
'site_id' =>$site_id,
'member_id' => $member_id,
'token' => $token,
];
// 触发创建会话事件
$result = Event::trigger('KefuCreateConversation', $event_data);
// 处理事件结果
$response = [
'code' => 0,
'message' => 'success',
'data' => []
];
if (is_array($result) && !empty($result)) {
foreach ($result as $res) {
if (isset($res['code']) && $res['code'] < 0) {
$response = $res;
break;
}
if (isset($res['data'])) {
$response['data'] = array_merge($response['data'], $res['data']);
}
}
}
return $this->response($response);
} catch (\Exception $e) {
return $this->response($this->error('请求失败:' . $e->getMessage()));
}
}
/**
* 获取会话历史
* @return \think\response\Json
*/
public function getHistory()
{
// 获取请求参数
$conversation_id = $this->params['conversation_id'] ?? '';
$user_id = $this->params['user_id'] ?? $this->member_id;
$limit = $this->params['limit'] ?? 20;
$offset = $this->params['offset'] ?? 0;
// (可选获取站点ID和会员ID可以通过事件数据传递
$site_id = $this->params['uniacid'] ?? $this->site_id; // 使用 uniacid, 方便以后迁移而且uniacid 是唯一的, site_id 不是同时被params给过滤了
$member_id = $this->params['member_id'] ?? $this->member_id;
$token = $this->params['token'] ?? $this->token;
// 验证参数
if (empty($conversation_id)) {
return $this->response($this->error('会话ID不能为空'));
}
try {
// 准备事件数据
$event_data = [
'conversation_id' => $conversation_id,
'user_id' => $user_id,
'limit' => $limit,
'offset' => $offset,
'site_id' =>$site_id,
'member_id' => $member_id,
'token' => $token,
];
// 触发获取历史消息事件
$result = Event::trigger('KefuGetHistory', $event_data);
// 处理事件结果
$response = [
'code' => 0,
'message' => 'success',
'data' => []
];
if (is_array($result) && !empty($result)) {
foreach ($result as $res) {
if (isset($res['code']) && $res['code'] < 0) {
$response = $res;
break;
}
if (isset($res['data'])) {
$response['data'] = array_merge($response['data'], $res['data']);
}
}
}
return $this->response($response);
} catch (\Exception $e) {
return $this->response($this->error('请求失败:' . $e->getMessage()));
}
}
}