# langchain4j-aideepin

**Repository Path**: doboot/langchain4j-aideepin

## Basic Information

- **Project Name**: langchain4j-aideepin
- **Description**: JAVA版本的检索增强生成(RAG)项目，包括知识库、搜索 | JAVA version of retrieval enhancement generation(RAG) project ,including knowledge base, search
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: main
- **Homepage**: http://www.aideepin.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 79
- **Created**: 2024-08-02
- **Last Updated**: 2024-08-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Getting Started

[READ THIS IN ENGLISH](README_en.md)

**LangChain4j-AIDeepin**
基于 ChatGPT 等大语言模型与 Langchain4j 等应用框架实现，开源、可离线部署的检索增强生成(RAG)项目。

> **该项目如对您有帮助，欢迎点赞**

代码仓库地址：[github](https://github.com/moyangzhan/langchain4j-aideepin)  [gitee](https://gitee.com/moyangzhan/langchain4j-aideepin)

前端项目：

* 用户端WEB：langchain4j-aideepin-web
  * [github](https://github.com/moyangzhan/langchain4j-aideepin-web)
  * [gitee](https://gitee.com/moyangzhan/langchain4j-aideepin-web)
* 管理端WEB：langchain4j-aideepin-admin
  * [github](https://github.com/moyangzhan/langchain4j-aideepin-admin)
  * [gitee](https://gitee.com/moyangzhan/langchain4j-aideepin-admin)

## 体验网址

[http://www.aideepin.com](http://www.aideepin.com/)

## 功能点

* 注册&登录
* 多会话（多角色）
* 图片生成（文生图、修图、图生图）
* 提示词
* 额度控制
* 基于大模型的知识库（RAG）
* 基于大模型的搜索（RAG）
* 多模型随意切换
* 多搜索引擎随意切换

## 接入的模型：

* ChatGPT 3.5
* 通义千问
* 文心一言
* ollama
* DALL-E 2

## 接入的搜索引擎

Google

Bing (TODO)

百度 (TODO)

## 技术栈

该仓库为后端服务

技术栈：

* jdk17
* springboot3.0.5
* [langchain4j(Java version of LangChain)](https://github.com/langchain4j/langchain4j)
* Postgresql(需要安装[pgvector](https://github.com/pgvector/pgvector)扩展)

前端技术栈：

* vue3
* vite
* typescript
* pnpm
* pinia
* naiveui

## 如何部署

### 初始化

**a. 初始化数据库**

* 创建数据库aideepin
* 执行docs/create.sql
* 配置模型(至少设置一个) 或者 使用[管理端](https://github.com/moyangzhan/langchain4j-aideepin-admin)在界面上配置

  * 配置AI平台
    ```plaintext
    -- openai的secretKey
    update adi_sys_config set value = '{"secret_key":"my_openai_secret_key"}' where name = 'openai_setting';

    -- 灵积大模型平台的apiKey
    update adi_sys_config set value = '{"api_key":"my_dashcope_api_key"}' where name = 'dashscope_setting';

    -- 千帆大模型平台的配置
    update adi_sys_config set value = '{"api_key":"my_qianfan_api_key","secret_key":"my_qianfan_secret_key"}' where name = 'qianfan_setting';

    -- ollama的配置
    update adi_sys_config set value = '{"base_url":"my_ollama_base_url"}' where name = 'ollama_setting';
    ```
  * 启用AI平台下的模型或新增模型
    ```
    -- Enable model
    update adi_ai_model set is_enable = true where name = 'gpt-3.5-turbo';
    update adi_ai_model set is_enable = true where name = 'dall-e-2';
    update adi_ai_model set is_enable = true where name = 'qwen-turbo';
    update adi_ai_model set is_enable = true where name = 'ernie_speed';
    update adi_ai_model set is_enable = true where name = 'tinydolphin';

    -- Add new model
    INSERT INTO adi_ai_model (name, type, platform, is_enable) VALUES ('vicuna', 'text', 'ollama', true);
    ```
* 填充搜索引擎的配置

  * Google的配置
    ```
    update adi_sys_config set value = '{"url":"https://www.googleapis.com/customsearch/v1","key":"my key from cloud.google.com","cx":"my cx from programmablesearchengine.google.com"}' where name = 'google_setting';
    ```

**b. 修改配置文件**

* postgresql: application-[dev|prod].xml中的spring.datasource
* redis: application-[dev|prod].xml中的spring.data.redis
* mail: application.xml中的spring.mail

### 编译及运行

* 进入项目

  ```plaintext
  cd langchain4j-aideepin
  ```
* 打包：

  ```
  mvn clean package -Dmaven.test.skip=true
  ```
* 运行

  * jar包启动：

  ```plaintext
  cd adi-bootstrap/target
  nohup java -jar -Xms768m -Xmx1024m -XX:+HeapDumpOnOutOfMemoryError adi-bootstrap-0.0.1-SNAPSHOT.jar --spring.profiles.active=[dev|prod] dev/null 2>&1 &
  ```

  * docker启动

  ```plaintext
  cd adi-bootstrap
  docker build . -t aideepin:0.0.1
  docker run -d \
    --name=aideepin \
    -e APP_PROFILE=[dev|prod] \
    -v="/data/aideepin/logs:/data/logs" \
    aideepin:0.0.1
  ```

## 待办：

* 高级RAG
  * 查询压缩  √
  * 查询路由
  * Re-rank：支持本地rerank模型
* 图片模型：
  * 接入DALL-E 3
  * 画廊视图
* 知识库：
  * 文档召回数量可设置
    * 自动调整（根据LLM的上下文窗口大小）  √
    * 手动调整  √
  * 文档召回最低分数可设置  √
  * 切块时内容重叠数量可设置  √
  * 请求模型时temperature可设置
  * 支持拉取在线文档
  * FAQ
  * 评论
* 多模态支持
* 工具
  * FAQ提取
  * 文档对话
  * 翻译
* 搜索引擎
  * Google  √
  * Bing
  * 百度

## 截图

**AI聊天：**
![1691583184761](image/README/1691583184761.png)

**AI画图：**

![1691583124744](image/README/1691583124744.png "AI绘图")

**知识库：**
![kbindex](image/README/kbidx.png)

![kb01](image/README/kb01.png)

**向量化：**

![kb02](image/README/kb02.png)

![kb03](image/README/kb03.png)

**额度统计：**

!![1691583329105.png](image%2FREADME%2F1691583329105.png)