release: 0.19.0 (#188)

* test: use o1 in examples (#187)

* feat(client): helpers for discriminated classes with one required prop (#189)

* docs: fix incorrect additional properties info (#190)

* docs: update breaking change expectations

* release: 0.19.0

---------

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>
Co-authored-by: Tomer Aberbach <[email protected]>

Author: stainless-app[bot]

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.18.1"
+  ".": "0.19.0"
 }

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.19.0 (2025-01-30)
+
+Full Changelog: [v0.18.1...v0.19.0](https://github.com/openai/openai-java/compare/v0.18.1...v0.19.0)
+
+### Features
+
+* **client:** helpers for discriminated classes with one required prop ([#189](https://github.com/openai/openai-java/issues/189)) ([adbf4b0](https://github.com/openai/openai-java/commit/adbf4b0dd8d978586842e97ba628f8cf4e3484de))
+
+
+### Documentation
+
+* fix incorrect additional properties info ([#190](https://github.com/openai/openai-java/issues/190)) ([3d443f7](https://github.com/openai/openai-java/commit/3d443f7e545036484b571f1893aa058725ca57f6))
+* update breaking change expectations ([ee4ee2b](https://github.com/openai/openai-java/commit/ee4ee2b876ac5e956fbd35a4e10ed4f21668ae03))
+
 ## 0.18.1 (2025-01-29)
 
 Full Changelog: [v0.18.0...v0.18.1](https://github.com/openai/openai-java/compare/v0.18.0...v0.18.1)

README.md

@@ -3,14 +3,14 @@
 > [!NOTE]  
 > The OpenAI Java API Library is currently in _beta_.
 >
-> There may be frequent breaking changes.
+> There may be minor breaking changes.
 >
 > Have thoughts or feedback? [File an issue](https://github.com/openai/openai-java/issues/new) or comment on [this thread](https://community.openai.com/t/your-feedback-requested-java-sdk/1061029).
 
 <!-- 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.18.1)
-[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.18.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.18.1)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.19.0)
+[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.19.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.19.0)
 
 <!-- x-release-please-end -->
 
@@ -25,7 +25,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfor
 ### Gradle
 
 ```kotlin
-implementation("com.openai:openai-java:0.18.1")
+implementation("com.openai:openai-java:0.19.0")
 ```
 
 ### Maven
@@ -34,7 +34,7 @@ implementation("com.openai:openai-java:0.18.1")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.18.1</version>
+    <version>0.19.0</version>
 </dependency>
 ```
 
@@ -147,19 +147,7 @@ See [Pagination](#pagination) below for more information on transparently workin
 
 To make a request to the OpenAI API, you generally build an instance of the appropriate `Params` class.
 
-In [Example: creating a resource](#example-creating-a-resource) above, we used the `ChatCompletionCreateParams.builder()` to pass to the `create` method of the `completions` service.
-
-Sometimes, the API may support other properties that are not yet supported in the Java SDK types. In that case, you can attach them using the `putAdditionalProperty` method.
-
-```java
-import com.openai.core.JsonValue;
-import com.openai.models.ChatCompletionCreateParams;
-
-ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
-    // ... normal properties
-    .putAdditionalProperty("secret_param", JsonValue.from("4242"))
-    .build();
-```
+See [Undocumented request params](#undocumented-request-params) for how to send arbitrary parameters.
 
 ## Responses
 
@@ -356,18 +344,26 @@ This library is typed for convenient access to the documented API. If you need t
 
 ### Undocumented request params
 
-To make requests using undocumented parameters, you can provide or override parameters on the params object while building it.
+In [Example: creating a resource](#example-creating-a-resource) above, we used the `ChatCompletionCreateParams.builder()` to pass to the `create` method of the `completions` service.
+
+Sometimes, the API may support other properties that are not yet supported in the Java SDK types. In that case, you can attach them using raw setters:
 
 ```java
-FooCreateParams address = FooCreateParams.builder()
-    .id("my_id")
-    .putAdditionalProperty("secret_prop", JsonValue.from("hello"))
+import com.openai.core.JsonValue;
+import com.openai.models.ChatCompletionCreateParams;
+
+ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
+    .putAdditionalHeader("Secret-Header", "42")
+    .putAdditionalQueryParam("secret_query_param", "42")
+    .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))
     .build();
 ```
 
+You can also use the `putAdditionalProperty` method on nested headers, query params, or body objects.
+
 ### Undocumented response properties
 
-To access undocumented response properties, you can use `res._additionalProperties()` on a response object to get a map of untyped fields of type `Map<String, JsonValue>`. You can then access fields like `._additionalProperties().get("secret_prop").asString()` or use other helpers defined on the `JsonValue` class to extract it to a desired type.
+To access undocumented response properties, you can use `res._additionalProperties()` on a response object to get a map of untyped fields of type `Map<String, JsonValue>`. You can then access fields like `res._additionalProperties().get("secret_prop").asString()` or use other helpers defined on the `JsonValue` class to extract it to a desired type.
 
 ## Logging
 

build.gradle.kts

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "com.openai"
-    version = "0.18.1" // x-release-please-version
+    version = "0.19.0" // x-release-please-version
 }
 
 subprojects {

openai-java-core/src/main/kotlin/com/openai/models/FineTuningJob.kt

@@ -644,6 +644,10 @@ private constructor(
                 }
         }
 
+        /** A list of integrations to enable for this fine-tuning job. */
+        fun addWandbIntegration(wandb: FineTuningJobWandbIntegration) =
+            addIntegration(FineTuningJobWandbIntegrationObject.builder().wandb(wandb).build())
+
         /** The method used for fine-tuning. */
         fun method(method: Method) = method(JsonField.of(method))
 

openai-java-core/src/test/kotlin/com/openai/models/BetaAssistantCreateParamsTest.kt

@@ -11,7 +11,7 @@ class BetaAssistantCreateParamsTest {
     @Test
     fun createBetaAssistantCreateParams() {
         BetaAssistantCreateParams.builder()
-            .model(ChatModel.GPT_4O)
+            .model(ChatModel.O1)
             .description("description")
             .instructions("instructions")
             .metadata(JsonValue.from(mapOf<String, Any>()))
@@ -51,7 +51,7 @@ class BetaAssistantCreateParamsTest {
     fun body() {
         val params =
             BetaAssistantCreateParams.builder()
-                .model(ChatModel.GPT_4O)
+                .model(ChatModel.O1)
                 .description("description")
                 .instructions("instructions")
                 .metadata(JsonValue.from(mapOf<String, Any>()))
@@ -87,7 +87,7 @@ class BetaAssistantCreateParamsTest {
                 .build()
         val body = params._body()
         assertThat(body).isNotNull
-        assertThat(body.model()).isEqualTo(ChatModel.GPT_4O)
+        assertThat(body.model()).isEqualTo(ChatModel.O1)
         assertThat(body.description()).contains("description")
         assertThat(body.instructions()).contains("instructions")
         assertThat(body._metadata()).isEqualTo(JsonValue.from(mapOf<String, Any>()))
@@ -128,9 +128,9 @@ class BetaAssistantCreateParamsTest {
 
     @Test
     fun bodyWithoutOptionalFields() {
-        val params = BetaAssistantCreateParams.builder().model(ChatModel.GPT_4O).build()
+        val params = BetaAssistantCreateParams.builder().model(ChatModel.O1).build()
         val body = params._body()
         assertThat(body).isNotNull
-        assertThat(body.model()).isEqualTo(ChatModel.GPT_4O)
+        assertThat(body.model()).isEqualTo(ChatModel.O1)
     }
 }

openai-java-core/src/test/kotlin/com/openai/models/BetaThreadCreateAndRunParamsTest.kt

@@ -16,7 +16,7 @@ class BetaThreadCreateAndRunParamsTest {
             .maxCompletionTokens(256L)
             .maxPromptTokens(256L)
             .metadata(JsonValue.from(mapOf<String, Any>()))
-            .model(ChatModel.GPT_4O)
+            .model(ChatModel.O1)
             .parallelToolCalls(true)
             .responseFormatAuto()
             .temperature(1.0)
@@ -100,7 +100,7 @@ class BetaThreadCreateAndRunParamsTest {
                 .maxCompletionTokens(256L)
                 .maxPromptTokens(256L)
                 .metadata(JsonValue.from(mapOf<String, Any>()))
-                .model(ChatModel.GPT_4O)
+                .model(ChatModel.O1)
                 .parallelToolCalls(true)
                 .responseFormatAuto()
                 .temperature(1.0)
@@ -182,7 +182,7 @@ class BetaThreadCreateAndRunParamsTest {
         assertThat(body.maxCompletionTokens()).contains(256L)
         assertThat(body.maxPromptTokens()).contains(256L)
         assertThat(body._metadata()).isEqualTo(JsonValue.from(mapOf<String, Any>()))
-        assertThat(body.model()).contains(ChatModel.GPT_4O)
+        assertThat(body.model()).contains(ChatModel.O1)
         assertThat(body.parallelToolCalls()).contains(true)
         assertThat(body.responseFormat()).contains(AssistantResponseFormatOption.ofAuto())
         assertThat(body.temperature()).contains(1.0)

openai-java-core/src/test/kotlin/com/openai/models/BetaThreadRunCreateParamsTest.kt

@@ -33,7 +33,7 @@ class BetaThreadRunCreateParamsTest {
             .maxCompletionTokens(256L)
             .maxPromptTokens(256L)
             .metadata(JsonValue.from(mapOf<String, Any>()))
-            .model(ChatModel.GPT_4O)
+            .model(ChatModel.O1)
             .parallelToolCalls(true)
             .responseFormatAuto()
             .temperature(1.0)
@@ -74,7 +74,7 @@ class BetaThreadRunCreateParamsTest {
                 .maxCompletionTokens(256L)
                 .maxPromptTokens(256L)
                 .metadata(JsonValue.from(mapOf<String, Any>()))
-                .model(ChatModel.GPT_4O)
+                .model(ChatModel.O1)
                 .parallelToolCalls(true)
                 .responseFormatAuto()
                 .temperature(1.0)
@@ -132,7 +132,7 @@ class BetaThreadRunCreateParamsTest {
                 .maxCompletionTokens(256L)
                 .maxPromptTokens(256L)
                 .metadata(JsonValue.from(mapOf<String, Any>()))
-                .model(ChatModel.GPT_4O)
+                .model(ChatModel.O1)
                 .parallelToolCalls(true)
                 .responseFormatAuto()
                 .temperature(1.0)
@@ -170,7 +170,7 @@ class BetaThreadRunCreateParamsTest {
         assertThat(body.maxCompletionTokens()).contains(256L)
         assertThat(body.maxPromptTokens()).contains(256L)
         assertThat(body._metadata()).isEqualTo(JsonValue.from(mapOf<String, Any>()))
-        assertThat(body.model()).contains(ChatModel.GPT_4O)
+        assertThat(body.model()).contains(ChatModel.O1)
         assertThat(body.parallelToolCalls()).contains(true)
         assertThat(body.responseFormat()).contains(AssistantResponseFormatOption.ofAuto())
         assertThat(body.temperature()).contains(1.0)

openai-java-core/src/test/kotlin/com/openai/services/blocking/beta/AssistantServiceTest.kt

@@ -30,7 +30,7 @@ class AssistantServiceTest {
         val assistant =
             assistantService.create(
                 BetaAssistantCreateParams.builder()
-                    .model(ChatModel.GPT_4O)
+                    .model(ChatModel.O1)
                     .description("description")
                     .instructions("instructions")
                     .metadata(JsonValue.from(mapOf<String, Any>()))

openai-java-core/src/test/kotlin/com/openai/services/blocking/beta/ThreadServiceTest.kt

@@ -152,7 +152,7 @@ class ThreadServiceTest {
                     .maxCompletionTokens(256L)
                     .maxPromptTokens(256L)
                     .metadata(JsonValue.from(mapOf<String, Any>()))
-                    .model(ChatModel.GPT_4O)
+                    .model(ChatModel.O1)
                     .parallelToolCalls(true)
                     .responseFormatAuto()
                     .temperature(1.0)
@@ -251,7 +251,7 @@ class ThreadServiceTest {
                     .maxCompletionTokens(256L)
                     .maxPromptTokens(256L)
                     .metadata(JsonValue.from(mapOf<String, Any>()))
-                    .model(ChatModel.GPT_4O)
+                    .model(ChatModel.O1)
                     .parallelToolCalls(true)
                     .responseFormatAuto()
                     .temperature(1.0)

openai-java-core/src/test/kotlin/com/openai/services/blocking/beta/threads/RunServiceTest.kt

@@ -53,7 +53,7 @@ class RunServiceTest {
                     .maxCompletionTokens(256L)
                     .maxPromptTokens(256L)
                     .metadata(JsonValue.from(mapOf<String, Any>()))
-                    .model(ChatModel.GPT_4O)
+                    .model(ChatModel.O1)
                     .parallelToolCalls(true)
                     .responseFormatAuto()
                     .temperature(1.0)
@@ -105,7 +105,7 @@ class RunServiceTest {
                     .maxCompletionTokens(256L)
                     .maxPromptTokens(256L)
                     .metadata(JsonValue.from(mapOf<String, Any>()))
-                    .model(ChatModel.GPT_4O)
+                    .model(ChatModel.O1)
                     .parallelToolCalls(true)
                     .responseFormatAuto()
                     .temperature(1.0)