如何在 SpringBoot 项目中接入 ChartGPT

大家好,我是公子骏。最近体验了火爆全网的 ChartGPT,深刻体会了其强大的能力,这让我们程序猿对AI的未来突然有了广大的畅想空间。

我也在网上看到不少大牛通过 ChartGPT 来获取收益,就寻思着能否自己接入 ChartGPT 的 API 来做些什么事情。

然后到网上找了不少 Java 接入 ChatGPT 的文章案例,成功实现了接入,而本文就是我整理了这些案例后,使用 Forest 框架重写了一遍接入方法。

一、前期工作

  1. 注册 OpenAI 的账号

  2. 获取 OpenAI 的 API KEY

如何完成这两步网上的资料很多,我这里就不再赘述了。

需要注意的是,API KEY 在创建好之后一定要保存好,否则退出创建页面后就可能找不到了。

二. 添加依赖

除了基本的 SpringBoot 依赖外,还需添加以下 Maven 依赖

<!-- Forest 的 SpringBoot 启动包 -->
<dependency>
    <groupId>com.dtflys.forest</groupId>
    <artifactId>forest-spring-boot-starter</artifactId>
    <version>1.5.30</version>
</dependency>

<!-- Fastjson -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.83</version>
</dependency>

 

三. 配置

application.yml文件中添加下列配置

forest:
  connect-timeout: 60000      # HTTP请求连接超时时间
  read-timeout: 60000         # HTTP请求读取超时时间
  variables:                  # 自定义变量:
    apiKey: YOUR_API_KEY      # 你的 OpenAI 的 API KEY
    model: text-davinci-003   # ChartGPT 的模型
    maxTokens: 50             # 最大 Token 数
    temperature: 0.5          # 该值越大每次返回的结果越随机,即相似度越小

 

四. 定义 ChartGPT 的接入接口

创建一个interface类,名字就叫 ChartGPT (名字可以随意起)

public interface ChartGPT {
    // 只要输入一个参数: 提示词
    // 该方法就会发送 HTTP 请求到 OpenAI 的接口服务
    // 并将响应结果以字符串形式返回回来
    @Post(
            url = "https://api.openai.com/v1/engines/${model}/completions",
            contentType = "application/json",
            headers = "Authorization: Bearer ${apiKey}",
            data = "{\"prompt\": \"${prompt}\", \"max_tokens\": ${maxTokens}, \"temperature\": ${temperature}}"
    )
    String send(@Var("prompt") String prompt);
}

 

五. 调用接口

在需要调用的地方注入ChartGPT接口实例,并可调用获取 ChartGPT 的结果

@Resource
private ChartGPT chartGPT;

public void run() {
    String response = chartGPT.send("你好");
    System.out.println(response);
}

执行程序后,会在控制台上打印出 ChartGPT 的响应结果

{"id":"cmpl-6ze62yNNtH5ZHNkaPjWUZORoEtojK","object":"text_completion","created":1680150158,"model":"text-davinci-003","choices":[{"text":"\n\n你好!","index":0,"logprobs":null,"finish_reason":"stop"}],"usage":{"prompt_tokens":4,"completion_tokens":9,"total_tokens":13}}

 

到这一步已经算初步成功了!

但你发现我们接受到的是一个JSON字符串,并不能直接处理它,需要进一步的加工。

六. 改进

我们添加两个数据类

在 ChartGPT 返回的 JSON 字符串后,Forest 框架会自动将其反序列化成这些数据类

添加的第一个数据类 GPTResponse: 用于接受 ChartGPT 响应结果最外层 JSON 结构的数据类

@Data
public class GPTResponse {

    private String id;

    private String object;

    private String created;

    private String model;

    private List<GPTChoice> choices;
}

 

添加的二个数据类 GPTChoice: 用于接受 ChartGPT 响应结果 JSON 结构里层中文本内容部分的数据类
@Data
public class GPTChoice {

    private String text;

    private Integer index;
}

 

改一下接口的返回类型
public interface ChartGPT {
    // Forest 会自动将响应结果反序列化成 GPTResponse 类型并返回出来
    @Post(
            url = "https://api.openai.com/v1/engines/${model}/completions",
            contentType = "application/json",
            headers = "Authorization: Bearer ${apiKey}",
            data = "{\"prompt\": \"${prompt}\", \"max_tokens\": ${maxTokens}, \"temperature\": ${temperature}}"
    )
    GPTResponse send(@Var("prompt") String prompt);
}

 

改一下调用部分的代码
GPTResponse response = chartGPT.send("你好");
System.out.println(response.getChoices().get(0).getText());
执行一下,然后会在控制台上看到类似的输出内容
你好!很高兴见到你!

示例代码

如果以上步骤都完成了,祝贺你!你是一名优秀的程序猿~

完不成也没关系,我在开源仓库里也提供了示例工程代码,方便大家参考

https://gitee.com/dromara/forest/tree/master/forest-examples/example-chartgpt

或者关注公众号 程序猿公子骏,回复消息 chartgpt,即可获得示例工程源码