Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
  • 01_tio-boot 简介

    • tio-boot:新一代高性能 Java Web 开发框架
    • tio-boot 入门示例
    • Tio-Boot 配置 : 现代化的配置方案
    • tio-boot 整合 Logback
    • tio-boot 整合 hotswap-classloader 实现热加载
    • 自行编译 tio-boot
    • 最新版本
    • 开发规范
  • 02_部署

    • 使用 Maven Profile 实现分环境打包 tio-boot 项目
    • Maven 项目配置详解:依赖与 Profiles 配置
    • tio-boot 打包成 FastJar
    • 使用 GraalVM 构建 tio-boot Native 程序
    • 使用 Docker 部署 tio-boot
    • 部署到 Fly.io
    • 部署到 AWS Lambda
    • 到阿里云云函数
    • 使用 Deploy 工具部署
    • 胖包与瘦包的打包与部署
    • 使用 Jenkins 部署 Tio-Boot 项目
    • 使用 Nginx 反向代理 Tio-Boot
    • 使用 Supervisor 管理 Java 应用
  • 03_配置

    • 配置参数
    • 服务器监听器
    • 内置缓存系统 AbsCache
    • 使用 Redis 作为内部 Cache
    • 静态文件处理器
    • 基于域名的静态资源隔离
    • DecodeExceptionHandler
  • 04_原理

    • 生命周期
    • 请求处理流程
    • 重要的类
  • 05_json

    • Json
    • 接受 JSON 和响应 JSON
    • 响应实体类
  • 06_web

    • 概述
    • 文件上传
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • /zh/06_web/19.html
    • 全局异常处理器
    • 异步
    • 动态 返回 CSS 实现
    • 返回图片
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • 接口访问统计
    • 接口请求和响应数据记录
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 跨域
    • 添加 Controller
    • 常用工具类
    • HTTP Basic 认证
    • WebJars
    • JProtobuf
  • 07_validate

    • 数据紧校验规范
    • 参数校验
  • 08_websocket

    • 使用 tio-boot 搭建 WebSocket 服务
    • WebSocket 聊天室项目示例
  • 09_java-db

    • java‑db
    • 操作数据库入门示例
    • SQL 模板
    • 数据源配置与使用
    • ActiveRecord
    • Model
    • 生成器与 Model
    • Db 工具类
    • 批量操作
    • 数据库事务处理
    • Cache 缓存
    • Dialect 多数据库支持
    • 表关联操作
    • 复合主键
    • Oracle 支持
    • Enjoy SQL 模板
    • Java-DB 整合 Enjoy 模板最佳实践
    • 多数据源支持
    • 独立使用 ActiveRecord
    • 调用存储过程
    • java-db 整合 Guava 的 Striped 锁优化
    • 生成 SQL
    • 通过实体类操作数据库
    • java-db 读写分离
    • Spring Boot 整合 Java-DB
    • like 查询
    • 常用操作示例
    • Druid 监控集成指南
    • SQL 统计
  • 10_api-table

    • ApiTable 概述
    • 使用 ApiTable 连接 SQLite
    • 使用 ApiTable 连接 Mysql
    • 使用 ApiTable 连接 Postgres
    • 使用 ApiTable 连接 TDEngine
    • 使用 api-table 连接 oracle
    • 使用 api-table 连接 mysql and tdengine 多数据源
    • EasyExcel 导出
    • EasyExcel 导入
    • TQL(Table SQL)前端输入规范
    • ApiTable 实现增删改查
    • 数组类型
    • 单独使用 ApiTable
  • 11_aop

    • JFinal-aop
    • Aop 工具类
    • 配置
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 原理解析
  • 12_cache

    • Caffine
    • Jedis-redis
    • hutool RedisDS
    • Redisson
    • Caffeine and redis
    • CacheUtils 工具类
    • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 使用 java-db 整合 ehcache
    • 使用 java-db 整合 redis
    • Java DB Redis 相关 Api
    • redis 使用示例
  • 13_认证和权限

    • hutool-JWT
    • FixedTokenInterceptor
    • 使用内置 TokenManager 实现登录
    • 用户系统
    • 重置密码
    • 匿名登录
    • Google 登录
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
    • 短信登录
    • 移动端微信登录实现指南
    • 移动端重置密码
  • 14_i18n

    • i18n
  • 15_enjoy

    • tio-boot 整合 Enjoy 模版引擎文档
    • 引擎配置
    • 表达式
    • 指令
    • 注释
    • 原样输出
    • Shared Method 扩展
    • Shared Object 扩展
    • Extension Method 扩展
    • Spring boot 整合
    • 独立使用 Enjoy
    • tio-boot enjoy 自定义指令 localeDate
    • PromptEngine
    • Enjoy 入门示例-擎渲染大模型请求体
    • Enjoy 使用示例
  • 16_定时任务

    • Quartz 定时任务集成指南
    • 分布式定时任务 xxl-jb
    • cron4j 使用指南
  • 17_tests

    • TioBootTest 类
  • 18_tio

    • TioBootServer
    • tio-core
    • 内置 TCP 处理器
    • 独立启动 UDPServer
    • 使用内置 UDPServer
    • t-io 消息处理流程
    • tio-运行原理详解
    • TioConfig
    • ChannelContext
    • Tio 工具类
    • 业务数据绑定
    • 业务数据解绑
    • 发送数据
    • 关闭连接
    • Packet
    • 监控: 心跳
    • 监控: 客户端的流量数据
    • 监控: 单条 TCP 连接的流量数据
    • 监控: 端口的流量数据
    • 单条通道统计: ChannelStat
    • 所有通道统计: GroupStat
    • 资源共享
    • 成员排序
    • ssl
    • DecodeRunnable
    • 使用 AsynchronousSocketChannel 响应数据
    • 拉黑 IP
    • 深入解析 Tio 源码:构建高性能 Java 网络应用
  • 19_aio

    • ByteBuffer
    • AIO HTTP 服务器
    • 自定义和线程池和池化 ByteBuffer
    • AioHttpServer 应用示例 IP 属地查询
    • 手写 AIO Http 服务器
  • 20_netty

    • Netty TCP Server
    • Netty Web Socket Server
    • 使用 protoc 生成 Java 包文件
    • Netty WebSocket Server 二进制数据传输
    • Netty 组件详解
  • 21_netty-boot

    • Netty-Boot
    • 原理解析
    • 整合 Hot Reload
    • 整合 数据库
    • 整合 Redis
    • 整合 Elasticsearch
    • 整合 Dubbo
    • Listener
    • 文件上传
    • 拦截器
    • Spring Boot 整合 Netty-Boot
    • SSL 配置指南
    • ChannelInitializer
    • Reserve
  • 22_MQ

    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_tio-utils

    • tio-utils
    • HttpUtils
    • Notification
    • 邮箱
    • JSON
    • 读取文件
    • Base64
    • 上传和下载
    • Http
    • Telegram
    • RsaUtils
    • EnvUtils 使用文档
    • 系统监控
    • 毫秒并发 ID (MCID) 生成方案
  • 24_tio-http-server

    • 使用 Tio-Http-Server 搭建简单的 HTTP 服务
    • tio-boot 添加 HttpRequestHandler
    • 在 Android 上使用 tio-boot 运行 HTTP 服务
    • tio-http-server-native
    • handler 常用操作
  • 25_tio-websocket

    • WebSocket 服务器
    • WebSocket Client
  • 26_tio-im

    • 通讯协议文档
    • ChatPacket.proto 文档
    • java protobuf
    • 数据表设计
    • 创建工程
    • 登录
    • 历史消息
    • 发消息
  • 27_mybatis

    • Tio-Boot 整合 MyBatis
    • 使用配置类方式整合 MyBatis
    • 整合数据源
    • 使用 mybatis-plus 整合 tdengine
    • 整合 mybatis-plus
  • 28_mongodb

    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 29_elastic-search

    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 30_magic-script

    • tio-boot 整合 magic-script
  • 31_groovy

    • tio-boot 整合 Groovy
  • 32_firebase

    • 整合 google firebase
    • Firebase Storage
    • Firebase Authentication
    • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
    • 导出用户
    • 注册回调
    • 登录注册
  • 33_文件存储

    • 文件上传数据表
    • 本地存储
    • 使用 AWS S3 存储文件并整合到 Tio-Boot 项目中
    • 存储文件到 腾讯 COS
  • 34_spider

    • jsoup
    • 爬取 z-lib.io 数据
    • 整合 WebMagic
    • WebMagic 示例:爬取学校课程数据
    • Playwright
    • Flexmark (Markdown 处理器)
    • tio-boot 整合 Playwright
    • 缓存网页数据
  • 36_integration_thirty_party

    • tio-boot 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
  • 37_dubbo

    • 概述
    • dubbo 2.6.0
    • dubbo 2.6.0 调用过程
    • dubbo 3.2.0
  • 38_spring

    • Spring Boot Web 整合 Tio Boot
    • spring-boot-starter-webflux 整合 tio-boot
    • Tio Boot 整合 Spring Boot Starter
    • Tio Boot 整合 Spring Boot Starter Data Redis 指南
  • 39_spring-cloud

    • tio-boot spring-cloud
  • 40_mysql

    • 使用 Docker 运行 MySQL
    • /zh/42_mysql/02.html
  • 41_postgresql

    • PostgreSQL 安装
    • PostgreSQL 主键自增
    • PostgreSQL 日期类型
    • Postgresql 金融类型
    • PostgreSQL 数组类型
    • PostgreSQL 全文检索
    • PostgreSQL 查询优化
    • 获取字段类型
    • PostgreSQL 向量
    • PostgreSQL 优化向量查询
    • PostgreSQL 其他
  • 43_oceanbase

    • 快速体验 OceanBase 社区版
    • 快速上手 OceanBase 数据库单机部署与管理
    • 诊断集群性能
    • 优化 SQL 性能指南
    • /zh/43_oceanbase/05.html
  • 50_media

    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • /zh/50_media/03.html
  • 51_asr

    • Whisper-JNI
  • 54_native-media

    • java-native-media
    • JNI 入门示例
    • mp3 拆分
    • mp4 转 mp3
    • 使用 libmp3lame 实现高质量 MP3 编码
    • Linux 编译
    • macOS 编译
    • 从 JAR 包中加载本地库文件
    • 支持的音频和视频格式
    • 任意格式转为 mp3
    • 通用格式转换
    • 通用格式拆分
    • 视频合并
    • VideoToHLS
    • split_video_to_hls 支持其他语言
    • 持久化 HLS 会话
  • 55_telegram4j

    • 数据库设计
    • /zh/55_telegram4j/02.html
    • 基于 MTProto 协议开发 Telegram 翻译机器人
    • 过滤旧消息
    • 保存机器人消息
    • 定时推送
    • 增加命令菜单
    • 使用 telegram-Client
    • 使用自定义 StoreLayout
    • 延迟测试
    • Reactor 错误处理
    • Telegram4J 常见错误处理指南
  • 56_telegram-bots

    • TelegramBots 入门指南
    • 使用工具库 telegram-bot-base 开发翻译机器人
  • 60_LLM

    • 简介
    • AI 问答
    • /zh/60_LLM/03.html
    • /zh/60_LLM/04.html
    • 增强检索(RAG)
    • 结构化数据检索
    • 搜索+AI
    • 集成第三方 API
    • 后置处理
    • 推荐问题生成
    • 连接代码执行器
    • 避免 GPT 混乱
    • /zh/60_LLM/13.html
  • 61_ai_agent

    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • 对接 Perplexity API
    • 意图识别与生成提示词
    • 智能问答模块设计与实现
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 通用搜索
    • /zh/61_ai_agent/15.html
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 16
  • 62_translator

    • 简介
  • 63_knowlege_base

    • 数据库设计
    • 用户登录实现
    • 模型管理
    • 知识库管理
    • 文档拆分
    • 片段向量
    • 命中测试
    • 文档管理
    • 片段管理
    • 问题管理
    • 应用管理
    • 向量检索
    • 推理问答
    • 问答模块
    • 统计分析
    • 用户管理
    • api 管理
    • 存储文件到 S3
    • 文档解析优化
    • 片段汇总
    • 段落分块与检索
    • 多文档解析
    • 对话日志
    • 检索性能优化
    • Milvus
    • 文档解析方案和费用对比
    • 离线运行向量模型
  • 64_ai-search

    • ai-search 项目简介
    • ai-search 数据库文档
    • ai-search SearxNG 搜索引擎
    • ai-search Jina Reader API
    • ai-search Jina Search API
    • ai-search 搜索、重排与读取内容
    • ai-search PDF 文件处理
    • ai-search 推理问答
    • Google Custom Search JSON API
    • ai-search 意图识别
    • ai-search 问题重写
    • ai-search 系统 API 接口 WebSocket 版本
    • ai-search 搜索代码实现 WebSocket 版本
    • ai-search 生成建议问
    • ai-search 生成问题标题
    • ai-search 历史记录
    • Discover API
    • 翻译
    • Tavily Search API 文档
    • 对接 Tavily Search
    • 火山引擎 DeepSeek
    • 对接 火山引擎 DeepSeek
    • ai-search 搜索代码实现 SSE 版本
    • jar 包部署
    • Docker 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 65_java-linux

    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • MCP 协议
    • Cline 提示词
    • Cline 提示词-中文版本
  • 66_manim

    • 简介
    • Manim 开发环境搭建
    • 生成场景提示词
    • 生成代码
    • 完整脚本示例
    • 语音合成系统
    • Fish.audio TTS 接口说明文档与 Java 客户端封装
    • 整合 fishaudio 到 java-uni-ai-server 项目
    • 执行 Python (Manim) 代码
    • 使用 SSE 流式传输生成进度的实现文档
    • 整合全流程完整文档
    • HLS 动态推流技术文档
    • manim 分场景生成代码
    • 分场景运行代码及流式播放支持
    • 分场景业务端完整实现流程
    • Maiim布局管理器
    • 仅仅生成场景代码
    • 使用 modal 运行 manim 代码
    • Python 使用 Modal GPU 加速渲染
    • Modal 平台 GPU 环境下运行 Manim
    • Modal Manim OpenGL 安装与使用
    • 优化 GPU 加速
    • 生成视频封面流程
    • Java 调用 manim 命令 执行代码 生成封面
    • Manim 图像生成服务客户端文档
    • manim render help
    • 显示 中文公式
    • manimgl
    • EGL
    • /zh/66_manim/30.html
    • /zh/66_manim/31.html
    • 成本核算
    • /zh/66_manim/33.html
  • 70_tio-boot-admin

    • 入门指南
    • 初始化数据
    • token 存储
    • 与前端集成
    • 文件上传
    • 网络请求
    • 图片管理
    • /zh/70_tio-boot-admin/08.html
    • Word 管理
    • PDF 管理
    • 文章管理
    • 富文本编辑器
  • 71_tio-boot

    • /zh/71_tio-boot/01.html
    • Swagger 整合到 Tio-Boot 中的指南
    • HTTP/1.1 Pipelining 性能测试报告
  • 80_性能测试

    • 压力测试 - tio-http-serer
    • 压力测试 - tio-boot
    • 压力测试 - tio-boot-native
    • 压力测试 - netty-boot
    • 性能测试对比
    • TechEmpower FrameworkBenchmarks
    • 压力测试 - tio-boot 12 C 32G
  • 99_案例

    • 封装 IP 查询服务
    • tio-boot 案例 - 全局异常捕获与企业微信群通知
    • tio-boot 案例 - 文件上传和下载
    • tio-boot 案例 - 整合 ant design pro 增删改查
    • tio-boot 案例 - 流失响应
    • tio-boot 案例 - 增强检索
    • tio-boot 案例 - 整合 function call
    • tio-boot 案例 - 定时任务 监控 PostgreSQL、Redis 和 Elasticsearch
    • Tio-Boot 案例:使用 SQLite 整合到登录注册系统
    • tio-boot 案例 - 执行 shell 命令

片段汇总

  • 项目目标
  • 系统核心概念
  • 功能实现步骤
  • 片段汇总
    • 功能背景
    • 实现流程
    • 提示词
    • 代码解析
  • 汇总前后的片段对比
    • 汇总前 max_kb_paragraph_summary_cache 表内容示例
    • 汇总后
  • 结论

项目目标

本项目旨在构建一个功能完备的 RAG(Retrieval-Augmented Generation)系统,主要目标包括:

  • 知识库管理:支持创建、更新和删除知识库,便于用户高效维护内容。
  • 文档处理:包括文档的拆分、片段的向量化处理,以提升检索效率和准确性。
  • 问答系统:提供高效的向量检索和实时生成回答的能力,支持复杂汇总类问题的处理。
  • 系统优化:通过统计分析和推理问答调试,不断优化系统性能和用户体验。

系统核心概念

在 RAG 系统中,以下是几个核心概念:

  • 应用:知识库的集合。每个应用可以自定义提示词,以满足不同的个性化需求。
  • 知识库:由多个文档组成,便于用户对内容进行分类和管理。
  • 文档:系统中对应的真实文档内容。
  • 片段:文档经过拆分后的最小内容单元,用于更高效的处理和检索。

功能实现步骤

  1. 数据库设计 查看 01.md
    设计并实现项目所需的数据表结构与数据库方案,为后续的数据操作打下坚实基础。

  2. 用户登录 查看 02.md
    实现了安全可靠的用户认证系统,保护用户数据并限制未经授权的访问。

  3. 模型管理 查看 03.md
    支持针对不同平台的模型(如 OpenAI、Google Gemini、Claude)进行管理与配置。

  4. 知识库管理 查看 04.md
    提供创建、更新及删除知识库的功能,方便用户维护与管理文档内容。

  5. 文档拆分 查看 05.md
    可将文档拆分为多个片段,便于后续向量化和检索操作。

  6. 片段向量 查看 06.md
    将文本片段进行向量化处理,以便进行语义相似度计算及高效检索。

  7. 命中率测试 查看 07.md
    通过语义相似度和 Top-N 算法,检索并返回与用户问题最相关的文档片段,用于评估检索的准确性。

  8. 文档管理 查看 08.md
    提供上传和管理文档的功能,上传后可自动拆分为片段便于进一步处理。

  9. 片段管理 查看 09.md
    允许对已拆分的片段进行增、删、改、查等操作,确保内容更新灵活可控。

  10. 问题管理 查看 10.md
    为片段指定相关问题,以提升检索时的准确性与关联度。

  11. 应用管理 查看 11.md
    提供创建和配置应用(智能体)的功能,并可关联指定模型和知识库。

  12. 向量检索 查看 12.md
    基于语义相似度,在知识库中高效检索与用户问题最匹配的片段。

  13. 推理问答调试 查看 13.md
    提供检索与问答性能的评估工具,帮助开发者进行系统优化与调试。

  14. 对话问答 查看 14.md
    为用户提供友好的人机交互界面,结合检索到的片段与用户问题实时生成回答。

  15. 统计分析 查看 15.md
    对用户的提问与系统回答进行数据化分析,并以可视化图表的形式呈现系统使用情况。

  16. 用户管理 查看 16.md
    提供多用户管理功能,包括用户的增删改查及权限控制。

  17. API 管理 查看 17.md
    对外提供标准化 API,便于外部系统集成和调用本系统的功能。

  18. 存储文件到 S3 查看 18.md
    将用户上传的文件存储至 S3 等对象存储平台,提升文件管理的灵活性与可扩展性。

  19. 文档解析优化 查看 19.md
    介绍与对比常见的文档解析方案,并提供提升文档解析速度和准确性的优化建议。

  20. 片段汇总 查看 20.md
    对片段内容进行汇总,以提升总结类问题的查询与回答效率。

  21. 文档多分块与检索 查看 21.md
    将片段进一步拆分为句子并进行向量检索,提升检索的准确度与灵活度。

  22. 多文档支持 查看 22.md
    兼容多种文档格式,包括 .doc, .docx, .xls, .xlsx, .ppt, .pptx 等。

  23. 对话日志 查看 23.md
    记录并展示对话日志,用于后续分析和问题回溯。

  24. 检索性能优化 查看 24.md
    提供整库扫描和分区检索等多种方式,进一步提高检索速度和效率。

  25. Milvus 查看 25.md
    将向量数据库切换至 Milvus,以在大规模向量检索场景中获得更佳的性能与可扩展性。

  26. 文档解析方案和费用对比 查看 26.md
    对比不同文档解析方案在成本、速度、稳定性等方面的差异,为用户提供更加经济高效的选择。

  27. 爬取网页数据 查看 27.md
    支持从网页中抓取所需内容,后续处理流程与本地文档一致:分段、向量化、存储与检索。

片段汇总

功能背景

在 RAG 系统中,向量检索对于单个问题的检索准确度较高,但在处理复杂的汇总类问题时,检索的准确度会有所下降。这是因为大模型将多个片段添加到上下文中,导致信息的冗余和干扰。为了解决这一问题,本项目引入了片段汇总功能,通过对大量片段内容进行总结,提高复杂问题的回答准确率。

实现流程

  1. 文档拆分:将原始文档拆分为多个片段,每个片段约 1000 个 token。
  2. 片段总结:
    • 使用预定义的总结提示词对每个片段内容进行总结,生成简洁且结构化的摘要。
    • 将生成的摘要存储到 max_kb_sentence 表中,类型设置为 2,表示为总结内容。
  3. 向量化处理:
    • 对总结后的片段内容进行向量化,以便后续的语义相似度计算和高效检索。
  4. 存储与管理:
    • 将总结内容及其向量化结果存储到数据库中,便于快速检索和管理。

提示词

ParagraphSummaryPrompt.txt 文件内容

Summarize the following text in a concise, structured manner, ensuring that it covers the core themes and key information, suitable for use in vector similarity calculations:
Summary of

代码解析

MaxKbParagraphSummaryService 类

该类负责对段落内容进行总结,并将总结结果缓存到数据库中,以提高总结效率和避免重复请求。

package com.litongjava.maxkb.service.kb;

import java.util.concurrent.locks.Lock;

import com.google.common.util.concurrent.Striped;
import com.litongjava.db.activerecord.Db;
import com.litongjava.maxkb.model.MaxKbParagraphSummaryCache;
import com.litongjava.openai.chat.OpenAiChatResponseVo;
import com.litongjava.openai.client.OpenAiClient;
import com.litongjava.template.PromptEngine;
import com.litongjava.tio.utils.crypto.Md5Utils;
import com.litongjava.tio.utils.snowflake.SnowflakeIdUtils;

public class MaxKbParagraphSummaryService {

  private static final Striped<Lock> locks = Striped.lock(1024);
  String prompt = PromptEngine.renderToString("ParagraphSummaryPrompt.txt");
  String selectContentSql = "select content from max_kb_paragraph_summary_cache where md5=?";

  public String summary(String paragraphContent) {
    String md5 = Md5Utils.getMD5(paragraphContent);
    String summaryContent = Db.queryStr(selectContentSql, md5);
    if (summaryContent != null) {
      return summaryContent;
    }

    prompt += "\r\n\r\n" + paragraphContent;
    Lock lock = locks.get(md5);
    lock.lock();
    try {
      summaryContent = Db.queryStr(selectContentSql, md5);
      if (summaryContent != null) {
        return summaryContent;
      }

      OpenAiChatResponseVo chat = null;
      long start = System.currentTimeMillis();
      try {
        chat = OpenAiClient.chat(prompt);
      } catch (Exception e) {
        try {
          chat = OpenAiClient.chat(prompt);
        } catch (Exception e1) {
          chat = OpenAiClient.chat(prompt);
        }
      }
      long end = System.currentTimeMillis();
      if (chat != null) {
        summaryContent = chat.getChoices().get(0).getMessage().getContent();
        MaxKbParagraphSummaryCache model = new MaxKbParagraphSummaryCache();
        model.setId(SnowflakeIdUtils.id()).setMd5(md5).setSrc(paragraphContent).setContent(summaryContent);
        model.setElapsed((end - start)).setSystemFingerprint(chat.getSystem_fingerprint()).setModel(chat.getModel())
            //
            .setCompletionTokens(chat.getUsage().getCompletion_tokens())
            //
            .setPromptTokens(chat.getUsage().getPrompt_tokens())
            //
            .setTotalTokens(chat.getUsage().getTotal_tokens());
        model.save();
        return summaryContent;
      }
    } finally {
      lock.unlock();
    }
    return null;
  }
}

代码说明:

  • 锁机制:使用 Striped<Lock> 确保在多线程环境下对同一段落内容的总结请求不会重复执行,避免资源浪费。
  • 摘要缓存:在对段落内容进行总结前,首先检查数据库中是否已存在该段落的摘要(通过 MD5 校验),若存在则直接返回,避免重复调用外部 API。
  • 外部 API 调用:若摘要不存在,则调用 OpenAI 的 Chat API 生成摘要,并将结果存储到 max_kb_paragraph_summary_cache 表中,以供后续使用。

MaxKbSentenceService 类

该类负责将段落摘要转换为句子级别的记录,并进行向量化处理,最终存储到数据库中。

package com.litongjava.maxkb.service.kb;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletionService;
import java.util.concurrent.ExecutorCompletionService;
import java.util.concurrent.Future;

import org.postgresql.util.PGobject;

import com.litongjava.db.activerecord.Db;
import com.litongjava.db.activerecord.Row;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.maxkb.constant.TableNames;
import com.litongjava.maxkb.model.MaxKbSentence;
import com.litongjava.maxkb.utils.ExecutorServiceUtils;
import com.litongjava.tio.utils.crypto.Md5Utils;
import com.litongjava.tio.utils.snowflake.SnowflakeIdUtils;

import dev.langchain4j.data.document.Document;
import dev.langchain4j.data.document.DocumentSplitter;
import dev.langchain4j.data.document.splitter.DocumentSplitters;
import dev.langchain4j.data.segment.TextSegment;
import dev.langchain4j.model.openai.OpenAiTokenizer;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class MaxKbSentenceService {
  MaxKbEmbeddingService maxKbEmbeddingService = Aop.get(MaxKbEmbeddingService.class);
  CompletionService<MaxKbSentence> completionServiceSentence = new ExecutorCompletionService<>(ExecutorServiceUtils.getExecutorService());

  CompletionService<Row> completionServiceRow = new ExecutorCompletionService<>(ExecutorServiceUtils.getExecutorService());
  MaxKbParagraphSummaryService maxKbParagraphSummaryService = Aop.get(MaxKbParagraphSummaryService.class);

  public boolean summaryToSentenceAndSave(Long dataset_id, String modelName, List<Row> paragraphRecords, Long documentIdFinal) {
    boolean transactionSuccess;

    // Step 1: Generate summaries asynchronously
    List<Future<MaxKbSentence>> summaryFutures = new ArrayList<>(paragraphRecords.size());

    for (Row paragraph : paragraphRecords) {
      Future<MaxKbSentence> future = completionServiceSentence.submit(() -> {
        String paragraphContent = paragraph.getStr("content");
        // Generate summary for the paragraph
        String sentenceContent = maxKbParagraphSummaryService.summary(paragraphContent);

        // Create MaxKbSentence object with the summary
        MaxKbSentence maxKbSentence = new MaxKbSentence();
        maxKbSentence.setId(SnowflakeIdUtils.id()).setType(2) // Assuming type 2 indicates a summary
            .setHitNum(0).setMd5(Md5Utils.getMD5(sentenceContent)).setContent(sentenceContent)
            //
            .setDatasetId(dataset_id).setDocumentId(documentIdFinal).setParagraphId(paragraph.getLong("id"));

        return maxKbSentence;
      });
      summaryFutures.add(future);
    }

    // Step 2: Retrieve summaries from futures
    List<MaxKbSentence> sentences = new ArrayList<>();
    for (Future<MaxKbSentence> future : summaryFutures) {
      try {
        MaxKbSentence sentence = future.get(); // This will block until the summary is ready
        if (sentence != null) {
          sentences.add(sentence);
        }
      } catch (Exception e) {
        log.error("Error generating summary: {}", e.getMessage(), e);
      }
    }

    // Step 3: Generate vectors asynchronously for each summary
    List<Future<Row>> vectorFutures = new ArrayList<>(sentences.size());
    for (MaxKbSentence sentence : sentences) {
      Future<Row> future = completionServiceRow.submit(() -> {
        // Generate vector for the summary content
        PGobject vector = maxKbEmbeddingService.getVector(sentence.getContent(), modelName);
        Row record = sentence.toRecord();
        record.set("embedding", vector);
        return record;
      });
      vectorFutures.add(future);
    }

    // Step 4: Retrieve vectors from futures
    List<Row> sentenceRows = new ArrayList<>();
    for (Future<Row> future : vectorFutures) {
      try {
        Row record = future.get(); // This will block until the vector is ready
        if (record != null) {
          sentenceRows.add(record);
        }
      } catch (Exception e) {
        log.error("Error generating vector: {}", e.getMessage(), e);
      }
    }

    // Step 5: Save all sentence records with embeddings to the database within a transaction
    transactionSuccess = Db.tx(() -> {
      // Delete existing sentences for the document to avoid duplicates
      Db.deleteById(TableNames.max_kb_sentence, "document_id", documentIdFinal);
      // Batch save the new sentences with embeddings
      Db.batchSave(TableNames.max_kb_sentence, sentenceRows, 2000);
      return true;
    });

    return transactionSuccess;
  }
}

代码说明:

  • 并行处理:利用 CompletionService 实现异步处理,提升系统的处理效率。
    • 生成摘要:对每个段落内容调用 MaxKbParagraphSummaryService 生成摘要。
    • 生成向量:对生成的摘要内容调用 MaxKbEmbeddingService 进行向量化处理。
  • 事务管理:在数据库操作中使用事务,确保数据的一致性和完整性。在保存新的句子记录前,删除已有的相关记录,避免数据重复。
  • 错误处理:对异步任务中的异常进行捕获和日志记录,确保系统的稳定性。

汇总前后的片段对比

为了直观展示片段汇总功能的效果,以下展示了在应用汇总功能前后,片段内容的对比。

汇总前 max_kb_paragraph_summary_cache 表内容示例

He preferred to stick to the essential facts—birth, death, and emancipation.

## Conclusion

Sometime in 1865, a Union soldier approached Ella in the middle of her chores.

“A soldier rode up to my ma and told her she was free.”

The starkness of Ella’s story stunned me.

Her life consisted of two essential facts—slavery and freedom juxtaposed to mark the beginning and end of the chronicle.

But this was what slavery did: it stripped your history to bare facts and
# Family Stories

I don’t know if it was the bare bones of Ella’s story or the hopefulness and despair that lurked in Poppa’s words as he recounted it, as if he were weighing the promise of freedom against the vast stretches of stolen land before him, that made me eager to know more than what Poppa remembered or wanted to share.

Peter and I listened, silent.

We didn’t know what to say.

Poppa didn’t remember any kin before his grandmother, who smoked a corncob pipe.

He had inherited his love of pipes from her.

It was one of the things I adored about him.

He always smelled sweet like the maple tobacco smoke rising from his pipe.

What he knew about our family ended with his grandmother Ellen.

He remembered no other names.

When he spoke of these things, I saw how the sadness and anger of not knowing his people distorted the soft lines of Poppa’s face.

It surprised me; he had always seemed invincible, strapping, six foot two, and handsome, even at eighty-five.

I had seen this ache in others too.

At a barbecue at my grandmother’s, two of her cousins nearly came to blows disputing a grandfather’s name.

I was still too young then to recognize the same feelings inside me.

But I wondered about my great-great-grandmother’s mother, as well as all the others who had been forgotten.

If Poppa’s mother or grandmother shared any details about their lives in slavery, he didn’t share them with my brother and me. No doubt he was unwilling to disclose what he considered unspeakable. Still, he shared more with my brother and me than he had with my mother. Even now, he liked to call her “little girl.” When I returned home and asked her if Poppa had ever spoken to her about slavery or her great-grandmother Ella, the girl on the road, she replied, “When I was growing up we didn’t talk of such things.” Her great-grandmother had died before she was born, so my mother recalled nothing about her, not even her name.

At twelve I became obsessed with the maternal great-great-grandmother I had never known, endlessly constructing and rearranging the scene: her unease as the soldier advanced toward her, or the soldier on horseback looming over her and the smile inching across her face as she digested his words, or the peal of laughter trailing behind her as she turned upon her heels, or the war between disbelief and wonder that overcame Ella as she bolted toward her mother. Mulling over the details Poppa had shared with me, I tried to fill in the blank spaces of the story, but I never succeeded. Since that afternoon with my great-grandfather, I had been looking for relatives whose only proof of existence was fragments of stories and names that repeated themselves across generations.

Unlike friends who possessed a great trove of family photographs, I had no idea what my great-grandmother looked like or even my grandaunts when they were girls. All these things were gone; some of the photographs were given as tokens to dead relatives and buried with them; others were lost. The images I possessed of them were drawn from memory and imagination. My aunt Mosella, whose name itself was a memorial to my great-grandfather Moses and his mother Ella, once described a photograph taken of her mother and my great-great-grandmother Polly, whom everyone called Big Momma. In the photograph, her mother, Lou, was wearing a ruffled dress with bloomers and seated on Big Momma’s lap. She didn’t remember what my great-great-grandmother wore but only echoed my mother’s description of her: she was a big-boned woman with a round face the color of dark chocolate.

# Big Momma's Stories

Big Momma had never spoken of her life in slavery, nor had Ellen or Ella. Poppa could fill in only the bare outlines of their lives. The gaps and silences of my family were not unusual: slavery made the past a mystery, unknown and unspeakable.

## The Tales of the Past

汇总后

### Summary of "Afrotopia"

#### Core Themes:
1. **Strangerhood and Identity**: The author's feeling of being an outsider in Ghana and the broader implications of being labeled as an "obruni" highlight themes of alienation and cultural disconnection.
2. **Historical Legacy of Slavery**: The narrative emphasizes the long-lasting impact of slavery on identity and belonging, conveying personal stories that interweave familial history with the collective trauma of African descendants.
3. **Disillusionment with Idealization**: The text critiques the romantic notions surrounding a return to Africa, revealing the realities faced by expatriates, and contrasts the expectations of a utopian African experience with the complexities of its history and current socio-economic challenges.

#### Key Information:
- **Experiences in Ghana**: The author navigates her feelings of isolation and alienation, grappling with the term "obruni" as a constant reminder of her foreignness.
- **Family History and Memory**: Personal anecdotes reflect the struggle to connect with ancestors’ experiences of slavery, and a longing to reclaim lost identities and narratives, despite the silence surrounding these histories.
- **Cultural Critique**: The text discusses the dichotomy of freedom and slavery, exploring how the legacies of colonialism and neocolonialism shape modern Ghanaian society and the expatriate experience.
- **Reflections on Independence**: The celebration of Ghana’s independence is juxtaposed with the ongoing struggles faced by its people, revealing the unmet expectations that arose from decolonization.
- **Coup Experience**: The author's encounter with a perceived coup highlights the tension and fears surrounding political instability, serving as a metaphor for the broader struggles of identity and belonging in a post-colonial context.

#### Conclusion:
The narrative underscores the complexities of returning to one's roots, blending personal, historical, and socio-political reflections to articulate the challenges and disillusionments faced by those navigating their identities in the wake of slavery and colonialism.

对比分析:

  • 汇总前:原始内容较为冗长,涵盖了多个主题和细节,适合深入阅读和理解。然而,对于向量检索和生成模型来说,过长的文本可能导致上下文信息过载,影响检索准确性。
  • 汇总后:通过结构化的总结,提炼出核心主题和关键信息,使内容更加简洁明了。这不仅有助于提高向量检索的效率和准确性,也为生成模型提供了更为聚焦和相关的上下文信息,提升复杂汇总类问题的回答质量。

结论

本项目成功构建了一个功能完备的 RAG 系统,涵盖了从用户认证、模型管理到知识库和文档管理的各个环节。通过引入片段汇总功能,显著提升了系统在处理复杂汇总类问题时的准确性和效率。未来,随着系统的不断优化和功能的扩展,RAG 系统将能够更好地服务于各类用户,满足其在信息检索和问答方面的多样化需求。


Edit this page
Last Updated:
Contributors: Tong Li
Prev
文档解析优化
Next
段落分块与检索