新增llm模块,新增知识库

This commit is contained in:
ire 2024-12-18 14:08:29 +08:00
parent f637064c8c
commit 5d4d797fb4
10 changed files with 443 additions and 0 deletions

View File

@ -23,6 +23,7 @@
<!-- <module>yudao-module-mall</module>-->
<!-- <module>yudao-module-crm</module>-->
<module>yudao-module-erp</module>
<module>yudao-module-llm</module>
<!-- <module>yudao-module-iot</module>-->
<!-- AI 大模型的开启,请参考 https://doc.iocoder.cn/ai/build/ 文档,对 JDK 版本要要求! -->
<!-- <module>yudao-module-ai</module>-->

View File

@ -0,0 +1,93 @@
package cn.iocoder.yudao.module.llm.controller.admin.knowledgebase;
import cn.iocoder.yudao.framework.apilog.core.annotation.ApiAccessLog;
import cn.iocoder.yudao.framework.common.pojo.CommonResult;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
import cn.iocoder.yudao.framework.excel.core.util.ExcelUtils;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBasePageReqVO;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBaseRespVO;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBaseSaveReqVO;
import cn.iocoder.yudao.module.llm.dal.dataobject.knowledgebase.KnowledgeBaseDO;
import cn.iocoder.yudao.module.llm.service.knowledgebase.KnowledgeBaseService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletResponse;
import javax.validation.Valid;
import java.io.IOException;
import java.util.List;
import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.EXPORT;
import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
@Tag(name = "管理后台 - 知识库")
@RestController
@RequestMapping("/llm/knowledge-base")
@Validated
public class KnowledgeBaseController {
@Resource
private KnowledgeBaseService knowledgeBaseService;
@PostMapping("/create")
@Operation(summary = "创建知识库")
@PreAuthorize("@ss.hasPermission('llm:knowledge-base:create')")
public CommonResult<Long> createKnowledgeBase(@Valid @RequestBody KnowledgeBaseSaveReqVO createReqVO) {
return success(knowledgeBaseService.createKnowledgeBase(createReqVO));
}
@PutMapping("/update")
@Operation(summary = "更新知识库")
@PreAuthorize("@ss.hasPermission('llm:knowledge-base:update')")
public CommonResult<Boolean> updateKnowledgeBase(@Valid @RequestBody KnowledgeBaseSaveReqVO updateReqVO) {
knowledgeBaseService.updateKnowledgeBase(updateReqVO);
return success(true);
}
@DeleteMapping("/delete")
@Operation(summary = "删除知识库")
@Parameter(name = "id", description = "编号", required = true)
@PreAuthorize("@ss.hasPermission('llm:knowledge-base:delete')")
public CommonResult<Boolean> deleteKnowledgeBase(@RequestParam("id") Long id) {
knowledgeBaseService.deleteKnowledgeBase(id);
return success(true);
}
@GetMapping("/get")
@Operation(summary = "获得知识库")
@Parameter(name = "id", description = "编号", required = true, example = "1024")
@PreAuthorize("@ss.hasPermission('llm:knowledge-base:query')")
public CommonResult<KnowledgeBaseRespVO> getKnowledgeBase(@RequestParam("id") Long id) {
KnowledgeBaseDO knowledgeBase = knowledgeBaseService.getKnowledgeBase(id);
return success(BeanUtils.toBean(knowledgeBase, KnowledgeBaseRespVO.class));
}
@GetMapping("/page")
@Operation(summary = "获得知识库分页")
@PreAuthorize("@ss.hasPermission('llm:knowledge-base:query')")
public CommonResult<PageResult<KnowledgeBaseRespVO>> getKnowledgeBasePage(@Valid KnowledgeBasePageReqVO pageReqVO) {
PageResult<KnowledgeBaseDO> pageResult = knowledgeBaseService.getKnowledgeBasePage(pageReqVO);
return success(BeanUtils.toBean(pageResult, KnowledgeBaseRespVO.class));
}
@GetMapping("/export-excel")
@Operation(summary = "导出知识库 Excel")
@PreAuthorize("@ss.hasPermission('llm:knowledge-base:export')")
@ApiAccessLog(operateType = EXPORT)
public void exportKnowledgeBaseExcel(@Valid KnowledgeBasePageReqVO pageReqVO,
HttpServletResponse response) throws IOException {
pageReqVO.setPageSize(PageParam.PAGE_SIZE_NONE);
List<KnowledgeBaseDO> list = knowledgeBaseService.getKnowledgeBasePage(pageReqVO).getList();
// 导出 Excel
ExcelUtils.write(response, "知识库.xls", "数据", KnowledgeBaseRespVO.class,
BeanUtils.toBean(list, KnowledgeBaseRespVO.class));
}
}

View File

@ -0,0 +1,43 @@
package cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo;
import lombok.*;
import java.util.*;
import io.swagger.v3.oas.annotations.media.Schema;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(description = "管理后台 - 知识库分页 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public class KnowledgeBasePageReqVO extends PageParam {
@Schema(description = "知识库名称", example = "张三")
private String knowledgeBaseName;
@Schema(description = "知识库简介")
private String knowledgeBaseIntro;
@Schema(description = "知识库图标")
private String knowledgeBaseLogo;
@Schema(description = "创建时间")
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
private LocalDateTime[] createTime;
@Schema(description = "topK")
private Integer topK;
@Schema(description = "Score阈值")
private Integer score;
@Schema(description = "知识长度")
private Integer knowledgeLength;
@Schema(description = "文件引用")
private String knowledgeFile;
}

View File

@ -0,0 +1,51 @@
package cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import java.util.*;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import com.alibaba.excel.annotation.*;
@Schema(description = "管理后台 - 知识库 Response VO")
@Data
@ExcelIgnoreUnannotated
public class KnowledgeBaseRespVO {
@Schema(description = "知识库ID", requiredMode = Schema.RequiredMode.REQUIRED, example = "25984")
@ExcelProperty("知识库ID")
private Long id;
@Schema(description = "知识库名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "张三")
@ExcelProperty("知识库名称")
private String knowledgeBaseName;
@Schema(description = "知识库简介")
@ExcelProperty("知识库简介")
private String knowledgeBaseIntro;
@Schema(description = "知识库图标")
@ExcelProperty("知识库图标")
private String knowledgeBaseLogo;
@Schema(description = "创建时间", requiredMode = Schema.RequiredMode.REQUIRED)
@ExcelProperty("创建时间")
private LocalDateTime createTime;
@Schema(description = "topK")
@ExcelProperty("topK")
private Integer topK;
@Schema(description = "Score阈值")
@ExcelProperty("Score阈值")
private Integer score;
@Schema(description = "知识长度")
@ExcelProperty("知识长度")
private Integer knowledgeLength;
@Schema(description = "文件引用")
@ExcelProperty("文件引用")
private String knowledgeFile;
}

View File

@ -0,0 +1,37 @@
package cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import java.util.*;
import javax.validation.constraints.*;
@Schema(description = "管理后台 - 知识库新增/修改 Request VO")
@Data
public class KnowledgeBaseSaveReqVO {
@Schema(description = "知识库ID", requiredMode = Schema.RequiredMode.REQUIRED, example = "25984")
private Long id;
@Schema(description = "知识库名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "张三")
@NotEmpty(message = "知识库名称不能为空")
private String knowledgeBaseName;
@Schema(description = "知识库简介")
private String knowledgeBaseIntro;
@Schema(description = "知识库图标")
private String knowledgeBaseLogo;
@Schema(description = "topK")
private Integer topK;
@Schema(description = "Score阈值")
private Integer score;
@Schema(description = "知识长度")
private Integer knowledgeLength;
@Schema(description = "文件引用")
private String knowledgeFile;
}

View File

@ -0,0 +1,58 @@
package cn.iocoder.yudao.module.llm.dal.dataobject.knowledgebase;
import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
import com.baomidou.mybatisplus.annotation.KeySequence;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.*;
/**
* 知识库 DO
*
* @author 华大大模型
*/
@TableName("llm_knowledge_base")
@KeySequence("llm_knowledge_base_seq") // 用于 OraclePostgreSQLKingbaseDB2H2 数据库的主键自增如果是 MySQL 等数据库可不写
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class KnowledgeBaseDO extends BaseDO {
/**
* 知识库ID
*/
@TableId
private Long id;
/**
* 知识库名称
*/
private String knowledgeBaseName;
/**
* 知识库简介
*/
private String knowledgeBaseIntro;
/**
* 知识库图标
*/
private String knowledgeBaseLogo;
/**
* topK
*/
private Integer topK;
/**
* Score阈值
*/
private Integer score;
/**
* 知识长度
*/
private Integer knowledgeLength;
/**
* 文件引用
*/
private String knowledgeFile;
}

View File

@ -0,0 +1,31 @@
package cn.iocoder.yudao.module.llm.dal.mysql.knowledgebase;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.mybatis.core.mapper.BaseMapperX;
import cn.iocoder.yudao.framework.mybatis.core.query.LambdaQueryWrapperX;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBasePageReqVO;
import cn.iocoder.yudao.module.llm.dal.dataobject.knowledgebase.KnowledgeBaseDO;
import org.apache.ibatis.annotations.Mapper;
/**
* 知识库 Mapper
*
* @author 华大大模型
*/
@Mapper
public interface KnowledgeBaseMapper extends BaseMapperX<KnowledgeBaseDO> {
default PageResult<KnowledgeBaseDO> selectPage(KnowledgeBasePageReqVO reqVO) {
return selectPage(reqVO, new LambdaQueryWrapperX<KnowledgeBaseDO>()
.likeIfPresent(KnowledgeBaseDO::getKnowledgeBaseName, reqVO.getKnowledgeBaseName())
.eqIfPresent(KnowledgeBaseDO::getKnowledgeBaseIntro, reqVO.getKnowledgeBaseIntro())
.eqIfPresent(KnowledgeBaseDO::getKnowledgeBaseLogo, reqVO.getKnowledgeBaseLogo())
.betweenIfPresent(KnowledgeBaseDO::getCreateTime, reqVO.getCreateTime())
.eqIfPresent(KnowledgeBaseDO::getTopK, reqVO.getTopK())
.eqIfPresent(KnowledgeBaseDO::getScore, reqVO.getScore())
.eqIfPresent(KnowledgeBaseDO::getKnowledgeLength, reqVO.getKnowledgeLength())
.eqIfPresent(KnowledgeBaseDO::getKnowledgeFile, reqVO.getKnowledgeFile())
.orderByDesc(KnowledgeBaseDO::getId));
}
}

View File

@ -0,0 +1,55 @@
package cn.iocoder.yudao.module.llm.service.knowledgebase;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBasePageReqVO;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBaseSaveReqVO;
import cn.iocoder.yudao.module.llm.dal.dataobject.knowledgebase.KnowledgeBaseDO;
import javax.validation.Valid;
/**
* 知识库 Service 接口
*
* @author 华大大模型
*/
public interface KnowledgeBaseService {
/**
* 创建知识库
*
* @param createReqVO 创建信息
* @return 编号
*/
Long createKnowledgeBase(@Valid KnowledgeBaseSaveReqVO createReqVO);
/**
* 更新知识库
*
* @param updateReqVO 更新信息
*/
void updateKnowledgeBase(@Valid KnowledgeBaseSaveReqVO updateReqVO);
/**
* 删除知识库
*
* @param id 编号
*/
void deleteKnowledgeBase(Long id);
/**
* 获得知识库
*
* @param id 编号
* @return 知识库
*/
KnowledgeBaseDO getKnowledgeBase(Long id);
/**
* 获得知识库分页
*
* @param pageReqVO 分页查询
* @return 知识库分页
*/
PageResult<KnowledgeBaseDO> getKnowledgeBasePage(KnowledgeBasePageReqVO pageReqVO);
}

View File

@ -0,0 +1,68 @@
package cn.iocoder.yudao.module.llm.service.knowledgebase;
import cn.iocoder.yudao.framework.common.pojo.PageResult;
import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBasePageReqVO;
import cn.iocoder.yudao.module.llm.controller.admin.knowledgebase.vo.KnowledgeBaseSaveReqVO;
import cn.iocoder.yudao.module.llm.dal.dataobject.knowledgebase.KnowledgeBaseDO;
import cn.iocoder.yudao.module.llm.dal.mysql.knowledgebase.KnowledgeBaseMapper;
import org.springframework.stereotype.Service;
import org.springframework.validation.annotation.Validated;
import javax.annotation.Resource;
/**
* 知识库 Service 实现类
*
* @author 华大大模型
*/
@Service
@Validated
public class KnowledgeBaseServiceImpl implements KnowledgeBaseService {
@Resource
private KnowledgeBaseMapper knowledgeBaseMapper;
@Override
public Long createKnowledgeBase(KnowledgeBaseSaveReqVO createReqVO) {
// 插入
KnowledgeBaseDO knowledgeBase = BeanUtils.toBean(createReqVO, KnowledgeBaseDO.class);
knowledgeBaseMapper.insert(knowledgeBase);
// 返回
return knowledgeBase.getId();
}
@Override
public void updateKnowledgeBase(KnowledgeBaseSaveReqVO updateReqVO) {
// 校验存在
validateKnowledgeBaseExists(updateReqVO.getId());
// 更新
KnowledgeBaseDO updateObj = BeanUtils.toBean(updateReqVO, KnowledgeBaseDO.class);
knowledgeBaseMapper.updateById(updateObj);
}
@Override
public void deleteKnowledgeBase(Long id) {
// 校验存在
validateKnowledgeBaseExists(id);
// 删除
knowledgeBaseMapper.deleteById(id);
}
private void validateKnowledgeBaseExists(Long id) {
if (knowledgeBaseMapper.selectById(id) == null) {
// throw exception(KNOWLEDGE_BASE_NOT_EXISTS);
}
}
@Override
public KnowledgeBaseDO getKnowledgeBase(Long id) {
return knowledgeBaseMapper.selectById(id);
}
@Override
public PageResult<KnowledgeBaseDO> getKnowledgeBasePage(KnowledgeBasePageReqVO pageReqVO) {
return knowledgeBaseMapper.selectPage(pageReqVO);
}
}

View File

@ -115,6 +115,12 @@
<!-- <version>${revision}</version>-->
<!-- </dependency>-->
<dependency>
<groupId>cn.iocoder.boot</groupId>
<artifactId>yudao-module-llm-biz</artifactId>
<version>${revision}</version>
</dependency>
<!-- spring boot 配置所需依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>