首頁>編程相關>其他源碼
下載

it's an “unofficial" or "community-maintained” library. 這是一個非官方的社區維護的庫。有bug歡迎朋友們指出，互相學習。

原創發布轉載註明出處！

文檔地址：https://chatgpt-java.unfbx.com/

星火大模型Java SDK: https://github.com/Grt1228/SparkDesk-Java

To English Doc -> English Doc

聯繫我，ChatGPT相關學習交流諮詢全部免費。

一起探討chatgpt-java，SDK問題諮詢項目產品開發交流群失效關注公眾號恢復：chatgpt-java
QR 圖碼
  • 項目簡介
  • 特性
  • ? 更新日誌
  • 快速開始
    • 方式一
      • 1、導入pom依賴
      • 2、流式客戶端使用示例：
        • 默認OkHttpClient
        • 自定義OkHttpClient客戶端使用示例：
      • 3、默認客戶端使用示例（支持全部API）：
        • 默認OkHttpClient
        • 自定義OkHttpClient客戶端使用示例：
    • 方式二（下載源碼直接運行）
  • ❔ QA
  • ? 國內訪問解決方案
  • ? 開發案例收集
  • ? Star History
  • 鳴謝
  • ☕ 打賞

項目簡介

ChatGPT的Java客戶端OpenAI官方Api的Java SDK，可以快速接入項目使用。支持OpenAI官方全部接口，同時支持Tokens計算。參考文檔：Tokens_README.md 。

Assistant Dall-e-3 FineTuneJob TTS ChatCompletionWithPicture
自定義知識庫、AI助理AI生成圖片微調job文本轉語音附加圖片的ChatCompletion
TikToken Chat Completions Images Speech To Text餘額查詢
Token計算GPT-3.5、4.0對話模型GPT-3.0對話圖片模型語音轉文字，語音翻譯餘額查詢
Embeddings Files Moderations Fine-tune Models
嵌入自定義訓練模型文本審核，敏感詞鑑別微調模型檢索相關

支持流式輸出：

流式輸出實現方式小程序安卓ios H5
SSE參考：OpenAISSEEventSourceListener不支持支持支持支持
WebSocket參考：OpenAIWebSocketEventSourceListener支持支持支持支持

基於本SDK開發的Demo項目，整合Spring Boot 實現CahtGPT對話模式，思路可以參考： https://github.com/Grt1228/chatgpt-steam-output

特性

  • 支持附加圖片的ChatCompletion、指定返回數據格式、Tool Call、Dall-e-3生成圖片、FineTuneJob、文本轉語音TTS。
  • 支持GPT插件模式參考實現PluginTest
  • 支持當key異常（失效、過期、封禁）時，自定義動態處理key 參考實現DynamicKeyOpenAiAuthInterceptor
  • 支持當key異常時的告警處理（釘釘、飛書、email、企業微信等等需要自定義開發）參考實現DynamicKeyOpenAiAuthInterceptor
  • 支持多種Tokens計算方式
  • 支持自定義OkhttpClient
  • 支持自定義多Apikey
  • 支持自定義ApiKey的獲取策略
  • 支持餘額查詢
  • 支持個人賬戶信息查詢
  • 支持GPT3、GPT3.5、GPT4.0、GPT3.5—0614、GPT4.0—0614...
  • 支持全部OpenAI的Api

? 更新日誌

  • 1.1.6 ChatCompletion接口支持logprobs參數設置，Assistant相關接口支持流式輸出
  • 1.1.5 Bug Fix
  • 1.1.3 支持Assistant、Run、Thread、Message Api。測試案例OpenAiClientTest
  • 1.1.2-beta0 支持附加圖片的ChatCompletion、指定返回數據格式、Tool Call、Dall-e-3生成圖片、FineTuneJob、文本轉語音TTS。官方文檔示例：chatgpt-java.unfbx.com 。測試案例OpenAiClientTest
  • 1.1.1-beta0 function call改成GPT插件模式調用更加簡單的調用方式.參考實現PluginTest
  • 1.0.15 moderations接口更新，代碼優化，序列化修復。
  • 1.0.14 升級支持最新版Gpt-3.5—0614、Gpt-4.0—0614等模型, 支持function-calling完整使用案例參考：OpenAiClientFunctionTest
  • 1.0.13 支持當key異常（失效、過期、封禁）時，自定義動態處理key，參考實現DynamicKeyOpenAiAuthInterceptor ，支持key異常時的告警處理（釘釘、飛書、email、企業微信等等需要自定義開發）
  • 1.0.12 tokens計算優化、刪除模型接口修改、語音接口更新支持官方最新參數
  • 1.0.11 增加新的餘額查詢接口參考：OpenAiClientTest 和OpenAiStreamClientTest ,修復tokens計算慢的問題，
  • 1.0.10 支持tokens計算：TikTokensTest ，更多詳細的資料參考文檔：Tokens_README.md
  • 1.0.9 支持自定義key使用策略參考：OpenAiClientTest 和OpenAiStreamClientTest ，棄用ChatGPTClient，優化Moderation接口
  • 1.0.8 修改OpenAiClient和OpenAiStreamClient的自定義相關實現，超時設置，代理設置，自定義攔截器設置改為通過自定義OkHttpClient實現，將OkHttpClient交由用戶自定義控制更加合理，可以實現更多的參數自定義。支持多Api Keys配置。
  • 1.0.7 修復反序列化報錯Bug：#79 ，Image SDK枚舉值bug：#76 ，感謝兩位朋友指出：@CCc3120 、@seven-cm
  • 1.0.6 支持餘額查詢參考：OpenAiClientTest 和OpenAiStreamClientTest creditGrants方法,支持最新GPT-4模型，參考：ChatCompletion.Model構建消息體傳入模型即可。感謝群友提供的餘額接口地址以及@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官方接口

快速開始

本項目支持默認輸出和流式輸出。完整SDK測試案例參考：

SDK測試案例Tokens計算測試案例完整Function-Call調用案例
OpenAiClientTest 和OpenAiStreamClientTest Tokens計算參考：TikTokensTest OpenAiClientFunctionTest

方式一

1、導入pom依賴

 <dependency>
    <groupId>com.unfbx</groupId>
    <artifactId>chatgpt-java</artifactId>
    <version>1.0.14-beta1</version>
</dependency>

2、流式客戶端使用示例：

更多SDK示例參考：OpenAiStreamClientTest

默認OkHttpClient 

 public class Test {
    public static void main(String[] args) {
        OpenAiStreamClient client = OpenAiStreamClient.builder()
                .apiKey(Arrays.asList("sk-********","sk-********"))
                //自定义key的获取策略：默认KeyRandomStrategy
                //.keyStrategy(new KeyRandomStrategy())
                .keyStrategy(new FirstKeyStrategy())
                //自己做了代理就传代理地址，没有可不不传
//                .apiHost("https://自己代理的服务器地址/")
                .build();
        //聊天模型：gpt-3.5
        ConsoleEventSourceListener eventSourceListener = new ConsoleEventSourceListener();
        Message message = Message.builder().role(Message.Role.USER).content("你好啊我的伙伴！").build();
        ChatCompletion chatCompletion = ChatCompletion.builder().messages(Arrays.asList(message)).build();
        client.streamChatCompletion(chatCompletion, eventSourceListener);
        CountDownLatch countDownLatch = new CountDownLatch(1);
        try {
            countDownLatch.await();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

自定義OkHttpClient客戶端使用示例： 

 public class Test {
    public static void main(String[] args) {
        //国内访问需要做代理，国外服务器不需要
        Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 7890));
        HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor(new OpenAILogger());
        //！！！！千万别再生产或者测试环境打开BODY级别日志！！！！
        //！！！生产或者测试环境建议设置为这三种级别：NONE,BASIC,HEADERS,！！！
        httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.HEADERS);
        OkHttpClient okHttpClient = new OkHttpClient
                .Builder()
                .proxy(proxy)//自定义代理
                .addInterceptor(httpLoggingInterceptor)//自定义日志
                .connectTimeout(30, TimeUnit.SECONDS)//自定义超时时间
                .writeTimeout(30, TimeUnit.SECONDS)//自定义超时时间
                .readTimeout(30, TimeUnit.SECONDS)//自定义超时时间
                .build();
        OpenAiStreamClient client = OpenAiStreamClient.builder()
                .apiKey(Arrays.asList("sk-********","sk-********"))
                //自定义key的获取策略：默认KeyRandomStrategy
                //.keyStrategy(new KeyRandomStrategy())
                .keyStrategy(new FirstKeyStrategy())
                .okHttpClient(okHttpClient)
                //自己做了代理就传代理地址，没有可不不传
//                .apiHost("https://自己代理的服务器地址/")
                .build();
    }
}

輸出日誌（text是持續輸出的）： 

 23:03:59.158 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI建立sse连接...
23:03:59.160 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "n", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.172 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "n", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.251 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u5fc3", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.313 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u60c5", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.380 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u8212", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.439 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u7545", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.532 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "uff0c", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.579 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u5fc3", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.641 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u65f7", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.673 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u795e", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.751 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u6021", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.782 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：{"id": "cmpl-6pIHnOOJiiUEVMesXwxzzcSQFoZHj", "object": "text_completion", "created": 1677683039, "choices": [{"text": "u3002", "index": 0, "logprobs": null, "finish_reason": null}], "model": "text-davinci-003"}
23:03:59.815 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据：[DONE]
23:03:59.815 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI返回数据结束了
23:03:59.815 [省略无效信息] INFO com.unfbx.chatgpt.sse.ConsoleEventSourceListener - OpenAI关闭sse连接...

3、默認客戶端使用示例（支持全部API）：

更多SDK示例參考：OpenAiClientTest

默認OkHttpClient 

 public class Test {
    public static void main(String[] args) {
        OpenAiClient openAiClient = OpenAiClient.builder()
                .apiKey(Arrays.asList("sk-********","sk-********"))
                //自定义key的获取策略：默认KeyRandomStrategy
                //.keyStrategy(new KeyRandomStrategy())
                .keyStrategy(new FirstKeyStrategy())
                //自己做了代理就传代理地址，没有可不不传
//                .apiHost("https://自己代理的服务器地址/")
                .build();
                //聊天模型：gpt-3.5
        Message message = Message.builder().role(Message.Role.USER).content("你好啊我的伙伴！").build();
        ChatCompletion chatCompletion = ChatCompletion.builder().messages(Arrays.asList(message)).build();
        ChatCompletionResponse chatCompletionResponse = openAiClient.chatCompletion(chatCompletion);
        chatCompletionResponse.getChoices().forEach(e -> {
            System.out.println(e.getMessage());
        });
    }
}

自定義OkHttpClient客戶端使用示例： 

 public class Test {
    public static void main(String[] args) {
        //国内访问需要做代理，国外服务器不需要
        Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 7890));
        HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor(new OpenAILogger());
        //！！！！千万别再生产或者测试环境打开BODY级别日志！！！！
        //！！！生产或者测试环境建议设置为这三种级别：NONE,BASIC,HEADERS,！！！
        httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.HEADERS);
        OkHttpClient okHttpClient = new OkHttpClient
                .Builder()
                .proxy(proxy)//自定义代理
                .addInterceptor(httpLoggingInterceptor)//自定义日志输出
                .addInterceptor(new OpenAiResponseInterceptor())//自定义返回值拦截
                .connectTimeout(10, TimeUnit.SECONDS)//自定义超时时间
                .writeTimeout(30, TimeUnit.SECONDS)//自定义超时时间
                .readTimeout(30, TimeUnit.SECONDS)//自定义超时时间
                .build();
        //构建客户端
        OpenAiClient openAiClient = OpenAiClient.builder()
                .apiKey(Arrays.asList("sk-********","sk-********"))
                //自定义key的获取策略：默认KeyRandomStrategy
                //.keyStrategy(new KeyRandomStrategy())
                .keyStrategy(new FirstKeyStrategy())
                .okHttpClient(okHttpClient)
                //自己做了代理就传代理地址，没有可不不传
//                .apiHost("https://自己代理的服务器地址/")
                .build();
                //聊天模型：gpt-3.5
        Message message = Message.builder().role(Message.Role.USER).content("你好啊我的伙伴！").build();
        ChatCompletion chatCompletion = ChatCompletion.builder().messages(Arrays.asList(message)).build();
        ChatCompletionResponse chatCompletionResponse = openAiClient.chatCompletion(chatCompletion);
        chatCompletionResponse.getChoices().forEach(e -> {
            System.out.println(e.getMessage());
        });
    }
}

方式二（下載源碼直接運行）

下載源碼打包

❔ QA

Q A
如何實現連續對話？ issues：#8
如何實現流式輸出？升級1.0.2版本，參考源碼：OpenAiStreamClientTest
如何整合SpringBoot實現流式輸出的Api接口？參考另外一個項目：chatgpt-steam-output
最新版GPT-3.5-TURBO是否支持？升級1.0.3 已經支持ChatCompletion, 參考測試案例：OpenAiStreamClientTest 和OpenAiStreamClientTest
最新版語言轉文字和語言翻譯是否支持？升級1.0.3 已經支持whisper參考測試案例：OpenAiStreamClientTest 和OpenAiStreamClientTest

? 國內訪問解決方案

國內訪問可以看下這個解決方案： noobnooc/noobnooc#9

? 開發案例收集

基於本SDK開發案例收集：chatgpt-java SDK案例徵集

? Star History

鳴謝

站在巨人的肩膀：

  • OpenAi：https://openai.com/
  • knuddelsgmbh 的jtokkit 的開源計算算法。

☕ 打賞

如果項目對你有幫助，可以選擇請我喝杯奶茶

微信截圖_20230405222411微信截圖_20230405222357

開源協議：LICENSE

展開
附加信息
相關應用
爲您推薦
相關資訊 全部