BJ_ZTEITS-Developers / parking-cloud-yudao

Commit bcdb23b89d9834919374d21ac3b272f5edf28600

Authored by xiaoxin
1 parent 7cd16ffb

【优化】AI 写作：做角色设定，提高准确率

Inline Side-by-side
Showing 9 changed files with 111 additions and 74 deletions
yudao-module-ai/yudao-module-ai-api/src/main/java/cn/iocoder/yudao/module/ai/enums/AiChatRoleEnum.java 0 → 100644
  View file @bcdb23b
  1 +package cn.iocoder.yudao.module.ai.enums;
  2 +
  3 +import cn.iocoder.yudao.framework.common.core.IntArrayValuable;
  4 +import lombok.AllArgsConstructor;
  5 +import lombok.Getter;
  6 +
  7 +import java.util.Arrays;
  8 +
  9 +/**
  10 + * AI 写作类型的枚举
  11 + *
  12 + * @author xiaoxin
  13 + */
  14 +@AllArgsConstructor
  15 +@Getter
  16 +public enum AiChatRoleEnum implements IntArrayValuable {
  17 +
  18 + AI_WRITE_ROLE(1, "写作助手", """
  19 + 你是一位出色的写作助手，能够帮助用户生成创意和灵感，并在用户提供场景和提示词时生成对应的回复。你的任务包括：
  20 + 1. 撰写建议：根据用户提供的主题或问题，提供详细的写作建议、情节发展方向、角色设定以及背景描写，确保内容结构清晰、有逻辑。
  21 + 2. 回复生成：根据用户提供的场景和提示词，生成合适的对话或文字回复，确保语气和风格符合场景需求。
  22 + 除此之外不需要除了正文内容外的其他回复，如标题、开头、任何解释性语句或道歉。
  23 + """),
  24 + AI_MIND_MAP_ROLE(2, "脑图助手", """
  25 + 你是一位非常优秀的思维导图助手，你会把用户的所有提问都总结成思维导图，然后以 Markdown 格式输出。markdown 只需要输出一级标题，二级标题，三级标题，四级标题，最多输出四级，除此之外不要输出任何其他 markdown 标记。下面是一个合格的例子：
  26 + # Geek-AI 助手
  27 + ## 完整的开源系统
  28 + ### 前端开源
  29 + ### 后端开源
  30 + ## 支持各种大模型
  31 + ### OpenAI
  32 + ### Azure
  33 + ### 文心一言
  34 + ### 通义千问
  35 + ## 集成多种收费方式
  36 + ### 支付宝
  37 + ### 微信
  38 + 除此之外不要任何解释性语句。
  39 + """);
  40 +
  41 +
  42 + /**
  43 + * 角色
  44 + */
  45 + private final Integer role;
  46 + /**
  47 + * 角色名
  48 + */
  49 + private final String name;
  50 +
  51 + /**
  52 + * 角色设定
  53 + */
  54 + private final String prompt;
  55 +
  56 + public static final int[] ARRAYS = Arrays.stream(values()).mapToInt(AiChatRoleEnum::getRole).toArray();
  57 +
  58 + @Override
  59 + public int[] array() {
  60 + return ARRAYS;
  61 + }
  62 +
  63 +}
... ...
yudao-module-ai/yudao-module-ai-api/src/main/java/cn/iocoder/yudao/module/ai/enums/write/AiWriteTypeEnum.java
  View file @bcdb23b
1 1 package cn.iocoder.yudao.module.ai.enums.write;
2 2  
3   -import cn.hutool.core.util.ArrayUtil;
4   -import cn.hutool.core.util.StrUtil;
5 3 import cn.iocoder.yudao.framework.common.core.IntArrayValuable;
6 4 import lombok.AllArgsConstructor;
7 5 import lombok.Getter;
... ... @@ -41,9 +39,4 @@ public enum AiWriteTypeEnum implements IntArrayValuable {
41 39 return ARRAYS;
42 40 }
43 41  
44   - public static void validateType(Integer type) {
45   - if (ArrayUtil.contains(ARRAYS, type)) return;
46   - throw new IllegalArgumentException(StrUtil.format("未知写作类型({})", type));
47   - }
48   -
49 42 }
... ...
yudao-module-ai/yudao-module-ai-biz/src/main/java/cn/iocoder/yudao/module/ai/controller/admin/mindmap/AiMindMapController.java
  View file @bcdb23b
... ... @@ -26,7 +26,7 @@ public class AiMindMapController {
26 26 private AiMindMapService mindMapService;
27 27  
28 28 @PostMapping(value = "/generate-stream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
29   - @Operation(summary = "发送消息（流式）", description = "流式返回，响应较快")
  29 + @Operation(summary = "脑图生成（流式）", description = "流式返回，响应较快")
30 30 @PermitAll // 解决 SSE 最终响应的时候，会被 Access Denied 拦截的问题
31 31 public Flux<CommonResult<String>> generateMindMap(@RequestBody @Valid AiMindMapGenerateReqVO generateReqVO) {
32 32 return mindMapService.generateMindMap(generateReqVO, getLoginUserId());
... ...
yudao-module-ai/yudao-module-ai-biz/src/main/java/cn/iocoder/yudao/module/ai/controller/admin/write/vo/AiWriteGenerateReqVO.java
  View file @bcdb23b
... ... @@ -11,7 +11,7 @@ import lombok.Data;
11 11 public class AiWriteGenerateReqVO {
12 12  
13 13 @Schema(description = "写作类型", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
14   - @InEnum(AiWriteTypeEnum.class)
  14 + @InEnum(value = AiWriteTypeEnum.class, message = "写作类型必须是 {value}")
15 15 private Integer type;
16 16  
17 17 @Schema(description = "写作内容提示", example = "1.撰写：田忌赛马；2.回复：不批")
... ...
yudao-module-ai/yudao-module-ai-biz/src/main/java/cn/iocoder/yudao/module/ai/dal/mysql/model/AiChatRoleMapper.java
  View file @bcdb23b
... ... @@ -4,9 +4,7 @@ import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
4 4 import cn.iocoder.yudao.framework.common.pojo.PageResult;
5 5 import cn.iocoder.yudao.framework.mybatis.core.mapper.BaseMapperX;
6 6 import cn.iocoder.yudao.framework.mybatis.core.query.LambdaQueryWrapperX;
7   -import cn.iocoder.yudao.framework.mybatis.core.query.QueryWrapperX;
8 7 import cn.iocoder.yudao.module.ai.controller.admin.model.vo.chatRole.AiChatRolePageReqVO;
9   -import cn.iocoder.yudao.module.ai.dal.dataobject.model.AiChatModelDO;
10 8 import cn.iocoder.yudao.module.ai.dal.dataobject.model.AiChatRoleDO;
11 9 import org.apache.ibatis.annotations.Mapper;
12 10  
... ... @@ -47,4 +45,10 @@ public interface AiChatRoleMapper extends BaseMapperX&lt;AiChatRoleDO&gt; {
47 45 .groupBy(AiChatRoleDO::getCategory));
48 46 }
49 47  
  48 + default List<AiChatRoleDO> selectListByName(String name) {
  49 + return selectList(new LambdaQueryWrapperX<AiChatRoleDO>()
  50 + .likeIfPresent(AiChatRoleDO::getName, name)
  51 + .orderByAsc(AiChatRoleDO::getSort));
  52 + }
  53 +
50 54 }
... ...
yudao-module-ai/yudao-module-ai-biz/src/main/java/cn/iocoder/yudao/module/ai/service/mindmap/AiMindMapServiceImpl.java
  View file @bcdb23b
... ... @@ -5,15 +5,14 @@ import cn.hutool.core.util.StrUtil;
5 5 import cn.iocoder.yudao.framework.ai.core.enums.AiPlatformEnum;
6 6 import cn.iocoder.yudao.framework.ai.core.util.AiUtils;
7 7 import cn.iocoder.yudao.framework.common.pojo.CommonResult;
8   -import cn.iocoder.yudao.framework.common.pojo.PageResult;
9 8 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
10 9 import cn.iocoder.yudao.framework.tenant.core.util.TenantUtils;
11 10 import cn.iocoder.yudao.module.ai.controller.admin.mindmap.vo.AiMindMapGenerateReqVO;
12   -import cn.iocoder.yudao.module.ai.controller.admin.model.vo.chatRole.AiChatRolePageReqVO;
13 11 import cn.iocoder.yudao.module.ai.dal.dataobject.mindmap.AiMindMapDO;
14 12 import cn.iocoder.yudao.module.ai.dal.dataobject.model.AiChatModelDO;
15 13 import cn.iocoder.yudao.module.ai.dal.dataobject.model.AiChatRoleDO;
16 14 import cn.iocoder.yudao.module.ai.dal.mysql.mindmap.AiMindMapMapper;
  15 +import cn.iocoder.yudao.module.ai.enums.AiChatRoleEnum;
17 16 import cn.iocoder.yudao.module.ai.enums.ErrorCodeConstants;
18 17 import cn.iocoder.yudao.module.ai.service.model.AiApiKeyService;
19 18 import cn.iocoder.yudao.module.ai.service.model.AiChatModelService;
... ... @@ -56,61 +55,40 @@ public class AiMindMapServiceImpl implements AiMindMapService {
56 55 @Resource
57 56 private AiMindMapMapper mindMapMapper;
58 57  
59   - private static final String DEFAULT_SYSTEM_MESSAGE = """
60   - 你是一位非常优秀的思维导图助手，你会把用户的所有提问都总结成思维导图，然后以 Markdown 格式输出。markdown 只需要输出一级标题，二级标题，三级标题，四级标题，最多输出四级，除此之外不要输出任何其他 markdown 标记。下面是一个合格的例子：
61   - # Geek-AI 助手
62   -
63   - ## 完整的开源系统
64   - ### 前端开源
65   - ### 后端开源
66   -
67   - ## 支持各种大模型
68   - ### OpenAI
69   - ### Azure
70   - ### 文心一言
71   - ### 通义千问
72   -
73   - ## 集成多种收费方式
74   - ### 支付宝
75   - ### 微信
76   -
77   - 另外，除此之外不要任何解释性语句。
78   - """;
79   -
80 58 @Override
81 59 public Flux<CommonResult<String>> generateMindMap(AiMindMapGenerateReqVO generateReqVO, Long userId) {
82 60 // 1.1 获取脑图模型 尝试获取思维导图助手角色，如果没有则使用默认模型
83   - AiChatRoleDO mindMapRole = selectOneMindMapRole();
  61 + AiChatRoleDO mindMapRole = CollUtil.getFirst(chatRoleService.getChatRoleListByName(AiChatRoleEnum.AI_MIND_MAP_ROLE.getName()));
84 62 AiChatModelDO model;
85 63 String systemMessage;
86   - if (Objects.nonNull(mindMapRole)) {
  64 + if (Objects.nonNull(mindMapRole) && Objects.nonNull(mindMapRole.getModelId())) {
87 65 model = chatModalService.getChatModel(mindMapRole.getModelId());
88 66 systemMessage = mindMapRole.getSystemMessage();
89 67 } else {
90 68 model = chatModalService.getRequiredDefaultChatModel();
91   - systemMessage = DEFAULT_SYSTEM_MESSAGE;
  69 + systemMessage = AiChatRoleEnum.AI_MIND_MAP_ROLE.getPrompt();
92 70 }
93 71  
94 72 AiPlatformEnum platform = AiPlatformEnum.validatePlatform(model.getPlatform());
95 73 ChatModel chatModel = apiKeyService.getChatModel(model.getKeyId());
96 74  
97   - // 1.2 插入思维导图信息
  75 + // 2 插入思维导图信息
98 76 AiMindMapDO mindMapDO = BeanUtils.toBean(generateReqVO, AiMindMapDO.class, e -> e.setUserId(userId).setModel(model.getModel()).setPlatform(platform.getPlatform()));
99 77 mindMapMapper.insert(mindMapDO);
100 78  
101 79 ChatOptions chatOptions = AiUtils.buildChatOptions(platform, model.getModel(), model.getTemperature(), model.getMaxTokens());
102   - // 2.1 角色设定
  80 + // 3.1 角色设定
103 81 List<Message> chatMessages = new ArrayList<>();
104 82 if (StrUtil.isNotBlank(systemMessage)) {
105 83 chatMessages.add(new SystemMessage(systemMessage));
106 84 }
107   - // 2.2 用户输入
  85 + // 3.2 用户输入
108 86 chatMessages.add(new UserMessage(generateReqVO.getPrompt()));
109   - // 2.3 构建提示词
  87 + // 3.3 构建提示词
110 88 Prompt prompt = new Prompt(chatMessages, chatOptions);
111 89  
112 90 Flux<ChatResponse> streamResponse = chatModel.stream(prompt);
113   - // 2.4 流式返回
  91 + // 3.4 流式返回
114 92 StringBuffer contentBuffer = new StringBuffer();
115 93 return streamResponse.map(chunk -> {
116 94 String newContent = chunk.getResult() != null ? chunk.getResult().getOutput().getContent() : null;
... ... @@ -131,13 +109,4 @@ public class AiMindMapServiceImpl implements AiMindMapService {
131 109  
132 110 }
133 111  
134   - private AiChatRoleDO selectOneMindMapRole() {
135   - AiChatRoleDO chatRoleDO = null;
136   - PageResult<AiChatRoleDO> mindMapRolePage = chatRoleService.getChatRolePage(new AiChatRolePageReqVO().setName("思维导图助手"));
137   - List<AiChatRoleDO> list = mindMapRolePage.getList();
138   - if (CollUtil.isNotEmpty(list)) {
139   - chatRoleDO = list.get(0);
140   - }
141   - return chatRoleDO;
142   - }
143 112 }
... ...
yudao-module-ai/yudao-module-ai-biz/src/main/java/cn/iocoder/yudao/module/ai/service/model/AiChatRoleService.java
  View file @bcdb23b
... ... @@ -118,4 +118,11 @@ public interface AiChatRoleService {
118 118 */
119 119 List<String> getChatRoleCategoryList();
120 120  
  121 + /**
  122 + * 根据名字获得聊天角色
  123 + * @param name 名字
  124 + * @return 聊天角色列表
  125 + */
  126 + List<AiChatRoleDO> getChatRoleListByName(String name);
  127 +
121 128 }
122 129 \ No newline at end of file
... ...
yudao-module-ai/yudao-module-ai-biz/src/main/java/cn/iocoder/yudao/module/ai/service/model/AiChatRoleServiceImpl.java
  View file @bcdb23b
... ... @@ -137,5 +137,10 @@ public class AiChatRoleServiceImpl implements AiChatRoleService {
137 137 return convertList(list, AiChatRoleDO::getCategory, role -> role != null && StrUtil.isNotBlank(role.getCategory()));
138 138 }
139 139  
  140 + @Override
  141 + public List<AiChatRoleDO> getChatRoleListByName(String name) {
  142 + return chatRoleMapper.selectListByName(name);
  143 + }
  144 +
140 145 }
141 146  
... ...
yudao-module-ai/yudao-module-ai-biz/src/main/java/cn/iocoder/yudao/module/ai/service/write/AiWriteServiceImpl.java
  View file @bcdb23b
... ... @@ -5,15 +5,14 @@ import cn.hutool.core.util.StrUtil;
5 5 import cn.iocoder.yudao.framework.ai.core.enums.AiPlatformEnum;
6 6 import cn.iocoder.yudao.framework.ai.core.util.AiUtils;
7 7 import cn.iocoder.yudao.framework.common.pojo.CommonResult;
8   -import cn.iocoder.yudao.framework.common.pojo.PageResult;
9 8 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
10 9 import cn.iocoder.yudao.framework.tenant.core.util.TenantUtils;
11   -import cn.iocoder.yudao.module.ai.controller.admin.model.vo.chatRole.AiChatRolePageReqVO;
12 10 import cn.iocoder.yudao.module.ai.controller.admin.write.vo.AiWriteGenerateReqVO;
13 11 import cn.iocoder.yudao.module.ai.dal.dataobject.model.AiChatModelDO;
14 12 import cn.iocoder.yudao.module.ai.dal.dataobject.model.AiChatRoleDO;
15 13 import cn.iocoder.yudao.module.ai.dal.dataobject.write.AiWriteDO;
16 14 import cn.iocoder.yudao.module.ai.dal.mysql.write.AiWriteMapper;
  15 +import cn.iocoder.yudao.module.ai.enums.AiChatRoleEnum;
17 16 import cn.iocoder.yudao.module.ai.enums.DictTypeConstants;
18 17 import cn.iocoder.yudao.module.ai.enums.ErrorCodeConstants;
19 18 import cn.iocoder.yudao.module.ai.enums.write.AiWriteTypeEnum;
... ... @@ -23,6 +22,9 @@ import cn.iocoder.yudao.module.ai.service.model.AiChatRoleService;
23 22 import cn.iocoder.yudao.module.system.api.dict.DictDataApi;
24 23 import jakarta.annotation.Resource;
25 24 import lombok.extern.slf4j.Slf4j;
  25 +import org.springframework.ai.chat.messages.Message;
  26 +import org.springframework.ai.chat.messages.SystemMessage;
  27 +import org.springframework.ai.chat.messages.UserMessage;
26 28 import org.springframework.ai.chat.model.ChatResponse;
27 29 import org.springframework.ai.chat.model.StreamingChatModel;
28 30 import org.springframework.ai.chat.prompt.ChatOptions;
... ... @@ -30,6 +32,7 @@ import org.springframework.ai.chat.prompt.Prompt;
30 32 import org.springframework.stereotype.Service;
31 33 import reactor.core.publisher.Flux;
32 34  
  35 +import java.util.ArrayList;
33 36 import java.util.List;
34 37 import java.util.Objects;
35 38  
... ... @@ -61,13 +64,15 @@ public class AiWriteServiceImpl implements AiWriteService {
61 64 @Override
62 65 public Flux<CommonResult<String>> generateWriteContent(AiWriteGenerateReqVO generateReqVO, Long userId) {
63 66 // 1.1 获取写作模型 尝试获取写作助手角色，如果没有则使用默认模型
64   - AiChatRoleDO writeRole = selectOneWriteRole();
  67 + AiChatRoleDO writeRole = CollUtil.getFirst(chatRoleService.getChatRoleListByName(AiChatRoleEnum.AI_WRITE_ROLE.getName()));
65 68 AiChatModelDO model;
66   - // TODO @xin：writeRole.getModelId 可能为空。所以，最好是先通过 chatRole 拿。如果它没拿到，通过 getRequiredDefaultChatModel 再拿。
67   - if (Objects.nonNull(writeRole)) {
  69 + String systemMessage;
  70 + if (Objects.nonNull(writeRole) && Objects.nonNull(writeRole.getModelId())) {
68 71 model = chatModalService.getChatModel(writeRole.getModelId());
  72 + systemMessage = writeRole.getSystemMessage();
69 73 } else {
70 74 model = chatModalService.getRequiredDefaultChatModel();
  75 + systemMessage = AiChatRoleEnum.AI_WRITE_ROLE.getPrompt();
71 76 }
72 77 // 1.2 校验平台
73 78 AiPlatformEnum platform = AiPlatformEnum.validatePlatform(model.getPlatform());
... ... @@ -77,9 +82,16 @@ public class AiWriteServiceImpl implements AiWriteService {
77 82 AiWriteDO writeDO = BeanUtils.toBean(generateReqVO, AiWriteDO.class, e -> e.setUserId(userId).setModel(model.getModel()).setPlatform(platform.getPlatform()));
78 83 writeMapper.insert(writeDO);
79 84  
80   - // 3.1 构建提示词
81 85 ChatOptions chatOptions = AiUtils.buildChatOptions(platform, model.getModel(), model.getTemperature(), model.getMaxTokens());
82   - Prompt prompt = new Prompt(buildWritingPrompt(generateReqVO), chatOptions);
  86 + // 3.1 角色设定
  87 + List<Message> chatMessages = new ArrayList<>();
  88 + if (StrUtil.isNotBlank(systemMessage)) {
  89 + chatMessages.add(new SystemMessage(systemMessage));
  90 + }
  91 + // 3.2 用户输入
  92 + chatMessages.add(new UserMessage(buildWritingPrompt(generateReqVO)));
  93 + // 3.3 构建提示词
  94 + Prompt prompt = new Prompt(chatMessages, chatOptions);
83 95 Flux<ChatResponse> streamResponse = chatModel.stream(prompt);
84 96  
85 97 // 3.2 流式返回
... ... @@ -102,24 +114,8 @@ public class AiWriteServiceImpl implements AiWriteService {
102 114 }).onErrorResume(error -> Flux.just(error(ErrorCodeConstants.WRITE_STREAM_ERROR)));
103 115 }
104 116  
105   - // TODO @xin：chatRoleService 增加一个 getChatRoleListByName；
106   - private AiChatRoleDO selectOneWriteRole() {
107   - AiChatRoleDO chatRoleDO = null;
108   - // TODO @xin："写作助手" 枚举下。
109   - PageResult<AiChatRoleDO> writeRolePage = chatRoleService.getChatRolePage(new AiChatRolePageReqVO().setName("写作助手"));
110   - List<AiChatRoleDO> list = writeRolePage.getList();
111   - // TODO @xin：CollUtil.getFirst 简化下
112   - if (CollUtil.isNotEmpty(list)) {
113   - chatRoleDO = list.get(0);
114   - }
115   - return chatRoleDO;
116   - }
117   -
118 117 private String buildWritingPrompt(AiWriteGenerateReqVO generateReqVO) {
119   - // 校验写作类型是否合法
120 118 Integer type = generateReqVO.getType();
121   - // TODO @xin：这里可以搞到 validator 的校验。InEnum
122   - AiWriteTypeEnum.validateType(type);
123 119 String format = dictDataApi.getDictDataLabel(DictTypeConstants.AI_WRITE_FORMAT, generateReqVO.getFormat());
124 120 String tone = dictDataApi.getDictDataLabel(DictTypeConstants.AI_WRITE_TONE, generateReqVO.getTone());
125 121 String language = dictDataApi.getDictDataLabel(DictTypeConstants.AI_WRITE_LANGUAGE, generateReqVO.getLanguage());
... ...