chatgpt-spring-boot-starter

项目介绍：chatgpt-spring-boot-starter

chatgpt-spring-boot-starter 是一个基于 OpenAI 官方 API 的项目，可以轻松地在 Spring Boot 项目中集成 ChatGPT 功能。它主要提供了文本聊天和图像生成两大功能，具有简单易用的特性。

功能介绍

1. 聊天功能

用户可以通过多种模型与 ChatGPT 进行对话。支持多条消息的交互，这意味着用户可以将一系列消息（包括对话历史）作为输入，获得回复信息。这种特性使得对话更具连贯性和智能化。

2. 图像生成

该功能允许用户输入一个提示词，然后生成相应的图像。这在需要视觉生成的场景下非常有用，如创意设计或者内容创作。

如何使用

1. 添加 Maven 依赖

首先用户需要在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>io.github.flashvayne</groupId>
    <artifactId>chatgpt-spring-boot-starter</artifactId>
    <version>1.0.5</version>
</dependency>

2. 配置 chatgpt 属性

在 application.yml 文件中设置 ChatGPT 的相关属性：

chatgpt:
  api-key: xxxxxxxxxxx   # 请在 OpenAI 平台生成并替换 API key
# 其他属性如模型选择和最大tokens等都有默认值，用户可以根据需要调整。

3. 注入 ChatgptService 并调用其方法

聊天功能

可以在项目中任何需要的地方注入 ChatgptService 并调用其提供的聊天方法。

单条信息

@Autowired
private ChatgptService chatgptService;

public void test(){
    String responseMessage = chatgptService.multiChat(Arrays.asList(new MultiChatMessage("user","how are you?")));
    System.out.print(responseMessage);
}

public void test2(){
    String responseMessage = chatgptService.sendMessage("how are you");
    System.out.print(responseMessage);
}

多条信息

允许接收一系列消息，并获得一个回复。例如：

@Autowired
private ChatgptService chatgptService;

public void testMultiChat(){
    List<MultiChatMessage> messages = Arrays.asList(
            new MultiChatMessage("system","You are a helpful assistant."),
            new MultiChatMessage("user","Who won the world series in 2020?"),
            new MultiChatMessage("assistant","The Los Angeles Dodgers won the World Series in 2020."),
            new MultiChatMessage("user","Where was it played?"));
    String responseMessage = chatgptService.multiChat(messages);
    System.out.print(responseMessage);
}

提示信息：

• 消息需为一个对象数组，每个对象包括一个角色（"system"、"user" 或 "assistant"）和内容。
• 通过系统消息可以设置助手行为。
• 用户消息用于指导助手。
• 助手消息用于存储先前的响应。

图像生成

使用 ChatgptService 来生成图像实例：

@Autowired
private ChatgptService chatgptService;

public void testImage(){
    String imageUrl = chatgptService.imageGenerate("A cute baby sea otter");
    System.out.print(imageUrl);
}

public void testImageList(){
    List<String> images = chatgptService.imageGenerate("A cute baby sea otter", 2, ImageSize.SMALL, ImageFormat.URL);
    System.out.print(images.toString());
}

示例项目

可以参考示例项目 demo-chatgpt-spring-boot-starter 来更好地理解如何实现和运用这些功能。

开发者信息

• 邮箱：flashvayne@gmail.com
• 博客：vayne.cc

致谢

感谢 JetBrains 对本项目的支持，提供了 JetBrains 开发工具许可证。