release: 0.29.0 (#250)

stainless-app[bot] · TomerAberbach · web-flow · commit 88c81498913f · 2025-02-25T21:16:16.000-05:00
* feat(client): allow omitting params object when none required (#249) * chore(internal): remove unused variable (#251) * fix(client): add missing `@JvmStatic` (#252) * docs: switch to `.list()` without arguments in examples * release: 0.29.0 --------- Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com> Co-authored-by: Tomer Aberbach <tomer@stainless.com>
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,3 +1,3 @@
 {
-  ".": "0.28.0"
+  ".": "0.29.0"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.29.0 (2025-02-26)
+
+Full Changelog: [v0.28.0...v0.29.0](https://github.com/openai/openai-java/compare/v0.28.0...v0.29.0)
+
+### Features
+
+* **client:** allow omitting params object when none required ([#249](https://github.com/openai/openai-java/issues/249)) ([e77a6c3](https://github.com/openai/openai-java/commit/e77a6c35a1940bd6f1ef37f08a524974b28f17ac))
+
+
+### Bug Fixes
+
+* **client:** add missing `@JvmStatic` ([#252](https://github.com/openai/openai-java/issues/252)) ([06231c2](https://github.com/openai/openai-java/commit/06231c26727f09fd2065f2ebe9670b8149fcee84))
+
+
+### Chores
+
+* **internal:** remove unused variable ([#251](https://github.com/openai/openai-java/issues/251)) ([b41bc4e](https://github.com/openai/openai-java/commit/b41bc4ebbe38a216e1276e0b15fd3fe54fe37353))
+
+
+### Documentation
+
+* switch to `.list()` without arguments in examples ([d1480f1](https://github.com/openai/openai-java/commit/d1480f1c85c0e2704c2095298525401b76cec2e5))
+
 ## 0.28.0 (2025-02-24)
 
 Full Changelog: [v0.27.0...v0.28.0](https://github.com/openai/openai-java/compare/v0.27.0...v0.28.0)
diff --git a/README.md b/README.md
@@ -9,8 +9,8 @@
 
 <!-- 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.28.0)
-[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.28.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.28.0)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.29.0)
+[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.29.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.29.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.28.0")
+implementation("com.openai:openai-java:0.29.0")
 ```
 
 ### Maven
@@ -34,7 +34,7 @@ implementation("com.openai:openai-java:0.28.0")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.28.0</version>
+    <version>0.29.0</version>
 </dependency>
 ```
 
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "com.openai"
-    version = "0.28.0" // x-release-please-version
+    version = "0.29.0" // x-release-please-version
 }
 
 subprojects {
diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt
@@ -49,6 +49,8 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): BatchListParams = builder().build()
+
         @JvmStatic fun builder() = Builder()
     }
 
diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaAssistantListParams.kt
@@ -70,6 +70,8 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): BetaAssistantListParams = builder().build()
+
         @JvmStatic fun builder() = Builder()
     }
 
diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaThreadCreateParams.kt
@@ -353,6 +353,8 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): BetaThreadCreateParams = builder().build()
+
         @JvmStatic fun builder() = Builder()
     }
 
diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BetaVectorStoreListParams.kt
@@ -70,6 +70,8 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): BetaVectorStoreListParams = builder().build()
+
         @JvmStatic fun builder() = Builder()
     }
 
diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FileListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FileListParams.kt
@@ -66,6 +66,8 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): FileListParams = builder().build()
+
         @JvmStatic fun builder() = Builder()
     }
 
diff --git a/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/FineTuningJobListParams.kt
@@ -42,6 +42,8 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): FineTuningJobListParams = builder().build()
+
         @JvmStatic fun builder() = Builder()
     }
 
diff --git a/openai-java-core/src/main/kotlin/com/openai/models/ModelListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/ModelListParams.kt
@@ -30,6 +30,8 @@ private constructor(
 
     companion object {
 
+        @JvmStatic fun none(): ModelListParams = builder().build()
+
         @JvmStatic fun builder() = Builder()
     }
 
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/BatchServiceAsync.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/BatchServiceAsync.kt
@@ -32,10 +32,14 @@ interface BatchServiceAsync {
     /** List your organization's batches. */
     @JvmOverloads
     fun list(
-        params: BatchListParams,
+        params: BatchListParams = BatchListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<BatchListPageAsync>
 
+    /** List your organization's batches. */
+    fun list(requestOptions: RequestOptions): CompletableFuture<BatchListPageAsync> =
+        list(BatchListParams.none(), requestOptions)
+
     /**
      * Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes,
      * before changing to `cancelled`, where it will have partial results (if any) available in the
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/BetaServiceAsyncImpl.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/BetaServiceAsyncImpl.kt
@@ -3,7 +3,6 @@
 package com.openai.services.async
 
 import com.openai.core.ClientOptions
-import com.openai.core.http.Headers
 import com.openai.services.async.beta.AssistantServiceAsync
 import com.openai.services.async.beta.AssistantServiceAsyncImpl
 import com.openai.services.async.beta.ThreadServiceAsync
@@ -14,11 +13,6 @@ import com.openai.services.async.beta.VectorStoreServiceAsyncImpl
 class BetaServiceAsyncImpl internal constructor(private val clientOptions: ClientOptions) :
     BetaServiceAsync {
 
-    companion object {
-
-        private val DEFAULT_HEADERS = Headers.builder().put("OpenAI-Beta", "assistants=v2").build()
-    }
-
     private val vectorStores: VectorStoreServiceAsync by lazy {
         VectorStoreServiceAsyncImpl(clientOptions)
     }
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/FileServiceAsync.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/FileServiceAsync.kt
@@ -28,10 +28,14 @@ interface FileServiceAsync {
     /** Returns a list of files. */
     @JvmOverloads
     fun list(
-        params: FileListParams,
+        params: FileListParams = FileListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<FileListPageAsync>
 
+    /** Returns a list of files. */
+    fun list(requestOptions: RequestOptions): CompletableFuture<FileListPageAsync> =
+        list(FileListParams.none(), requestOptions)
+
     /** Delete a file. */
     @JvmOverloads
     fun delete(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/ModelServiceAsync.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/ModelServiceAsync.kt
@@ -31,10 +31,17 @@ interface ModelServiceAsync {
      */
     @JvmOverloads
     fun list(
-        params: ModelListParams,
+        params: ModelListParams = ModelListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<ModelListPageAsync>
 
+    /**
+     * Lists the currently available models, and provides basic information about each one such as
+     * the owner and availability.
+     */
+    fun list(requestOptions: RequestOptions): CompletableFuture<ModelListPageAsync> =
+        list(ModelListParams.none(), requestOptions)
+
     /**
      * Delete a fine-tuned model. You must have the Owner role in your organization to delete a
      * model.
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/beta/AssistantServiceAsync.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/beta/AssistantServiceAsync.kt
@@ -41,10 +41,14 @@ interface AssistantServiceAsync {
     /** Returns a list of assistants. */
     @JvmOverloads
     fun list(
-        params: BetaAssistantListParams,
+        params: BetaAssistantListParams = BetaAssistantListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<BetaAssistantListPageAsync>
 
+    /** Returns a list of assistants. */
+    fun list(requestOptions: RequestOptions): CompletableFuture<BetaAssistantListPageAsync> =
+        list(BetaAssistantListParams.none(), requestOptions)
+
     /** Delete an assistant. */
     @JvmOverloads
     fun delete(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/beta/ThreadServiceAsync.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/beta/ThreadServiceAsync.kt
@@ -28,10 +28,14 @@ interface ThreadServiceAsync {
     /** Create a thread. */
     @JvmOverloads
     fun create(
-        params: BetaThreadCreateParams,
+        params: BetaThreadCreateParams = BetaThreadCreateParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<Thread>
 
+    /** Create a thread. */
+    fun create(requestOptions: RequestOptions): CompletableFuture<Thread> =
+        create(BetaThreadCreateParams.none(), requestOptions)
+
     /** Retrieves a thread. */
     @JvmOverloads
     fun retrieve(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/beta/VectorStoreServiceAsync.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/beta/VectorStoreServiceAsync.kt
@@ -47,10 +47,14 @@ interface VectorStoreServiceAsync {
     /** Returns a list of vector stores. */
     @JvmOverloads
     fun list(
-        params: BetaVectorStoreListParams,
+        params: BetaVectorStoreListParams = BetaVectorStoreListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<BetaVectorStoreListPageAsync>
 
+    /** Returns a list of vector stores. */
+    fun list(requestOptions: RequestOptions): CompletableFuture<BetaVectorStoreListPageAsync> =
+        list(BetaVectorStoreListParams.none(), requestOptions)
+
     /** Delete a vector store. */
     @JvmOverloads
     fun delete(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/async/fineTuning/JobServiceAsync.kt b/openai-java-core/src/main/kotlin/com/openai/services/async/fineTuning/JobServiceAsync.kt
@@ -49,10 +49,14 @@ interface JobServiceAsync {
     /** List your organization's fine-tuning jobs */
     @JvmOverloads
     fun list(
-        params: FineTuningJobListParams,
+        params: FineTuningJobListParams = FineTuningJobListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): CompletableFuture<FineTuningJobListPageAsync>
 
+    /** List your organization's fine-tuning jobs */
+    fun list(requestOptions: RequestOptions): CompletableFuture<FineTuningJobListPageAsync> =
+        list(FineTuningJobListParams.none(), requestOptions)
+
     /** Immediately cancel a fine-tune job. */
     @JvmOverloads
     fun cancel(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/BatchService.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/BatchService.kt
@@ -31,10 +31,14 @@ interface BatchService {
     /** List your organization's batches. */
     @JvmOverloads
     fun list(
-        params: BatchListParams,
+        params: BatchListParams = BatchListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): BatchListPage
 
+    /** List your organization's batches. */
+    fun list(requestOptions: RequestOptions): BatchListPage =
+        list(BatchListParams.none(), requestOptions)
+
     /**
      * Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes,
      * before changing to `cancelled`, where it will have partial results (if any) available in the
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/BetaServiceImpl.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/BetaServiceImpl.kt
@@ -3,7 +3,6 @@
 package com.openai.services.blocking
 
 import com.openai.core.ClientOptions
-import com.openai.core.http.Headers
 import com.openai.services.blocking.beta.AssistantService
 import com.openai.services.blocking.beta.AssistantServiceImpl
 import com.openai.services.blocking.beta.ThreadService
@@ -13,11 +12,6 @@ import com.openai.services.blocking.beta.VectorStoreServiceImpl
 
 class BetaServiceImpl internal constructor(private val clientOptions: ClientOptions) : BetaService {
 
-    companion object {
-
-        private val DEFAULT_HEADERS = Headers.builder().put("OpenAI-Beta", "assistants=v2").build()
-    }
-
     private val vectorStores: VectorStoreService by lazy { VectorStoreServiceImpl(clientOptions) }
 
     private val assistants: AssistantService by lazy { AssistantServiceImpl(clientOptions) }
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/FileService.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/FileService.kt
@@ -27,10 +27,14 @@ interface FileService {
     /** Returns a list of files. */
     @JvmOverloads
     fun list(
-        params: FileListParams,
+        params: FileListParams = FileListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): FileListPage
 
+    /** Returns a list of files. */
+    fun list(requestOptions: RequestOptions): FileListPage =
+        list(FileListParams.none(), requestOptions)
+
     /** Delete a file. */
     @JvmOverloads
     fun delete(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/ModelService.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/ModelService.kt
@@ -30,10 +30,17 @@ interface ModelService {
      */
     @JvmOverloads
     fun list(
-        params: ModelListParams,
+        params: ModelListParams = ModelListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): ModelListPage
 
+    /**
+     * Lists the currently available models, and provides basic information about each one such as
+     * the owner and availability.
+     */
+    fun list(requestOptions: RequestOptions): ModelListPage =
+        list(ModelListParams.none(), requestOptions)
+
     /**
      * Delete a fine-tuned model. You must have the Owner role in your organization to delete a
      * model.
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/AssistantService.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/AssistantService.kt
@@ -40,10 +40,14 @@ interface AssistantService {
     /** Returns a list of assistants. */
     @JvmOverloads
     fun list(
-        params: BetaAssistantListParams,
+        params: BetaAssistantListParams = BetaAssistantListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): BetaAssistantListPage
 
+    /** Returns a list of assistants. */
+    fun list(requestOptions: RequestOptions): BetaAssistantListPage =
+        list(BetaAssistantListParams.none(), requestOptions)
+
     /** Delete an assistant. */
     @JvmOverloads
     fun delete(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/ThreadService.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/ThreadService.kt
@@ -28,10 +28,14 @@ interface ThreadService {
     /** Create a thread. */
     @JvmOverloads
     fun create(
-        params: BetaThreadCreateParams,
+        params: BetaThreadCreateParams = BetaThreadCreateParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): Thread
 
+    /** Create a thread. */
+    fun create(requestOptions: RequestOptions): Thread =
+        create(BetaThreadCreateParams.none(), requestOptions)
+
     /** Retrieves a thread. */
     @JvmOverloads
     fun retrieve(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/VectorStoreService.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/VectorStoreService.kt
@@ -46,10 +46,14 @@ interface VectorStoreService {
     /** Returns a list of vector stores. */
     @JvmOverloads
     fun list(
-        params: BetaVectorStoreListParams,
+        params: BetaVectorStoreListParams = BetaVectorStoreListParams.none(),
         requestOptions: RequestOptions = RequestOptions.none(),
     ): BetaVectorStoreListPage
 
+    /** Returns a list of vector stores. */
+    fun list(requestOptions: RequestOptions): BetaVectorStoreListPage =
+        list(BetaVectorStoreListParams.none(), requestOptions)
+
     /** Delete a vector store. */
     @JvmOverloads
     fun delete(
diff --git a/openai-java-core/src/main/kotlin/com/openai/services/blocking/fineTuning/JobService.kt b/openai-java-core/src/main/kotlin/com/openai/services/blocking/fineTuning/JobService.kt
diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/BatchServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/BatchServiceTest.kt
diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/FileServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/FileServiceTest.kt
diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/ModelServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/ModelServiceTest.kt
diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/beta/AssistantServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/beta/AssistantServiceTest.kt
diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/beta/VectorStoreServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/beta/VectorStoreServiceTest.kt
diff --git a/openai-java-core/src/test/kotlin/com/openai/services/blocking/fineTuning/JobServiceTest.kt b/openai-java-core/src/test/kotlin/com/openai/services/blocking/fineTuning/JobServiceTest.kt
diff --git a/openai-java-example/src/main/java/com/openai/example/ModelListAsyncExample.java b/openai-java-example/src/main/java/com/openai/example/ModelListAsyncExample.java
diff --git a/openai-java-example/src/main/java/com/openai/example/ModelListExample.java b/openai-java-example/src/main/java/com/openai/example/ModelListExample.java

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- ".": "0.28.0"`
	`2`	`+ ".": "0.29.0"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ repositories {`
`8`	`8`
`9`	`9`	`allprojects {`
`10`	`10`	`group = "com.openai"`
`11`		`- version = "0.28.0" // x-release-please-version`
	`11`	`+ version = "0.29.0" // x-release-please-version`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`subprojects {`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@ private constructor(`
`49`	`49`
`50`	`50`	`companion object {`
`51`	`51`
	`52`	`+ @JvmStatic fun none(): BatchListParams = builder().build()`
	`53`	`+`
`52`	`54`	`@JvmStatic fun builder() = Builder()`
`53`	`55`	`}`
`54`	`56`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,8 @@ private constructor(`
`70`	`70`
`71`	`71`	`companion object {`
`72`	`72`
	`73`	`+ @JvmStatic fun none(): BetaAssistantListParams = builder().build()`
	`74`	`+`
`73`	`75`	`@JvmStatic fun builder() = Builder()`
`74`	`76`	`}`
`75`	`77`
Original file line number	Diff line number	Diff line change
`@@ -353,6 +353,8 @@ private constructor(`
`353`	`353`
`354`	`354`	`companion object {`
`355`	`355`
	`356`	`+ @JvmStatic fun none(): BetaThreadCreateParams = builder().build()`
	`357`	`+`
`356`	`358`	`@JvmStatic fun builder() = Builder()`
`357`	`359`	`}`
`358`	`360`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,8 @@ private constructor(`
`66`	`66`
`67`	`67`	`companion object {`
`68`	`68`
	`69`	`+ @JvmStatic fun none(): FileListParams = builder().build()`
	`70`	`+`
`69`	`71`	`@JvmStatic fun builder() = Builder()`
`70`	`72`	`}`
`71`	`73`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,8 @@ private constructor(`
`42`	`42`
`43`	`43`	`companion object {`
`44`	`44`
	`45`	`+ @JvmStatic fun none(): FineTuningJobListParams = builder().build()`
	`46`	`+`
`45`	`47`	`@JvmStatic fun builder() = Builder()`
`46`	`48`	`}`
`47`	`49`