历史记录

本文档详细介绍了校园领域搜索问答系统中的历史记录管理功能模块的设计与实现。该模块旨在记录和管理用户的对话历史，支持用户查看历史记录和对特定对话内容进行点赞操作。本文将涵盖接口设计、数据库表结构、控制器实现以及服务层实现。

功能概述

历史记录管理模块主要负责以下功能：

• 查看历史记录：允许用户查看特定会话的对话历史，支持分页查询。
• 点赞功能：用户可以对特定的提问和回答进行点赞或取消点赞，帮助系统优化推荐和回答质量。

接口设计

1. 获取历史记录

• 请求方法：GET

• 接口路径：/api/v1/chat/history

• 请求参数：

  参数	类型	描述	是否必填
  session_id	Long	会话 ID	是
  offset	Integer	页码（默认值为 1）	否
  limit	Integer	每页数量（默认值为 100）	否

• 请求示例：

  GET /api/v1/chat/history?session_id=12345&offset=1&limit=20
  

• 响应格式：

  {
    "data": [
      {
        "id": 452075106336137216,
        "role": "user",
        "content": "如何注册课程，以及注册的截止日期和程序是什么？",
        "liked": true,
        "metadata": {
          "some_key": "some_value"
        },
        "create_time": "2024-07-16T12:34:36.651846Z"
      },
      {
        "id": 452075122110914560,
        "role": "assistant",
        "content": "您可以通过学校的在线系统注册课程，截止日期为每学期的最后一周。",
        "liked": false,
        "metadata": {
          "some_key": "some_value"
        },
        "create_time": "2024-07-16T12:35:00.123456Z"
      }
      // 更多历史记录
    ],
    "code": 1,
    "msg": null,
    "ok": true
  }
  

2. 点赞/取消点赞

• 请求方法：POST

• 接口路径：/api/v1/chat/like

• 请求头：

  Content-Type: application/json
  

• 请求体：

  {
    "question_id": "452075106336137216",
    "answer_id": "452075122110914560",
    "like": true
  }
  

• 请求示例：

  POST /api/v1/chat/like
  Content-Type: application/json
  
  {
    "question_id": "452075106336137216",
    "answer_id": "452075122110914560",
    "like": true
  }
  

• 响应格式：

  {
    "data": null,
    "code": 1,
    "msg": null,
    "ok": true
  }
  

控制器实现

ApiChatHandler类负责处理与历史记录管理相关的 HTTP 请求，包括获取历史记录和点赞操作。以下是该类的实现代码及说明：

package com.litongjava.llm.handler;

import com.alibaba.fastjson2.JSONObject;
import com.jfinal.kit.Kv;
import com.litongjava.db.TableResult;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.llm.service.LlmChatHistoryService;
import com.litongjava.llm.service.LlmChatSessionService;
import com.litongjava.model.body.RespBodyVo;
import com.litongjava.tio.boot.http.TioRequestContext;
import com.litongjava.tio.http.common.HttpRequest;
import com.litongjava.tio.http.common.HttpResponse;
import com.litongjava.tio.http.server.util.CORSUtils;
import com.litongjava.tio.utils.json.FastJson2Utils;
import com.litongjava.tio.utils.hutool.StrUtil;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ApiChatHandler {

  /**
   * 获取历史记录
   *
   * @param request HTTP请求对象
   * @return HTTP响应对象
   */
  public HttpResponse getChatHistory(HttpRequest request) {
    HttpResponse response = TioRequestContext.getResponse();
    CORSUtils.enableCORS(response);

    Long session_id = request.getLong("session_id");
    if (session_id == null) {
      return response.fail(RespBodyVo.fail("chat_id can not be empty"));
    }

    Integer pageNo = request.getInt("offset");
    Integer pageSize = request.getInt("limit");

    if (pageNo == null) {
      pageNo = 1;
    }

    if (pageSize == null) {
      pageSize = 100;
    }

    String userId = TioRequestContext.getUserIdString();
    LlmChatSessionService llmChatSessionService = Aop.get(LlmChatSessionService.class);
    boolean exists = llmChatSessionService.exists(session_id, userId);

    if (!exists) {
      log.info("invalid session:{},{}", session_id, userId);
      return response.fail(RespBodyVo.fail("invalid session"));
    }

    LlmChatHistoryService chatHistoryService = Aop.get(LlmChatHistoryService.class);
    RespBodyVo ok = chatHistoryService.getHistory(session_id, pageNo, pageSize);
    return response.setJson(ok);
  }

  /**
   * 点赞或取消点赞
   *
   * @param request HTTP请求对象
   * @return HTTP响应对象
   */
  public HttpResponse like(HttpRequest request) {
    HttpResponse response = TioRequestContext.getResponse();
    CORSUtils.enableCORS(response);

    String bodyString = request.getBodyString();

    JSONObject requestVo = FastJson2Utils.parseObject(bodyString);
    Long questionId = requestVo.getLong("question_id");
    Long answerId = requestVo.getLong("answer_id");
    Boolean like = requestVo.getBoolean("like");

    if (questionId == null) {
      return response.fail(RespBodyVo.fail("question_id can not be empty"));
    }

    if (answerId == null) {
      return response.fail(RespBodyVo.fail("answer_id can not be empty"));
    }

    if (like == null) {
      return response.fail(RespBodyVo.fail("like can not be empty"));
    }

    String userId = TioRequestContext.getUserIdString();

    boolean exists = Db.exists(TableNames.llm_chat_history, "id", questionId);
    if (!exists) {
      return response.fail(RespBodyVo.fail("invalid question id"));
    }

    exists = Db.exists(TableNames.llm_chat_history, "id", answerId);

    if (!exists) {
      return response.fail(RespBodyVo.fail("invalid answer id"));
    }

    Aop.get(LlmChatHistoryService.class).like(questionId, answerId, like, userId);
    return response.setJson(RespBodyVo.ok());
  }
}

控制器代码说明

• getChatHistory：

  • 处理/api/v1/chat/history的GET请求。
  • 从请求中获取参数session_id、offset和limit，设置默认值为 1 和 100。
  • 校验session_id的有效性，确保会话存在且属于当前用户。
  • 调用服务层LlmChatHistoryService.getHistory方法获取历史记录记录。
  • 返回查询结果的响应。

• like：

  • 处理/api/v1/chat/like的POST请求。
  • 从请求体中解析question_id、answer_id和like字段。
  • 校验所有参数的有效性，确保question_id和answer_id存在。
  • 调用服务层LlmChatHistoryService.like方法执行点赞或取消点赞操作。
  • 返回操作结果的响应。

服务层实现

LlmChatHistoryService类负责与数据库交互，处理历史记录记录的查询和点赞操作。以下是该类的实现代码及说明：

package com.litongjava.llm.service;

import java.util.ArrayList;
import java.util.List;

import com.jfinal.kit.Kv;
import com.litongjava.db.TableInput;
import com.litongjava.db.TableResult;
import com.litongjava.db.activerecord.Db;
import com.litongjava.llm.utils.LarkBotUserThumbUtils;
import com.litongjava.max.blog.consts.TableNames;
import com.litongjava.model.body.RespBodyVo;
import com.litongjava.model.page.Page;
import com.litongjava.table.services.ApiTable;
import com.litongjava.tio.utils.thread.TioThreadUtils;
import com.litongjava.db.activerecord.Row;

public class LlmChatHistoryService {

  /**
   * 获取历史记录记录
   *
   * @param session_id 会话ID
   * @param pageNo     页码
   * @param pageSize   每页数量
   * @return 包含历史记录的响应对象
   */
  public RespBodyVo getHistory(Long session_id, int pageNo, int pageSize) {
    TableInput ti = TableInput.create()
        .setColumns("id,role,content,liked,metadata,create_time")
        .setJsonFieldString("metadata")
        .set("session_id", session_id)
        .set("hidden", false)
        .orderBy("create_time").asc(true)
        .pageNo(pageNo).pageSize(pageSize);

    TableResult<Page<Row>> ts = ApiTable.page(TableNames.llm_chat_history, ti);
    List<Row> list = ts.getData().getList();
    List<Kv> kvs = new ArrayList<>();
    for (Row record : list) {
      kvs.add(record.toKv());
    }
    return RespBodyVo.ok(kvs);
  }

  /**
   * 保存用户提问
   *
   * @param id           提问ID
   * @param sessionId    会话ID
   * @param textQuestion 用户提问内容
   * @return 保存结果
   */
  public TableResult<Kv> saveUser(Long id, Long sessionId, String textQuestion) {
    TableInput ti = TableInput.by("id", id)
        .set("content", textQuestion)
        .set("role", "user")
        .set("session_id", sessionId);
    TableResult<Kv> ts = ApiTable.save(TableNames.llm_chat_history, ti);
    return ts;
  }

  /**
   * 保存助手回答
   *
   * @param id        回答ID
   * @param sessionId 会话ID
   * @param message   助手回答内容
   * @return 保存结果
   */
  public TableResult<Kv> saveAssistant(Long id, Long sessionId, String message) {
    TableInput ti = TableInput.by("id", id)
        .set("content", message)
        .set("role", "assistant")
        .set("session_id", sessionId);
    TableResult<Kv> ts = ApiTable.save(TableNames.llm_chat_history, ti);
    return ts;
  }

  /**
   * 点赞或取消点赞
   *
   * @param questionId 问题ID
   * @param answerId   回答ID
   * @param like       是否点赞
   * @param userId     用户ID
   */
  public void like(Long questionId, Long answerId, Boolean like, String userId) {
    String sql = "update %s set liked=? where id=?";
    sql = String.format(sql, TableNames.llm_chat_history);
    Db.updateBySql(sql, like, questionId);
    Db.updateBySql(sql, like, answerId);

    if (like) {
      TioThreadUtils.submit(() -> {
        String queryContentSql = "select content from %s where id=?";
        queryContentSql = String.format(queryContentSql, TableNames.llm_chat_history);

        String question = Db.queryStr(queryContentSql, questionId);
        String answer = Db.queryStr(queryContentSql, answerId);

        StringBuffer messageText = new StringBuffer();
        if (like) {
          messageText.append("like").append("\r\n");
        } else {
          messageText.append("dislike").append("\r\n");
        }
        messageText.append("user_id:").append(userId).append("\r\n");
        messageText.append("question_id:").append(questionId).append("\r\n");
        messageText.append("question:").append(question).append("\r\n\r\n");
        messageText.append("answer_id:").append(answerId).append("\r\n");
        messageText.append("answer:").append(answer).append("\r\n");

        LarkBotUserThumbUtils.send(messageText.toString());
      });
    }
  }
}

服务层代码说明

• getHistory：

  • 构建查询条件，设置需要查询的字段id, role, content, liked, metadata, create_time。
  • 过滤条件包括session_id和hidden = false，确保只获取当前会话且未隐藏的对话记录。
  • 设置分页参数pageNo和pageSize，并按照create_time升序排序。
  • 调用ApiTable.page方法进行分页查询。
  • 将查询结果转换为List<Kv>格式，便于前端使用。
  • 返回包含历史记录的响应对象。

• saveUser：

  • 构建用户提问的Row对象，设置id、content、role和session_id。
  • 调用ApiTable.save方法将提问记录保存到数据库。
  • 返回保存结果。

• saveAssistant：

  • 构建助手回答的Row对象，设置id、content、role和session_id。
  • 调用ApiTable.save方法将回答记录保存到数据库。
  • 返回保存结果。

• like：

  • 根据传入的questionId和answerId，更新对应记录的liked字段。
  • 如果是点赞操作，异步执行以下步骤：
    • 查询问题和回答的内容。
    • 构建点赞信息的消息文本，包括用户 ID、问题 ID 及内容、回答 ID 及内容。
    • 调用LarkBotUserThumbUtils.send方法将消息发送到指定渠道（如企业微信或钉钉机器人）。
  • 该功能有助于系统收集用户反馈，优化回答质量和推荐算法。

总结

本文档详细介绍了校园领域搜索问答系统中历史记录管理功能模块的设计与实现。通过定义清晰的 API 接口、设计合理的数据库表结构以及实现高效的控制器和服务层代码，该模块能够有效地记录和管理用户的对话历史，支持用户查看历史记录和进行点赞操作。未来，可以进一步扩展历史记录的功能，例如支持关键字搜索、导出历史记录以及与其他模块的深度集成，以提升系统的整体用户体验和功能丰富性。