注释添加

ruoyi-admin/src/main/resources/application-prod.yml

@@ -51,8 +51,8 @@ spring:
           # jdbc 所有参数配置参考 https://lionli.blog.csdn.net/article/details/122018562
           # rewriteBatchedStatements=true 批处理优化 大幅提升批量插入更新删除性能(对数据库有性能损耗 使用批量操作应考虑性能问题)
           url: jdbc:mysql://localhost:3306/aitalk?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8&autoReconnect=true&rewriteBatchedStatements=true&allowPublicKeyRetrieval=true&nullCatalogMeansCurrent=true
-          username: aiTalk
-          password: X4CmF85A2M6nDLJt
+          username: aitalk
+          password: tAthHTAAhSkMJ3MT
 #        # 从库数据源
 #        slave:
 #          lazy: true

ruoyi-modules/yp-talk/src/main/java/org/dromara/talk/controller/admin/TalkAgentController.java

@@ -44,6 +44,9 @@ public class TalkAgentController extends BaseController {
 
     /**
      * 查询客服配置列表
+     *
+     * @param bo 查询条件对象，包含客服名称、性别、状态等筛选条件
+     * @param pageQuery 分页参数，包含页码和每页数量
      */
     @SaCheckPermission("talk:agent:list")
     @GetMapping("/list")
@@ -53,6 +56,9 @@ public class TalkAgentController extends BaseController {
 
     /**
      * 导出客服配置列表
+     *
+     * @param bo 查询条件对象，包含客服名称、性别、状态等筛选条件
+     * @param response HTTP响应对象，用于输出Excel文件流
      */
     @SaCheckPermission("talk:agent:export")
     @Log(title = "客服配置", businessType = BusinessType.EXPORT)
@@ -76,6 +82,8 @@ public class TalkAgentController extends BaseController {
 
     /**
      * 新增客服配置
+     *
+     * @param bo 客服配置对象，包含客服名称、性别、头像、欢迎语、TTS参数等信息
      */
     @SaCheckPermission("talk:agent:add")
     @Log(title = "客服配置", businessType = BusinessType.INSERT)
@@ -87,6 +95,8 @@ public class TalkAgentController extends BaseController {
 
     /**
      * 修改客服配置
+     *
+     * @param bo 客服配置对象，包含客服ID及需要修改的字段（名称、性别、头像、欢迎语、TTS参数等）
      */
     @SaCheckPermission("talk:agent:edit")
     @Log(title = "客服配置", businessType = BusinessType.UPDATE)

ruoyi-modules/yp-talk/src/main/java/org/dromara/talk/controller/admin/TalkSessionController.java

@@ -38,6 +38,9 @@ public class TalkSessionController extends BaseController {
 
     /**
      * 查询对话会话列表
+     *
+     * @param bo 查询条件对象，包含会话ID、客服ID、用户ID等筛选条件
+     * @param pageQuery 分页参数，包含页码和每页数量
      */
     @SaCheckPermission("talk:session:list")
     @GetMapping("/list")
@@ -47,6 +50,9 @@ public class TalkSessionController extends BaseController {
 
     /**
      * 导出对话会话列表
+     *
+     * @param bo 查询条件对象，包含会话ID、客服ID、用户ID等筛选条件
+     * @param response HTTP响应对象，用于输出Excel文件流
      */
     @SaCheckPermission("talk:session:export")
     @Log(title = "对话会话", businessType = BusinessType.EXPORT)
@@ -70,6 +76,8 @@ public class TalkSessionController extends BaseController {
 
     /**
      * 新增对话会话
+     *
+     * @param bo 会话对象，包含会话ID、客服ID、用户ID、开始时间等信息
      */
     @SaCheckPermission("talk:session:add")
     @Log(title = "对话会话", businessType = BusinessType.INSERT)
@@ -81,6 +89,8 @@ public class TalkSessionController extends BaseController {
 
     /**
      * 修改对话会话
+     *
+     * @param bo 会话对象，包含会话ID及需要修改的字段（结束时间、对话内容等）
      */
     @SaCheckPermission("talk:session:edit")
     @Log(title = "对话会话", businessType = BusinessType.UPDATE)

ruoyi-modules/yp-talk/src/main/java/org/dromara/talk/controller/admin/TalkUserController.java

@@ -38,6 +38,9 @@ public class TalkUserController extends BaseController {
 
     /**
      * 查询对话用户列表
+     *
+     * @param bo 查询条件对象，包含用户名、手机号、状态等筛选条件
+     * @param pageQuery 分页参数，包含页码和每页数量
      */
     @SaCheckPermission("system:user:list")
     @GetMapping("/list")
@@ -47,6 +50,9 @@ public class TalkUserController extends BaseController {
 
     /**
      * 导出对话用户列表
+     *
+     * @param bo 查询条件对象，包含用户名、手机号、状态等筛选条件
+     * @param response HTTP响应对象，用于输出Excel文件流
      */
     @SaCheckPermission("system:user:export")
     @Log(title = "对话用户", businessType = BusinessType.EXPORT)
@@ -70,6 +76,8 @@ public class TalkUserController extends BaseController {
 
     /**
      * 新增对话用户
+     *
+     * @param bo 用户对象，包含用户名、密码、手机号、状态等信息
      */
     @SaCheckPermission("system:user:add")
     @Log(title = "对话用户", businessType = BusinessType.INSERT)
@@ -81,6 +89,8 @@ public class TalkUserController extends BaseController {
 
     /**
      * 修改对话用户
+     *
+     * @param bo 用户对象，包含用户ID及需要修改的字段（用户名、密码、手机号、状态等）
      */
     @SaCheckPermission("system:user:edit")
     @Log(title = "对话用户", businessType = BusinessType.UPDATE)

ruoyi-modules/yp-talk/src/main/java/org/dromara/talk/controller/api/ChatController.java

@@ -130,7 +130,7 @@ public class ChatController {
      * 用户挂断电话后，更新会话结束时间并将客服状态改回0（正常）
      *
      * @param id      客服ID
-     * @param request 包含sessionId的请求体
+     * @param request 包含sessionId与chatHistory数组的请求体
      * @return 更新结果
      */
     @PostMapping("/agent/{id}/hangup")
@@ -180,6 +180,15 @@ public class ChatController {
     /**
      * 流式处理用户消息
      * 使用SSE实时推送文本和音频数据
+     *
+     * @param request 请求参数，包含：
+     *                - message: 用户消息内容
+     *                - agentId: 客服ID
+     *                - agentGender: 客服性别（不需要用户传递前端做处理）
+     *                - ttsVcnList: TTS发音人列表 （不需要用户传递前端做处理）
+     *                - conversationId: 会话ID
+     *                - isGreeting: 是否为欢迎语
+     *                - requestId: 请求ID
      */
     @PostMapping("/message/stream")
     public SseEmitter handleMessageStream(@RequestBody Map<String, Object> request) {

ruoyi-modules/yp-talk/src/main/java/org/dromara/talk/controller/api/TalkAuthController.java

@@ -42,6 +42,9 @@ public class TalkAuthController {
 
     /**
      * 登录
+     *
+     * @param request 登录请求参数，包含username（用户名）和password（密码）
+     * @param clientId 客户端ID，用于验证客户端身份
      */
     @PostMapping("/login")
     public R<Map<String, Object>> login(@RequestBody Map<String, String> request, @RequestHeader(value = LoginHelper.CLIENT_KEY, required = false) String clientId) {