OpenAI Java API 使用指南

OpenAI Java API 使用指南

openai-java The official Java library for the OpenAI API 项目地址: https://gitcode.com/gh_mirrors/ope/openai-java

1. 项目介绍

OpenAI Java API 是一个开源库，它为 Java 应用程序提供了方便的访问 OpenAI REST API 的方式。这个库允许开发者利用 OpenAI 提供的各种模型，通过 Java 代码进行交互，实现文本生成、机器翻译、代码补全等功能。OpenAI Java API 目前处于测试阶段，可能会有一些小的破坏性更改。

2. 项目快速启动

环境要求

• Java 8 或更高版本

安装

使用 Gradle：

implementation('com.openai:openai-java:0.43.0')

使用 Maven：

<dependency>
    <groupId>com.openai</groupId>
    <artifactId>openai-java</artifactId>
    <version>0.43.0</version>
</dependency>

配置客户端

使用环境变量配置客户端：

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;

// 使用环境变量配置
OpenAIClient client = OpenAIOkHttpClient.fromEnv();

或者手动配置：

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;

// 手动配置 API 密钥
OpenAIClient client = OpenAIOkHttpClient.builder()
    .apiKey("你的 API 密钥")
    .build();

使用客户端

以下是一个生成文本的示例：

import com.openai.models.ChatModel;
import com.openai.models.responses.Response;
import com.openai.models.responses.ResponseCreateParams;

// 创建响应参数
ResponseCreateParams params = ResponseCreateParams.builder()
    .input("这是一个测试")
    .model(ChatModel.GPT_4O)
    .build();

// 发送请求并接收响应
Response response = client.responses().create(params);

3. 应用案例和最佳实践

文本生成案例

import com.openai.models.chat.completions.ChatCompletion;
import com.openai.models.chat.completions.ChatCompletionCreateParams;

// 创建聊天补全参数
ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
    .addUserMessage("这是一个测试")
    .model(ChatModel.O3_MINI)
    .build();

// 发送请求并接收响应
ChatCompletion chatCompletion = client.chat().completions().create(params);

客户端配置最佳实践

• 不要在同一个应用中创建多个客户端实例。每个客户端都有自己的连接池和线程池，共享这些资源会更高效。
• 使用环境变量或配置文件来管理 API 密钥和其他敏感信息。

4. 典型生态项目

OpenAI Java API 的生态项目包括但不限于：

• openai-java-client-okhttp：OpenAI Java API 的 OkHttp 客户端实现。
• openai-java-core：OpenAI Java API 的核心库。
• openai-java-example：包含完整可运行示例的示例项目。

开发者可以根据自己的需求选择合适的项目进行集成和使用。

openai-java The official Java library for the OpenAI API 项目地址: https://gitcode.com/gh_mirrors/ope/openai-java