release: 0.10.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.9.1"
+  ".": "0.10.0"
 }

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.10.0 (2025-01-08)
+
+Full Changelog: [v0.9.1...v0.10.0](https://github.com/openai/openai-java/compare/v0.9.1...v0.10.0)
+
+### Features
+
+* **client:** add various convenience setters to models ([#91](https://github.com/openai/openai-java/issues/91)) ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+* **client:** allow passing null or optional for nullable fields ([#84](https://github.com/openai/openai-java/issues/84)) ([8a8f2f9](https://github.com/openai/openai-java/commit/8a8f2f9ac5f6555c372a81acc196b3ab04fd9555))
+* **client:** allow setting arbitrary JSON for top-level body params ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+* **client:** expose getters for `JsonField` of body params ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+
+
+### Bug Fixes
+
+* **client:** consistently throw on omitting required fields ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+* **client:** convert `JsonField` containing list type to mutable in builder ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+
+
+### Documentation
+
+* add params class javadocs ([#90](https://github.com/openai/openai-java/issues/90)) ([9a33c1c](https://github.com/openai/openai-java/commit/9a33c1cf22e30e1878d739acfab4258321c6a9f8))
+
+
+### Styles
+
+* **internal:** explicitly add some method return types ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+* **internal:** move headers and query params setters below others ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+* **internal:** simplify existing convenience setters on params ([9b3eb17](https://github.com/openai/openai-java/commit/9b3eb17270075587ac9c2701b0e41a7debf17bec))
+
 ## 0.9.1 (2025-01-06)
 
 Full Changelog: [v0.9.0...v0.9.1](https://github.com/openai/openai-java/compare/v0.9.0...v0.9.1)

README.md

@@ -9,7 +9,7 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.9.1)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.10.0)
 
 <!-- x-release-please-end -->
 
@@ -32,7 +32,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfo
 <!-- x-release-please-start-version -->
 
 ```kotlin
-implementation("com.openai:openai-java:0.9.1")
+implementation("com.openai:openai-java:0.10.0")
 ```
 
 #### Maven
@@ -41,7 +41,7 @@ implementation("com.openai:openai-java:0.9.1")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.9.1</version>
+    <version>0.10.0</version>
 </dependency>
 ```
 

build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 
 allprojects {
     group = "com.openai"
-    version = "0.9.1" // x-release-please-version
+    version = "0.10.0" // x-release-please-version
 }
 
 

openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt

@@ -13,6 +13,7 @@ import com.openai.credential.Credential
 import java.net.Proxy
 import java.time.Clock
 import java.time.Duration
+import java.util.Optional
 
 class OpenAIOkHttpClient private constructor() {
 
@@ -138,9 +139,13 @@ class OpenAIOkHttpClient private constructor() {
             clientOptions.azureServiceVersion(azureServiceVersion)
         }
 
-        fun organization(organization: String) = apply { clientOptions.organization(organization) }
+        fun organization(organization: String?) = apply { clientOptions.organization(organization) }
 
-        fun project(project: String) = apply { clientOptions.project(project) }
+        fun organization(organization: Optional<String>) = organization(organization.orElse(null))
+
+        fun project(project: String?) = apply { clientOptions.project(project) }
+
+        fun project(project: Optional<String>) = project(project.orElse(null))
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 

openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt

@@ -13,6 +13,7 @@ import com.openai.credential.Credential
 import java.net.Proxy
 import java.time.Clock
 import java.time.Duration
+import java.util.Optional
 
 class OpenAIOkHttpClientAsync private constructor() {
 
@@ -138,9 +139,13 @@ class OpenAIOkHttpClientAsync private constructor() {
             clientOptions.azureServiceVersion(azureServiceVersion)
         }
 
-        fun organization(organization: String) = apply { clientOptions.organization(organization) }
+        fun organization(organization: String?) = apply { clientOptions.organization(organization) }
 
-        fun project(project: String) = apply { clientOptions.project(project) }
+        fun organization(organization: Optional<String>) = organization(organization.orElse(null))
+
+        fun project(project: String?) = apply { clientOptions.project(project) }
+
+        fun project(project: Optional<String>) = project(project.orElse(null))
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 

openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt

@@ -14,6 +14,7 @@ import com.openai.core.http.RetryingHttpClient
 import com.openai.credential.BearerTokenCredential
 import com.openai.credential.Credential
 import java.time.Clock
+import java.util.Optional
 import java.util.concurrent.Executor
 import java.util.concurrent.Executors
 import java.util.concurrent.ThreadFactory
@@ -91,6 +92,30 @@ private constructor(
 
         fun baseUrl(baseUrl: String) = apply { this.baseUrl = baseUrl }
 
+        fun responseValidation(responseValidation: Boolean) = apply {
+            this.responseValidation = responseValidation
+        }
+
+        fun maxRetries(maxRetries: Int) = apply { this.maxRetries = maxRetries }
+
+        fun apiKey(apiKey: String) = apply {
+            this.credential = BearerTokenCredential.create(apiKey)
+        }
+
+        fun credential(credential: Credential) = apply { this.credential = credential }
+
+        fun azureServiceVersion(azureServiceVersion: AzureOpenAIServiceVersion) = apply {
+            this.azureServiceVersion = azureServiceVersion
+        }
+
+        fun organization(organization: String?) = apply { this.organization = organization }
+
+        fun organization(organization: Optional<String>) = organization(organization.orElse(null))
+
+        fun project(project: String?) = apply { this.project = project }
+
+        fun project(project: Optional<String>) = project(project.orElse(null))
+
         fun headers(headers: Headers) = apply {
             this.headers.clear()
             putAllHeaders(headers)
@@ -171,26 +196,6 @@ private constructor(
 
         fun removeAllQueryParams(keys: Set<String>) = apply { queryParams.removeAll(keys) }
 
-        fun responseValidation(responseValidation: Boolean) = apply {
-            this.responseValidation = responseValidation
-        }
-
-        fun maxRetries(maxRetries: Int) = apply { this.maxRetries = maxRetries }
-
-        fun apiKey(apiKey: String) = apply {
-            this.credential = BearerTokenCredential.create(apiKey)
-        }
-
-        fun credential(credential: Credential) = apply { this.credential = credential }
-
-        fun azureServiceVersion(azureServiceVersion: AzureOpenAIServiceVersion) = apply {
-            this.azureServiceVersion = azureServiceVersion
-        }
-
-        fun organization(organization: String) = apply { this.organization = organization }
-
-        fun project(project: String) = apply { this.project = project }
-
         fun fromEnv() = apply {
             val openAIKey = System.getenv("OPENAI_API_KEY")
             val openAIOrgId = System.getenv("OPENAI_ORG_ID")