【开源免费】ChatGPT-Java版SDK重磅更新至1.0.10版，支持Tokens计算，快来一键接入！！！

Bertha 。 2023-10-09 16:26 11阅读 0赞

![format_png][]

## 简介 ##

ChatGPT Java版SDK开源地址：[github.com/Grt1228/cha…][github.com_Grt1228_cha] ，目前收获将近1000个star。

> 有bug欢迎朋友们指出，互相学习，所有咨询全部免费。

最新版：1.0.10

<dependency>
        <groupId>com.unfbx</groupId>
        <artifactId>chatgpt-java</artifactId>
        <version>1.0.10</version>
    </dependency>
    复制代码

整合web示例，支持流式返回：

> 开发思路可以参考：[github.com/Grt1228/cha…][github.com_Grt1228_cha 1]

<table> 
 <thead> 
  <tr> 
   <th>流式输出实现方式</th> 
   <th>小程序</th> 
   <th>安卓</th> 
   <th>ios</th> 
   <th>H5</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>SSE参考：<a href="https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-steam-output%2Fblob%2Fmain%2Fsrc%2Fmain%2Fjava%2Fcom%2Funfbx%2Fchatgptsteamoutput%2Flistener%2FOpenAISSEEventSourceListener.java" title="OpenAISSEEventSourceListener" rel="nofollow">OpenAISSEEventSourceListener</a></td> 
   <td>不支持</td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>WebSocket参考：<a href="https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-steam-output%2Fblob%2Fmain%2Fsrc%2Fmain%2Fjava%2Fcom%2Funfbx%2Fchatgptsteamoutput%2Flistener%2FOpenAIWebSocketEventSourceListener.java" title="OpenAIWebSocketEventSourceListener" rel="nofollow">OpenAIWebSocketEventSourceListener</a></td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>支持</td> 
   <td>支持</td> 
  </tr> 
 </tbody> 
</table>

--------------------

## 更新日志 ##

*  1.0.10 支持tokens计算：[TikTokensTest][] ，更多详细的资料参考文档：[Tokens\_README.md][Tokens_README.md]
 *  1.0.9 支持自定义key使用策略参考：[OpenAiClientTest][] 和[OpenAiStreamClientTest][] ，弃用ChatGPTClient，优化Moderation接口
 *  1.0.8 修改OpenAiClient和OpenAiStreamClient的自定义相关实现，超时设置，代理设置，自定义拦截器设置改为通过自定义OkHttpClient实现，将OkHttpClient交由用户自定义控制更加合理，可以实现更多的参数自定义。支持多Api Keys配置。
 *  1.0.7 修复反序列化报错Bug：[github.com/Grt1228/cha…][github.com_Grt1228_cha 2] ，Image SDK枚举值bug：[github.com/Grt1228/cha…][github.com_Grt1228_cha 3] ，感谢两位朋友指出：[@CCc3120][CCc3120] 、[@seven-cm][seven-cm]
 *  1.0.6 支持余额查询参考：[OpenAiClientTest][] 和[OpenAiStreamClientTest][] creditGrants方法,支持最新GPT-4模型，参考：[ChatCompletion.Model][]构建消息体传入模型即可。感谢群友提供的余额接口地址以及[@PlexPt][PlexPt] 提供的模型参数
 *  1.0.5 支持自定义Api Host，使用Builder构建。参考下面的快速开始部分代码。
 *  1.0.4 官方最新的ChatGPT Stream模式下的Api返回值改动。
 *  1.0.3 支持最新的GPT-3.5-Turbo模型和Whisper-1模型，支持语音功能转文字，语音翻译。OpenAiClient和OpenAiStreamClient支持Builder构造，支持代理。
 *  1.0.2 支持Stream流式输出，参考：OpenAiStreamClient
 *  1.0.1 支持自定义超时时间，自定义OkHttpClient拦截器，参考：OpenAiClient构造函数
 *  1.0.0 支持所有的OpenAI官方接口

--------------------

## 最新版支持tokens计算 ##

### tokens计算说明 ###

openai 的tokens计算规则适合模型先关的，不同的模型计算方法是不一样的。大致的表格如下：

### 关于流式返回 ###

流式返回的数据，返回行数-2=返回tokens

\[DONE\]这一行不参与tokens计算，没有content属性的不参与token计算。 所以tokens数量是4，\["Ser","end","ip","ity"\]，总返回行数6 - 无效行数2 = 4个tokens

[OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI建立sse连接...
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据：{"choices":[{"delta":{"role":"assistant"},"index":0,"finish_reason":null}]}
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据：{"choices":[{"delta":{"content":"Ser"},"index":0,"finish_reason":null}]}
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据：{"choices":[{"delta":{"content":"end"},"index":0,"finish_reason":null}]}
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据：{"choices":[{"delta":{"content":"ip"},"index":0,"finish_reason":null}]}
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据：{"choices":[{"delta":{"content":"ity"},"index":0,"finish_reason":null}]}
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据：{"choices":[{"delta":{},"index":0,"finish_reason":"stop"}]}
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据：[DONE]
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI返回数据结束了
    [OkHttp 省略 INFO com.unfbx.chatgpt.*****istener - OpenAI关闭sse连接...
    复制代码

### tokens计算使用示例 ###

完整使用示例请参考：[TikTokensTest][]

结合chat模型使用示例： 完整示例参考：[OpenAiClientTest][]

public void chatTokensTest() {
            //聊天模型：gpt-3.5
            List<Message> messages = new ArrayList<>(2);
            messages.add(Message.builder().role(Message.Role.USER).content("关注微信公众号：程序员的黑洞。").build());
            messages.add(Message.builder().role(Message.Role.USER).content("进入chatgpt-java交流群获取最新版本更新通知。").build());
            ChatCompletion chatCompletion = ChatCompletion.builder().messages(messages).build();
            ChatCompletionResponse chatCompletionResponse = v2.chatCompletion(chatCompletion);
            //获取请求的tokens数量
            long tokens = chatCompletion.tokens();
            //这种方式也可以
    //        long tokens = TikTokensUtil.tokens(chatCompletion.getModel(),messages);
            log.info("Message集合文本：【{}】", messages, tokens);
            log.info("本地计算的请求的tokens数{}", tokens);
            log.info("本地计算的返回的tokens数{}", TikTokensUtil.tokens(chatCompletion.getModel(),chatCompletionResponse.getChoices().get(0).getMessage().getContent()));
            log.info("---------------------------------------------------");
            log.info("Open AI 官方计算的总的tokens数{}", chatCompletionResponse.getUsage().getTotalTokens());
            log.info("Open AI 官方计算的请求的tokens数{}", chatCompletionResponse.getUsage().getPromptTokens());
            log.info("Open AI 官方计算的返回的tokens数{}", chatCompletionResponse.getUsage().getCompletionTokens());
        }
    复制代码

单独使用示例：

public class TikTokensTest {
        String text;
        List<Message> messages;
    
        @Before
        public void prepareData() {
            text = "关注微信公众号：程序员的黑洞。进入chatgpt-java交流群获取最新版本更新通知。";
            messages = new ArrayList<>(2);
            messages.add(Message.builder().role(Message.Role.USER).content("关注微信公众号：程序员的黑洞。").build());
            messages.add(Message.builder().role(Message.Role.USER).content("进入chatgpt-java交流群获取最新版本更新通知。").build());
        }
        /**
         * gpt-3.5和gpt4.0聊天模型接口计算推荐这种方法
         */
        @Test
        public void chatCompletionTokensTest() {
            
            ChatCompletion completion = ChatCompletion.builder().messages(messages).build();
            long tokens = completion.tokens();
            log.info("Message集合文本：【{}】", messages, tokens);
            log.info("总tokens数{}", tokens);
        }
    
        /**
         * Completion 接口计算推荐使用这种方法
         */
        @Test
        public void completionTokensTest() {
            Completion completion = Completion.builder().prompt(text).build();
            long tokens = completion.tokens();
            log.info("单句文本：【{}】", text);
            log.info("总tokens数{}", tokens);
        }
    
        /**
         * 通过模型模型名称计算
         */
        @Test
        public void byModelNameTest() {
            String modelName = ChatCompletion.Model.GPT_4.getName();
    //        String modelName = ChatCompletion.Model.GPT_3_5_TURBO.getName();
            List<Integer> encode = TikTokensUtil.encode(modelName, text);
            log.info(encode.toString());
            long tokens = TikTokensUtil.tokens(modelName, text);
            log.info("单句文本：【{}】", text);
            log.info("总tokens数{}", tokens);
            log.info("--------------------------------------------------------------");
            tokens = TikTokensUtil.tokens(modelName, messages);
            log.info("Message集合文本：【{}】", messages, tokens);
            log.info("总tokens数{}", tokens);
        }
    
        /**
         * 通过Encoding计算
         */
        @Test
        public void byEncodingTest() {
            EncodingRegistry registry = Encodings.newDefaultEncodingRegistry();
            Encoding enc = registry.getEncoding(EncodingType.P50K_BASE);
            List<Integer> encode = TikTokensUtil.encode(enc, text);
            log.info(encode.toString());
            long tokens = TikTokensUtil.tokens(enc, text);
            log.info("单句文本：【{}】", text);
            log.info("总tokens数{}", tokens);
        }
    
        /**
         * 通过EncodingType计算
         */
        @Test
        public void byEncodingTypeTest() {
            List<Integer> encode = TikTokensUtil.encode(EncodingType.CL100K_BASE, text);
            log.info(encode.toString());
            long tokens = TikTokensUtil.tokens(EncodingType.CL100K_BASE, text);
            log.info("单句文本：【{}】", text);
            log.info("总tokens数{}", tokens);
        }
    
    }
    复制代码

### 站在巨人的肩膀 ###

感谢大佬：[knuddelsgmbh][] 的[jtokkit][] 的开源计算算法。

[format_png]: https://img-blog.csdnimg.cn/img_convert/ccc3b97c41d8ef21f5b0d2a454345a1c.webp?x-oss-process=image/format,png
[github.com_Grt1228_cha]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java
[github.com_Grt1228_cha 1]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-steam-output
[TikTokensTest]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java%2Fblob%2Fmain%2Fsrc%2Ftest%2Fjava%2Fcom%2Funfbx%2Fchatgpt%2FTikTokensTest.java
[Tokens_README.md]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java%2Fblob%2Fmain%2FTokens_README.md
[OpenAiClientTest]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java%2Fblob%2Fmain%2Fsrc%2Ftest%2Fjava%2Fcom%2Funfbx%2Fchatgpt%2FOpenAiClientTest.java
[OpenAiStreamClientTest]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java%2Fblob%2Fmain%2Fsrc%2Ftest%2Fjava%2Fcom%2Funfbx%2Fchatgpt%2FOpenAiStreamClientTest.java
[github.com_Grt1228_cha 2]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java%2Fissues%2F79
[github.com_Grt1228_cha 3]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java%2Fissues%2F76
[CCc3120]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FCCc3120
[seven-cm]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2Fseven-cm
[ChatCompletion.Model]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FGrt1228%2Fchatgpt-java%2Fblob%2Fmain%2Fsrc%2Fmain%2Fjava%2Fcom%2Funfbx%2Fchatgpt%2Fentity%2Fchat%2FChatCompletion.java%2F
[PlexPt]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2FPlexPt
[knuddelsgmbh]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2Fknuddelsgmbh
[jtokkit]: https://link.juejin.cn/?target=https%3A%2F%2Fgithub.com%2Fknuddelsgmbh%2Fjtokkit