chatgpt-java

环境要求

• Java 项目，使用 Maven 或 Gradle 构建
• 已获取 OpenAI API Key（sk- 开头）
• 国内网络调用需准备 HTTP 或 SOCKS5 代理
• 需要可用的 反向代理地址（可选，国内常用）

安装与启动步骤

1. 1添加Maven依赖

   在项目 pom.xml 的 dependencies 节点中加入该依赖，groupId 为 com.github.plexpt，README 示例版本为 6.0.0。

   <dependency>
       <groupId>com.github.plexpt</groupId>
       <artifactId>chatgpt</artifactId>
       <version>6.0.0</version>
   </dependency>

   复制

2. 2添加Gradle依赖

   如果项目用 Gradle 构建，则在 build.gradle 的 dependencies 中加入下面这一行即可。

   implementation group: 'com.github.plexpt', name: 'chatgpt', version: '6.0.0'

   复制

3. 3初始化ChatGPT客户端

   用 ChatGPT.builder() 依次传入 apiKey、proxy、apiHost，最后调用 init() 完成初始化。

   Proxy proxy = Proxys.http("127.0.0.1", 1081);
   // Proxy proxy = Proxys.socks5("127.0.0.1", 1080);
   
   ChatGPT chatGPT = ChatGPT.builder()
           .apiKey("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")
           .proxy(proxy)
           .apiHost("https://api.openai.com/")
           .build()
           .init();

   复制

4. 4发起最简对话

   初始化完成后直接调用 chat() 传入问题字符串，返回值就是模型回答，打印即可看到结果。

   String res = chatGPT.chat("写一段七言绝句诗，题目是：火锅！");
   System.out.println(res);

   复制

5. 5自定义对话参数

   进阶用法：用 ChatCompletion.builder() 指定 model、messages、maxTokens、temperature 后再请求。

   Message system = Message.ofSystem("你现在是一个诗人，专门写七言绝句");
   Message message = Message.of("写一段七言绝句诗，题目是：火锅！");
   
   ChatCompletion chatCompletion = ChatCompletion.builder()
           .model(ChatCompletion.Model.GPT_3_5_TURBO.getName())
           .messages(Arrays.asList(system, message))
           .maxTokens(3000)
           .temperature(0.9)
           .build();
   ChatCompletionResponse response = chatGPT.chatCompletion(chatCompletion);
   System.out.println(response.toPlainString());

   复制

6. 6实现流式输出

   改用 ChatGPTStream 并传入 StreamListener，ConsoleStreamListener 会把内容逐段打印到控制台。

   ChatGPTStream chatGPTStream = ChatGPTStream.builder()
           .timeout(600)
           .apiKey("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")
           .proxy(Proxys.http("127.0.0.1", 1080))
           .apiHost("https://api.openai.com/")
           .build()
           .init();
   
   ConsoleStreamListener listener = new ConsoleStreamListener();
   Message message = Message.of("写一段七言绝句诗，题目是：火锅！");
   ChatCompletion chatCompletion = ChatCompletion.builder()
           .messages(Arrays.asList(message))
           .build();
   chatGPTStream.streamChatCompletion(chatCompletion, listener);

   复制

7. 7运行控制台测试

   没有自己的代码时可先运行仓库自带的 ConsoleChatGPT 类做验证，替换其中的 apiKey 后再启动。

关键配置

如何确认成功

运行示例代码后，控制台打印出模型返回的七言绝句内容且无异常抛出，说明 SDK 接入成功。

常见问题

注意事项

• README 示例中的 apiKey 是公开样例，务必替换为自己的真实密钥，避免泄露。
• 依赖版本 6.0.0 为 README 示例版本，实际使用前建议在 Maven Central 确认最新版本号。
• 国内网络环境必须配置代理或反向代理，否则请求可能失败。
• SseStreamListener 可配合 Spring 的 SseEmitter 使用，适合网页端流式对话场景。