openai-java

环境要求

• Java 8 或更高版本
• Gradle 或 Maven 构建工具
• 一个可用的 OpenAI API Key
• 能访问 https://api.openai.com/v1 的网络环境

安装与启动步骤

1. 1添加 Gradle 依赖

   在 build.gradle.kts 的 dependencies 块中加入 SDK 坐标，重新同步项目即可下载依赖。

   implementation("com.openai:openai-java:4.91.0")

   复制

2. 2或添加 Maven 依赖

   Maven 项目把 dependency 片段粘贴到 pom.xml 的 dependencies 中，版本号与仓库最新发布保持一致。

   
     com.openai
     openai-java
     4.91.0
   

   复制

3. 3设置 API Key

   把密钥写入 OPENAI_API_KEY 环境变量，SDK 会通过 fromEnv() 自动读取，避免把密钥写进代码。

   export OPENAI_API_KEY=sk-xxxxxxxx

   复制

4. 4创建客户端

   全局只创建一个 OpenAIClient，它内含连接池与线程池，多个实例反而浪费资源。

   OpenAIClient client = OpenAIOkHttpClient.fromEnv();

   复制

5. 5调用 Responses API

   用 ResponseCreateParams 构建请求，指定 input 与 model，再通过 client.responses().create() 获取结果。

   ResponseCreateParams params = ResponseCreateParams.builder()
           .input("Say this is a test")
           .model(ChatModel.GPT_5_2)
           .build();
   Response response = client.responses().create(params);

   复制

6. 6运行并验证

   编译运行程序，观察是否返回模型生成的文本；也可改用仓库示例目录中的完整示例代码。

   ./gradlew run

   复制

关键配置

如何确认成功

程序正常运行、无鉴权异常，并能打印出模型返回的文本内容，即表示依赖与配置生效。

常见问题

注意事项

• 系统属性优先于环境变量，配置冲突时以系统属性为准。
• 同一应用内不要创建多个客户端，避免重复的连接池与线程池开销。
• 完整可运行示例见仓库 openai-java-example 目录下 com.openai.example 包。
• 本地构建仓库代码前先执行 ./scripts/check-env 与 ./scripts/lint 检查环境与代码风格。