OpenAI4J: 全面支持OpenAI API的Java客户端库

OpenAI4J: 全面支持OpenAI API的Java客户端库

OpenAI4J是一个专为Java开发者设计的强大客户端库,旨在简化与OpenAI API的交互过程。这个库提供了全面的支持,涵盖了OpenAI所有的API模型和功能,包括Completions、Chat、Edits、Embeddings、Audio、Files、Assistants-v2、Images、Moderations、Batch以及Fine-tuning等。OpenAI4J的目标是让Java开发者能够轻松地将OpenAI的先进人工智能能力整合到他们的应用程序中。

主要特性

OpenAI4J提供了以下核心特性:

1. 全面支持: 支持OpenAI的所有API模型和功能,确保开发者可以使用最新的AI技术。

2. 易用性: 通过Retrofit实现的客户端设置,使API交互变得简单直接。

3. 丰富的示例: 提供大量示例代码和详细文档,帮助开发者快速上手。

4. 灵活配置: 支持通过环境变量集成API密钥和基础URL,提高了安全性和灵活性。

5. 同步和异步调用: 支持同步和异步API调用,满足不同场景的需求。

快速开始

要开始使用OpenAI4J,您需要先将其添加到您的项目中。以下是使用不同构建工具的依赖配置:

Maven

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

Gradle

implementation 'io.github.lambdua:service:0.22.1'

基本用法示例

以下是一个简单的聊天完成示例,展示了如何使用OpenAI4J与GPT模型进行交互:

static void simpleChat() {
  // API密钥从环境变量OPENAI_API_KEY获取
  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());
}

高级功能

OpenAI4J不仅支持基本的API调用,还提供了许多高级功能,使开发者能够充分利用OpenAI的能力:

1. GPT视觉识别: 支持图像识别功能,允许模型理解和描述图像内容。

2. 工具调用: 支持函数调用和工具使用,使模型能够执行更复杂的任务。

3. 流式对话: 支持流式API调用,实现实时对话效果。

4. Token使用计算: 提供了计算token使用量的工具,帮助开发者优化API使用。

5. Assistant功能: 支持OpenAI的Assistant API,可以创建和管理AI助手。

自定义配置

OpenAI4J提供了灵活的配置选项,允许开发者根据需求自定义服务:

// 使用自定义基础URL和默认配置
OpenAiService openAiService1 = new OpenAiService(API_KEY, BASE_URL);

// 自定义超时时间
OpenAiService openAiService2 = new OpenAiService(API_KEY, Duration.ofSeconds(10));

// 更灵活的自定义配置
OkHttpClient client = new OkHttpClient.Builder()
        .connectionPool(new ConnectionPool(Runtime.getRuntime().availableProcessors() * 2, 30, TimeUnit.SECONDS))
        .connectTimeout(2, TimeUnit.SECONDS)
        .writeTimeout(3, TimeUnit.SECONDS)
        .readTimeout(10, TimeUnit.SECONDS)
        .protocols(Arrays.asList(Protocol.HTTP_2, Protocol.HTTP_1_1))
        .build();

Retrofit retrofit = OpenAiService.defaultRetrofit(client, OpenAiService.defaultObjectMapper(), BASE_URL);
OpenAiApi openAiApi = retrofit.create(OpenAiApi.class);
OpenAiService openAiService3 = new OpenAiService(openAiApi);

流式聊天示例

OpenAI4J支持流式API调用,这在实现实时对话功能时特别有用:

static void streamChat() {
  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();
  service.streamChatCompletion(chatCompletionRequest).blockingForEach(System.out::println);
}

工具调用示例

OpenAI4J支持使用工具和函数调用,这里展示了如何定义和使用一个天气查询功能:

static void toolChat() {
    OpenAiService service = new OpenAiService(Duration.ofSeconds(30));
    final ChatTool tool = new ChatTool(ToolUtil.weatherFunction());
    final List<ChatMessage> messages = new ArrayList<>();
    final ChatMessage systemMessage = new SystemMessage("You are a helpful assistant.");
    final ChatMessage userMessage = new UserMessage("What is the weather in BeiJin?");
    messages.add(systemMessage);
    messages.add(userMessage);

    ChatCompletionRequest chatCompletionRequest = ChatCompletionRequest.builder()
            .model("gpt-4o-mini")
            .messages(messages)
            .tools(Collections.singletonList(tool))
            .toolChoice(ToolChoice.AUTO)
            .n(1)
            .maxTokens(100)
            .build();
    ChatCompletionChoice choice = service.createChatCompletion(chatCompletionRequest).getChoices().get(0);
    AssistantMessage toolCallMsg = choice.getMessage();
    ChatToolCall toolCall = toolCallMsg.getToolCalls().get(0);
    System.out.println(toolCall.getFunction());

    messages.add(toolCallMsg);
    messages.add(new ToolMessage("the weather is fine today.", toolCall.getId()));

    ChatCompletionRequest toolCallRequest = ChatCompletionRequest.builder()
            .model("gpt-4o-mini")
            .messages(messages)
            .n(1)
            .maxTokens(100)
            .build();
    ChatCompletionChoice toolCallChoice = service.createChatCompletion(toolCallRequest).getChoices().get(0);
    System.out.println(toolCallChoice.getMessage().getContent());
}

贡献与支持

OpenAI4J是一个开源项目,欢迎社区成员贡献代码、报告问题或提出新的功能建议。如果您发现这个库对您有帮助,可以考虑在GitHub上给项目一个星标,这将有助于项目的持续改进和维护。

结语

OpenAI4J为Java开发者提供了一个强大而灵活的工具,使他们能够轻松地将OpenAI的先进AI能力集成到自己的应用中。无论是构建聊天机器人、内容生成工具,还是复杂的AI辅助系统,OpenAI4J都能提供必要的支持。通过丰富的功能、详细的文档和活跃的社区支持,OpenAI4J正在成为Java开发者在AI领域探索和创新的重要工具。

随着AI技术的不断发展,OpenAI4J也将持续更新,为开发者提供最新、最强大的AI工具。无论您是AI领域的专家,还是刚刚开始探索AI应用的开发者,OpenAI4J都将是您不可或缺的得力助手。让我们一起embraceAI带来的无限可能,用Java构建更智能、更强大的应用程序!