openai4j

OpenAi4J 项目介绍

OpenAi4J 是一个为Java开发者准备的非官方库，旨在简化与OpenAI的GPT模型的交互，包括最新的gpt4-turbo vision和assistant-v2等模型。这个库最初是从TheoKanning/openai-java项目分支出来的，原项目由于停止维护而推出了OpenAi4J，它的开发持续进行，以便整合最新的API功能。

项目特色

• 全面支持：OpenAi4J支持OpenAI的所有API模型，包括文本完成、聊天、编辑、嵌入、音频、文件、Assistant-v2、图像、审核、批处理以及微调等功能。
• 简单易用：通过Retrofit进行的客户端设置使得开发者可以快速与API进行交互。
• 广泛的文档支持：包含丰富的示例和文档，帮助开发者快速上手。
• 可定制性：支持通过环境变量来配置API密钥和基础URL。
• 同步与异步支持：支持同步和异步的API调用方式，便于不同应用情景的集成。

OpenAi4J的目标是为Java开发者提供强大的工具，用以轻松将OpenAI的功能融入到他们的应用之中。

快速入门

引入项目

在使用OpenAi4J之前，开发者需要在他们的项目中引入相应的依赖。以下是使用Gradle和Maven的配置方法：

Gradle

implementation 'io.github.lambdua:api|client|service:0.22.5'

Maven

<dependency>
  <groupId>io.github.lambdua</groupId>
  <artifactId>service</artifactId>
  <version>0.22.5</version>
</dependency>

与OpenAi模型对话

以下是一个简单的与OpenAi模型进行对话的示例代码：

static void simpleChat() {
  // 使用环境变量OPENAI_API_KEY获取API密钥
  OpenAiService service = new OpenAiService(Duration.ofSeconds(30));
  List<ChatMessage> messages = new ArrayList<>();
  ChatMessage systemMessage = new SystemMessage("You are a cute cat and will speak as such.");
  messages.add(systemMessage);
  ChatCompletionRequest chatCompletionRequest = ChatCompletionRequest.builder()
          .model("gpt-4o-mini")
          .messages(messages)
          .n(1)
          .maxTokens(50)
          .build();
  ChatCompletionResult chatCompletion = service.createChatCompletion(chatCompletionRequest);
  System.out.println(chatCompletion.getChoices().get(0).getMessage().getContent());
}

POJOs的使用

如果希望开发自己的客户端，仅需从API模块中导入POJO，以确保命名与OpenAI API兼容。

<dependency>
  <groupId>io.github.lambdua</groupId>
  <artifactId>api</artifactId>
  <version>0.22.5</version>
</dependency>

其它示例

在example包中包含了大部分功能的使用示例，开发者可以参考这些代码以了解如何使用库的各种功能特性。

常见问题 (FAQs)

可以自定义OpenAI的URL或使用代理URL吗？

是的，可以在创建OpenAiService时指定URL作为基础URL。不过，我们推荐使用环境变量OPENAI_API_BASE_URL和OPENAI_API_KEY来加载OpenAI的API密钥。

为什么我会遇到连接超时的问题？

请确保网络稳定并能够访问OpenAI服务器。如果网络不稳定，可以考虑增加超时时间。

贡献与支持

报告问题

如果发现任何问题，请通过GitHub Issues页面提交报告。请尽可能详细地描述如何重现问题，并包括操作系统、Java版本和相关堆栈跟踪等细节。

提交代码

欢迎提交代码改进项目，提交前请确保：

1. 基于main分支创建自己的分支。
2. 已添加应有的测试。
3. 符合现有代码风格。
4. 写清楚的提交日志。

支持我们

如果您觉得这个库对您有帮助，请给我们一个项目星星。您的支持可以帮助我们更好地维护项目并持续优化。

许可证

OpenAi4J使用MIT许可证发布。