实现可连续对话和流式输出的ChatGPT API（基于SpringBoot和Vue实现流式输出）+源代码+文档说明

<p align="center"> <h1 align="center">📦 ChatGPT</h1> <div align="center">实现可连续对话ChatGPT插件</div> </p> [](./README_en.md) [](./README.md) > 本文Demo(SpringBoot和Main方法Demo均包括)的Git地址：[https://github.com/asleepyfish/chatgpt-demo](https://github.com/asleepyfish/chatgpt-demo) > 流式输出结合Vue前端的Demo的Git地址：[https://github.com/asleepyfish/chatgpt-vue](https://github.com/asleepyfish/chatgpt-vue) ==2023-05-28更新== > 制作了一个基于本文sdk包的对话网站，可前往[http://chatgpt.alpacos.cn/](http://chatgpt.alpacos.cn/)体验。 > **[注]：** 由于本人的服务器的带宽较低，首次加载页面可能会略有些慢，请耐心等待，详细使用说明请查看另一篇博客~ 👇 > [ChatGPT网页版（基于SpringBoot和Vue）](https://blog.csdn.net/qq_41821963/article/details/130918024?spm=1001.2014.3001.5502) ==2023-07-17更新== > 所有的测试Demo均包括结合Spring框架的（`ChatGPTController`类中）和`main`方法使用（`MainTest`类中） > > Demo地址：https://github.com/asleepyfish/chatgpt-demo **注意：** 流式输出在2.4节，请仔细阅读到最后。 # 版本更新说明 - 1.1.5 增加查询账单功能`billingUsage`（单位：美元），可以选择传入开始和结束日期查询（最多100天），或者不传入参，此时表示查询所有日期账单。 - 1.1.6 增加自定义`OpenAiProxyService`功能，支持单个SpringBoot中添加多个`OpenAiProxyService`实例，每个实例可以拥有个性化的参数；查询账单功能优化。 - 1.2.0 增加`subscription`方法（查询订阅信息，包括订阅到期日和账号额度等信息，但是没有使用量情况，使用通过`billingUsage`方法查询使用量），增加`billing`方法，整合了`subscription`和`billingUsage`方法，出参包括订阅到期日、额度、使用量、余量等信息。增加对内部cache的多种操作，包括获取，赋值等操作。 - 1.2.1 `billing`方法中出参`dueDate`取值逻辑修改，`ChatGPTProperties`类支持build链式创建对象。 - 1.3.0 新增以下方法，每种方法均包含多种重载方法，具体使用请参考：[https://github.com/asleepyfish/chatgpt-demo](https://github.com/asleepyfish/chatgpt-demo) - `listModels`、`getModel` - `edit` - `embeddings` - `transcription`、`translation` - `createImageEdit`、`createImageVariation` - `listFiles`、`uploadFile`、`deleteFile`、`retrieveFile`、`retrieveFileContent` - `createFineTune`、`createFineTuneCompletion`、`listFineTunes`、`retrieveFineTune`、`cancelFineTune`、`listFineTuneEvents`、`deleteFineTune` - `createModeration` - 1.3.1 支持自定义baseUrl，默认为 `https://api.openai.com/` ，配置参数在`ChatGPTProperties`类中，可通过`application.yml`配置。 - 1.3.2 修复自定义`baseUrl`后无法访问bug，自定义`baseUrl`必须以`/`结尾。新增自定义属于自己的`baseUrl`示例。 - 1.3.3 支持自定义`OkHttpClient`，解决`OkHttpClient`默认并发数无法指定问题，解决部分Proxy登录需要账号密码问题，详细介绍见2.12节。 - 1.3.4 修复指定`baseUrl`后未切换`baseUrl`bug，`1.3.3`版本不建议使用。 - 1.3.5 支持SpringBoot3引用(SpringBoot3所需JDK最低是17)，代码Demo见[https://github.com/asleepyfish/chatgpt-demo](https://github.com/asleepyfish/chatgpt-demo)，分支为**dev-springboot3** # 1. 配置阶段 ## 1.1 依赖引入 `pom.xml`中引入依赖 - Latest Version:  - Maven: ```xml <dependency> <groupId>io.github.asleepyfish</groupId> <artifactId>chatgpt</artifactId> <version>Latest Version</version> </dependency> ``` ## 1.2 配置application.yml文件 **注意：** 如果需要和`SpringBoot`集成则需要配置`application.yml`，如果只需要Main方法调用，可参考第3节扩展部分。 在`application.yml`文件中配置chatgpt相关参数（Optional为可选参数） **注：大陆用户需要配置proxy-host和proxy-port来进行代理才能访问OpenAI服务** | 参数 | 解释 | | ---------------------------------- | ------------------------------------------------------------ | | token | 申请的API KEYS | | proxy-host (Optional) | 代理的ip | | proxy-port (Optional) | 代理的端口 | | model (Optional) | model可填可不填，默认即text-davinci-003 | | chat-model (Optional) | 可填可不填，默认即gpt-3.5-turbo （ChatGPT当前最强模型，生成回答使用的就是这个模型） | | retries (Optional) | 指的是当chatgpt第一次请求回答失败时，重新请求的次数（增加该参数的原因是因为大量访问的原因，在某一个时刻，chatgpt服务将处于无法访问的情况，不填的默认值为5） | | session-expiration-time (Optional) | （单位（min））为这个会话在多久不访问后被销毁，这个值不填的时候，即表示所有问答处于同一个会话之下，相同user的会话永不销毁（增加请求消耗） | | base-url (Optional) | 默认为 `https://api.openai.com/ `，可不填 | 例： ```yml chatgpt: token: sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx #必填 # proxy-host: 127.0.0.1 #需要代理时必填 # proxy-port: 7890 #需要代理时必填 # model: text-davinci-003 #可选 # chat-model: gpt-3.5-turbo #可选 # retries: 10 #可选，默认为5 # session-expiration-time: 30 #可选，不填则会话永不过期 # base-url: https://apps.ichati.cn/1d6f32f8-b59d-46f8-85e9-7d434bxxxxxx/ #可选，默认为https://api.openai.com/，请记住务必以/结尾 ``` **_其中token必填、大陆用户proxy-host、proxy-port也是必填的（某些你懂的原因）_** 上面的session-expiration-time参数很重要，是用来表示这个会话在多久不访问后被销毁，从而实现联系上下文的连续对话。 实现方式是通过ChatCompletionRequest中的user来区分某个会话，而session-expiration-time表示这个会话在多久不访问后被销毁。 **如果这里看不懂请看2.1节示例** ## 1.3 @EnableChatGPT注解 启动类上加入`@EnableChatGPT`注解则将ChatGPT服务注入到Spring中。  # 2 使用 **注意：**下面的使用`OpenAiUtils`调用的方法均需要和`SpringBoot`集成，才可使用。使用第四节自定义`OpenAiProxyService`的方式调用方法，不需要和`SpringBoot`集成，在Main方法中就可以使用！！！ ## 2.1 生成回答 提供了工具类`OpenAiUtils`，里面提供了相关方法进行调用。 其中最简单的使用方法是： ```java OpenAiUtils.createChatCompletion(content);// 不建议使用 ``` 入参`content`即输入的问题的字符串。但是不建议使用。 这里建议使用下面的方式，通过传入user的值，再结合`session-expiration-time`参数，可以实现指定某次会话，或者某个用户的连续对话。 ```java OpenAiUtils.createChatCompletion(content, user);// 建议使用 ``` 还提供一个通用的静态方法是 ```java public static List<String> createChatCompletion(ChatCompletionRequest chatCompletionRequest) {...} ``` 入参`ChatCompletionRequest `里包含模型的一些可调参数。 `OpenAiUtils`类中还提供了多个�