release: 0.9.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.8.1"
+  ".": "0.9.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 24
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-a39aca84ed97ebafb707ebd5221e2787c5a42ff3d98f2ffaea8a0dcd84cbcbcb.yml
+configured_endpoints: 60
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-02200a58ed631064b6419711da99fefd6e97bdbbeb577a80a1a6e0c8dbcb18f5.yml

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.9.0 (2025-01-03)
+
+Full Changelog: [v0.8.1...v0.9.0](https://github.com/openai/openai-java/compare/v0.8.1...v0.9.0)
+
+### ⚠ BREAKING CHANGES
+
+* **client:** switch query params objects to use `QueryParams` ([#64](https://github.com/openai/openai-java/issues/64))
+
+### Features
+
+* **client:** add beta endpoints ([#79](https://github.com/openai/openai-java/issues/79)) ([8584a20](https://github.com/openai/openai-java/commit/8584a2029ec5402b205ce485e96702da0a692b76))
+* **client:** put body field in params, add more convenience methods, and add missing docs ([#77](https://github.com/openai/openai-java/issues/77)) ([0c74350](https://github.com/openai/openai-java/commit/0c74350f0e5d1f0a30ae9b27c50a306ca081b1a7))
+
+
+### Chores
+
+* bump license year ([#74](https://github.com/openai/openai-java/issues/74)) ([769175d](https://github.com/openai/openai-java/commit/769175d3c42b6679e8ea91847e1fba32ab76d9a6))
+
+
+### Documentation
+
+* add some missing javadocs ([#78](https://github.com/openai/openai-java/issues/78)) ([d153ef9](https://github.com/openai/openai-java/commit/d153ef99dff3a201bf5674ee4154f3a3d276f608))
+
+
+### Refactors
+
+* **client:** switch query params objects to use `QueryParams` ([#64](https://github.com/openai/openai-java/issues/64)) ([4e9c3eb](https://github.com/openai/openai-java/commit/4e9c3eb9351f308ed3d842bd4aa2d860c23d568e))
+* **internal:** use constructor to deserialize json ([#66](https://github.com/openai/openai-java/issues/66)) ([27389cd](https://github.com/openai/openai-java/commit/27389cd377ce9a109a4aa25f78f70c36ca62de14))
+
 ## 0.8.1 (2024-12-21)
 
 Full Changelog: [v0.8.0...v0.8.1](https://github.com/openai/openai-java/compare/v0.8.0...v0.8.1)

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 OpenAI
+   Copyright 2025 OpenAI
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

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.8.1)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.9.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.8.1")
+implementation("com.openai:openai-java:0.9.0")
 ```
 
 #### Maven
@@ -41,7 +41,7 @@ implementation("com.openai:openai-java:0.8.1")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.8.1</version>
+    <version>0.9.0</version>
 </dependency>
 ```
 

build.gradle.kts

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

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

@@ -138,9 +138,9 @@ 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 project(project: String) = apply { clientOptions.project(project) }
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 

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

@@ -138,9 +138,9 @@ 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 project(project: String) = apply { clientOptions.project(project) }
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 

openai-java-core/src/main/kotlin/com/openai/client/OpenAIClient.kt

@@ -3,6 +3,7 @@
 package com.openai.client
 
 import com.openai.services.blocking.BatchService
+import com.openai.services.blocking.BetaService
 import com.openai.services.blocking.ChatService
 import com.openai.services.blocking.CompletionService
 import com.openai.services.blocking.EmbeddingService
@@ -33,6 +34,8 @@ interface OpenAIClient {
 
     fun fineTuning(): FineTuningService
 
+    fun beta(): BetaService
+
     fun batches(): BatchService
 
     fun uploads(): UploadService

openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientAsync.kt

@@ -3,6 +3,7 @@
 package com.openai.client
 
 import com.openai.services.async.BatchServiceAsync
+import com.openai.services.async.BetaServiceAsync
 import com.openai.services.async.ChatServiceAsync
 import com.openai.services.async.CompletionServiceAsync
 import com.openai.services.async.EmbeddingServiceAsync
@@ -33,6 +34,8 @@ interface OpenAIClientAsync {
 
     fun fineTuning(): FineTuningServiceAsync
 
+    fun beta(): BetaServiceAsync
+
     fun batches(): BatchServiceAsync
 
     fun uploads(): UploadServiceAsync

openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientAsyncImpl.kt

@@ -6,6 +6,8 @@ import com.openai.core.ClientOptions
 import com.openai.core.getPackageVersion
 import com.openai.services.async.BatchServiceAsync
 import com.openai.services.async.BatchServiceAsyncImpl
+import com.openai.services.async.BetaServiceAsync
+import com.openai.services.async.BetaServiceAsyncImpl
 import com.openai.services.async.ChatServiceAsync
 import com.openai.services.async.ChatServiceAsyncImpl
 import com.openai.services.async.CompletionServiceAsync
@@ -69,6 +71,8 @@ constructor(
         FineTuningServiceAsyncImpl(clientOptionsWithUserAgent)
     }
 
+    private val beta: BetaServiceAsync by lazy { BetaServiceAsyncImpl(clientOptionsWithUserAgent) }
+
     private val batches: BatchServiceAsync by lazy {
         BatchServiceAsyncImpl(clientOptionsWithUserAgent)
     }
@@ -95,6 +99,8 @@ constructor(
 
     override fun fineTuning(): FineTuningServiceAsync = fineTuning
 
+    override fun beta(): BetaServiceAsync = beta
+
     override fun batches(): BatchServiceAsync = batches
 
     override fun uploads(): UploadServiceAsync = uploads

openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientImpl.kt

@@ -6,6 +6,8 @@ import com.openai.core.ClientOptions
 import com.openai.core.getPackageVersion
 import com.openai.services.blocking.BatchService
 import com.openai.services.blocking.BatchServiceImpl
+import com.openai.services.blocking.BetaService
+import com.openai.services.blocking.BetaServiceImpl
 import com.openai.services.blocking.ChatService
 import com.openai.services.blocking.ChatServiceImpl
 import com.openai.services.blocking.CompletionService
@@ -65,6 +67,8 @@ constructor(
         FineTuningServiceImpl(clientOptionsWithUserAgent)
     }
 
+    private val beta: BetaService by lazy { BetaServiceImpl(clientOptionsWithUserAgent) }
+
     private val batches: BatchService by lazy { BatchServiceImpl(clientOptionsWithUserAgent) }
 
     private val uploads: UploadService by lazy { UploadServiceImpl(clientOptionsWithUserAgent) }
@@ -87,6 +91,8 @@ constructor(
 
     override fun fineTuning(): FineTuningService = fineTuning
 
+    override fun beta(): BetaService = beta
+
     override fun batches(): BatchService = batches
 
     override fun uploads(): UploadService = uploads

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

@@ -187,9 +187,9 @@ private constructor(
             this.azureServiceVersion = azureServiceVersion
         }
 
-        fun organization(organization: String?) = apply { this.organization = organization }
+        fun organization(organization: String) = apply { this.organization = organization }
 
-        fun project(project: String?) = apply { this.project = project }
+        fun project(project: String) = apply { this.project = project }
 
         fun fromEnv() = apply {
             val openAIKey = System.getenv("OPENAI_API_KEY")

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

@@ -16,7 +16,9 @@ internal fun <T> List<T>.toImmutable(): List<T> =
 
 @JvmSynthetic
 internal fun <K, V> Map<K, V>.toImmutable(): Map<K, V> =
-    if (isEmpty()) Collections.emptyMap() else Collections.unmodifiableMap(toMap())
+    if (isEmpty()) immutableEmptyMap() else Collections.unmodifiableMap(toMap())
+
+@JvmSynthetic internal fun <K, V> immutableEmptyMap(): Map<K, V> = Collections.emptyMap()
 
 @JvmSynthetic
 internal fun <K : Comparable<K>, V> SortedMap<K, V>.toImmutable(): SortedMap<K, V> =

openai-java-core/src/main/kotlin/com/openai/errors/OpenAIError.kt

@@ -4,19 +4,23 @@ package com.openai.errors
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter
 import com.fasterxml.jackson.annotation.JsonAnySetter
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize
+import com.fasterxml.jackson.annotation.JsonCreator
+import com.openai.core.ExcludeMissing
 import com.openai.core.JsonValue
 import com.openai.core.NoAutoDetect
+import com.openai.core.immutableEmptyMap
 import com.openai.core.toImmutable
 import java.util.Objects
 
-@JsonDeserialize(builder = OpenAIError.Builder::class)
 @NoAutoDetect
 class OpenAIError
+@JsonCreator
 private constructor(
     @JsonAnyGetter
+    @ExcludeMissing
+    @JsonAnySetter
     @get:JvmName("additionalProperties")
-    val additionalProperties: Map<String, JsonValue>,
+    val additionalProperties: Map<String, JsonValue> = immutableEmptyMap(),
 ) {
 
     fun toBuilder() = Builder().from(this)
@@ -40,7 +44,6 @@ private constructor(
             putAllAdditionalProperties(additionalProperties)
         }
 
-        @JsonAnySetter
         fun putAdditionalProperty(key: String, value: JsonValue) = apply {
             additionalProperties.put(key, value)
         }