release: 0.35.1 (#329)

* chore(internal): remove CI condition (#310)

* chore(internal): update release workflows

* docs: deduplicate and refine comments (#313)

* chore(internal): make test classes internal (#317)

* chore(internal): add generated comment (#318)

* docs: add `build` method comments (#321)

* chore(internal): refactor query param serialization impl and tests (#322)

* chore(internal): rename `getPathParam` (#323)

chore(internal): reorder some params methodsc
chore(internal): delete duplicate tests
chore(internal): refactor some test assertions

* chore(internal): reformat some tests (#324)

chore(internal): generate more tests

* feat(client): don't require params for some service methods (#325)

* chore(internal): add some tests for union classes (#326)

* chore(internal): codegen related update (#327)

* fix(api): correct some Responses types (#328)

* chore(internal): add back release workflow

* docs: show function calling conversation (#227)

* fix(client): support kotlin 1.8 runtime (#330)

* chore(internal): refactor enum query param serialization (#331)

* fix(types): improve responses type names (#332)

* docs: responses conversation example

* release: 0.35.1

---------

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

Author: 3 people

.github/workflows/create-releases.yml

@@ -0,0 +1,50 @@
+name: Create releases
+on:
+  schedule:
+    - cron: '0 5 * * *' # every day at 5am UTC
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: release
+    if: github.ref == 'refs/heads/main' && github.repository == 'openai/openai-java'
+    runs-on: ubuntu-latest
+    environment: publish
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: stainless-api/trigger-release-please@v1
+        id: release
+        with:
+          repo: ${{ github.event.repository.full_name }}
+          stainless-api-key: ${{ secrets.STAINLESS_API_KEY }}
+
+      - name: Set up Java
+        if: ${{ steps.release.outputs.releases_created }}
+        uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: |
+            8
+            17
+          cache: gradle
+
+      - name: Set up Gradle
+        if: ${{ steps.release.outputs.releases_created }}
+        uses: gradle/gradle-build-action@v2
+
+      - name: Publish to Sonatype
+        if: ${{ steps.release.outputs.releases_created }}
+        run: |-
+          export -- GPG_SIGNING_KEY_ID
+          printenv -- GPG_SIGNING_KEY | gpg --batch --passphrase-fd 3 --import 3<<< "$GPG_SIGNING_PASSWORD"
+          GPG_SIGNING_KEY_ID="$(gpg --with-colons --list-keys | awk -F : -- '/^pub:/ { getline; print "0x" substr($10, length($10) - 7) }')"
+          ./gradlew publishAndReleaseToMavenCentral --stacktrace -PmavenCentralUsername="$SONATYPE_USERNAME" -PmavenCentralPassword="$SONATYPE_PASSWORD"
+        env:
+          SONATYPE_USERNAME: ${{ secrets.OPENAI_SONATYPE_USERNAME || secrets.SONATYPE_USERNAME }}
+          SONATYPE_PASSWORD: ${{ secrets.OPENAI_SONATYPE_PASSWORD || secrets.SONATYPE_PASSWORD }}
+          GPG_SIGNING_KEY: ${{ secrets.OPENAI_SONATYPE_GPG_SIGNING_KEY || secrets.GPG_SIGNING_KEY }}
+          GPG_SIGNING_PASSWORD: ${{ secrets.OPENAI_SONATYPE_GPG_SIGNING_PASSWORD || secrets.GPG_SIGNING_PASSWORD }}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.35.0"
+  ".": "0.35.1"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 78
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-c8579861bc21d4d2155a5b9e8e7d54faee8083730673c4d32cbbe573d7fb4116.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-f3bce04386c4fcfd5037e0477fbaa39010003fd1558eb5185fe4a71dd6a05fdd.yml

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.35.1 (2025-03-18)
+
+Full Changelog: [v0.35.0...v0.35.1](https://github.com/openai/openai-java/compare/v0.35.0...v0.35.1)
+
+### Bug Fixes
+
+* **api:** correct some Responses types ([#328](https://github.com/openai/openai-java/issues/328)) ([efc79c0](https://github.com/openai/openai-java/commit/efc79c002003f3beaf74c2c3d13aada6235481e2))
+* **client:** support kotlin 1.8 runtime ([#330](https://github.com/openai/openai-java/issues/330)) ([5179a4e](https://github.com/openai/openai-java/commit/5179a4e4ea67797477cfdb9141e6d39eab9abd6a))
+* **types:** improve responses type names ([#332](https://github.com/openai/openai-java/issues/332)) ([517c500](https://github.com/openai/openai-java/commit/517c500d74e7d8c0f340b2607a574d8096390877))
+
+
+### Chores
+
+* **internal:** add back release workflow ([7893465](https://github.com/openai/openai-java/commit/7893465dbd929e290a2e46dfc877c3ef8a889056))
+* **internal:** codegen related update ([#327](https://github.com/openai/openai-java/issues/327)) ([7030355](https://github.com/openai/openai-java/commit/7030355dc8e511647e7a6221143ca94426ac24bf))
+* **internal:** refactor enum query param serialization ([#331](https://github.com/openai/openai-java/issues/331)) ([c5ef44d](https://github.com/openai/openai-java/commit/c5ef44dbf1c894f63bf213db391d09f5a800f825))
+
+
+### Documentation
+
+* responses conversation example ([fde5110](https://github.com/openai/openai-java/commit/fde5110a014a73e6e5e98fdb49e82506f04c4463))
+* show function calling conversation ([#227](https://github.com/openai/openai-java/issues/227)) ([ff7905a](https://github.com/openai/openai-java/commit/ff7905a22b217b370452e7a978b9153ae7487ebd))
+
 ## 0.35.0 (2025-03-18)
 
 Full Changelog: [v0.34.1...v0.35.0](https://github.com/openai/openai-java/compare/v0.34.1...v0.35.0)

README.md

@@ -9,14 +9,14 @@
 
 <!-- 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.35.0)
-[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.35.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.35.0)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.35.1)
+[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.35.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.35.1)
 
 <!-- x-release-please-end -->
 
 The OpenAI Java SDK provides convenient access to the OpenAI REST API from applications written in Java.
 
-The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/0.34.1).
+The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/0.35.0).
 
 ## Installation
 
@@ -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.35.0")
+implementation("com.openai:openai-java:0.35.1")
 ```
 
 ### Maven
@@ -34,7 +34,7 @@ implementation("com.openai:openai-java:0.35.0")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.35.0</version>
+    <version>0.35.1</version>
 </dependency>
 ```
 

build.gradle.kts

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

buildSrc/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
     `kotlin-dsl`
-    kotlin("jvm") version "2.1.10"
+    kotlin("jvm") version "1.9.20"
     id("com.vanniktech.maven.publish") version "0.28.0"
 }
 
@@ -11,6 +11,6 @@ repositories {
 
 dependencies {
     implementation("com.diffplug.spotless:spotless-plugin-gradle:7.0.2")
-    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:2.1.10")
+    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.20")
     implementation("com.vanniktech:gradle-maven-publish-plugin:0.28.0")
 }

buildSrc/src/main/kotlin/openai.java.gradle.kts

@@ -23,6 +23,9 @@ java {
     toolchain {
         languageVersion.set(JavaLanguageVersion.of(17))
     }
+
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
 }
 
 tasks.withType<JavaCompile>().configureEach {

buildSrc/src/main/kotlin/openai.kotlin.gradle.kts

@@ -1,6 +1,6 @@
 import com.diffplug.gradle.spotless.SpotlessExtension
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
 
 plugins {
     id("openai.java")
@@ -11,25 +11,26 @@ kotlin {
     jvmToolchain {
         languageVersion.set(JavaLanguageVersion.of(17))
     }
-}
-
-configure<SpotlessExtension> {
-    kotlin {
-        ktfmt().kotlinlangStyle()
-        toggleOffOn()
-    }
-}
 
-tasks.withType<KotlinCompile>().configureEach {
     compilerOptions {
-        allWarningsAsErrors = true
         freeCompilerArgs = listOf(
             "-Xjvm-default=all",
             "-Xjdk-release=1.8",
             // Suppress deprecation warnings because we may still reference and test deprecated members.
-            "-Xsuppress-warning=DEPRECATION"
+            // TODO: Replace with `-Xsuppress-warning=DEPRECATION` once we use Kotlin compiler 2.1.0+.
+            "-nowarn",
         )
         jvmTarget.set(JvmTarget.JVM_1_8)
+        languageVersion.set(KotlinVersion.KOTLIN_1_8)
+        apiVersion.set(KotlinVersion.KOTLIN_1_8)
+        coreLibrariesVersion = "1.8.0"
+    }
+}
+
+configure<SpotlessExtension> {
+    kotlin {
+        ktfmt().kotlinlangStyle()
+        toggleOffOn()
     }
 }
 

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

@@ -12,7 +12,6 @@ import com.openai.core.JsonField
 import com.openai.core.JsonMissing
 import com.openai.core.JsonValue
 import com.openai.core.NoAutoDetect
-import com.openai.core.checkRequired
 import com.openai.core.immutableEmptyMap
 import com.openai.core.toImmutable
 import com.openai.errors.OpenAIInvalidDataException
@@ -52,7 +51,7 @@ private constructor(
     fun effort(): Optional<ReasoningEffort> = Optional.ofNullable(effort.getNullable("effort"))
 
     /**
-     * **o-series models only**
+     * **computer_use_preview only**
      *
      * A summary of the reasoning performed by the model. This can be useful for debugging and
      * understanding the model's reasoning process. One of `concise` or `detailed`.
@@ -99,21 +98,14 @@ private constructor(
 
     companion object {
 
-        /**
-         * Returns a mutable builder for constructing an instance of [Reasoning].
-         *
-         * The following fields are required:
-         * ```java
-         * .effort()
-         * ```
-         */
+        /** Returns a mutable builder for constructing an instance of [Reasoning]. */
         @JvmStatic fun builder() = Builder()
     }
 
     /** A builder for [Reasoning]. */
     class Builder internal constructor() {
 
-        private var effort: JsonField<ReasoningEffort>? = null
+        private var effort: JsonField<ReasoningEffort> = JsonMissing.of()
         private var generateSummary: JsonField<GenerateSummary> = JsonMissing.of()
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
@@ -147,7 +139,7 @@ private constructor(
         fun effort(effort: JsonField<ReasoningEffort>) = apply { this.effort = effort }
 
         /**
-         * **o-series models only**
+         * **computer_use_preview only**
          *
          * A summary of the reasoning performed by the model. This can be useful for debugging and
          * understanding the model's reasoning process. One of `concise` or `detailed`.
@@ -193,24 +185,13 @@ private constructor(
          * Returns an immutable instance of [Reasoning].
          *
          * Further updates to this [Builder] will not mutate the returned instance.
-         *
-         * The following fields are required:
-         * ```java
-         * .effort()
-         * ```
-         *
-         * @throws IllegalStateException if any required field is unset.
          */
         fun build(): Reasoning =
-            Reasoning(
-                checkRequired("effort", effort),
-                generateSummary,
-                additionalProperties.toImmutable(),
-            )
+            Reasoning(effort, generateSummary, additionalProperties.toImmutable())
     }
 
     /**
-     * **o-series models only**
+     * **computer_use_preview only**
      *
      * A summary of the reasoning performed by the model. This can be useful for debugging and
      * understanding the model's reasoning process. One of `concise` or `detailed`.