release: 0.11.6

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.11.5"
+  ".": "0.11.6"
 }

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.11.6 (2025-01-17)
+
+Full Changelog: [v0.11.5...v0.11.6](https://github.com/openai/openai-java/compare/v0.11.5...v0.11.6)
+
+### Chores
+
+* **internal:** move `StreamResponse` method ([#131](https://github.com/openai/openai-java/issues/131)) ([5888e39](https://github.com/openai/openai-java/commit/5888e398597b68a520b4bb3953d96403023331fd))
+* **internal:** refactor streaming implementation ([#129](https://github.com/openai/openai-java/issues/129)) ([d2831ec](https://github.com/openai/openai-java/commit/d2831ec587d37a2c2d51332f5f2f62ba3dd1181d))
+
 ## 0.11.5 (2025-01-16)
 
 Full Changelog: [v0.11.4...v0.11.5](https://github.com/openai/openai-java/compare/v0.11.4...v0.11.5)

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.11.5)
+[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.11.6)
 
 <!-- x-release-please-end -->
 
@@ -30,7 +30,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.11.5")
+implementation("com.openai:openai-java:0.11.6")
 ```
 
 #### Maven
@@ -39,7 +39,7 @@ implementation("com.openai:openai-java:0.11.5")
 <dependency>
     <groupId>com.openai</groupId>
     <artifactId>openai-java</artifactId>
-    <version>0.11.5</version>
+    <version>0.11.6</version>
 </dependency>
 ```
 

build.gradle.kts

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

openai-java-core/src/main/kotlin/com/openai/core/handlers/SseHandler.kt

@@ -6,69 +6,40 @@ import com.fasterxml.jackson.databind.json.JsonMapper
 import com.openai.core.JsonValue
 import com.openai.core.http.HttpResponse
 import com.openai.core.http.HttpResponse.Handler
-import com.openai.core.http.PhantomReachableClosingStreamResponse
 import com.openai.core.http.SseMessage
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.errors.OpenAIException
-import java.util.stream.Stream
 import kotlin.jvm.optionals.getOrNull
-import kotlin.streams.asStream
 
 @JvmSynthetic
 internal fun sseHandler(jsonMapper: JsonMapper): Handler<StreamResponse<SseMessage>> =
-    object : Handler<StreamResponse<SseMessage>> {
-
-        override fun handle(response: HttpResponse): StreamResponse<SseMessage> {
-            val reader = response.body().bufferedReader()
-            val sequence =
-                sequence {
-                        reader.useLines { lines ->
-                            val state = SseState(jsonMapper)
-                            var done = false
-                            for (line in lines) {
-                                // Stop emitting messages, but iterate through the full stream.
-                                if (done) {
-                                    continue
-                                }
-                                val message = state.decode(line) ?: continue
-
-                                if (message.data.startsWith("[DONE]")) {
-                                    // In this case we don't break because we still want to iterate
-                                    // through the full stream.
-                                    done = true
-                                    continue
-                                }
-
-                                val error =
-                                    message.json<JsonValue>().asObject().getOrNull()?.get("error")
-                                if (error != null) {
-                                    val errorMessage =
-                                        error.asString().getOrNull()
-                                            ?: error
-                                                .asObject()
-                                                .getOrNull()
-                                                ?.get("message")
-                                                ?.asString()
-                                                ?.getOrNull()
-                                            ?: "An error occurred during streaming"
-                                    throw OpenAIException(errorMessage)
-                                }
-                                yield(message)
-                            }
-                        }
-                    }
-                    .constrainOnce()
-
-            return PhantomReachableClosingStreamResponse(
-                object : StreamResponse<SseMessage> {
-                    override fun stream(): Stream<SseMessage> = sequence.asStream()
-
-                    override fun close() {
-                        reader.close()
-                        response.close()
-                    }
-                }
-            )
+    streamHandler { lines ->
+        val state = SseState(jsonMapper)
+        var done = false
+        for (line in lines) {
+            // Stop emitting messages, but iterate through the full stream.
+            if (done) {
+                continue
+            }
+            val message = state.decode(line) ?: continue
+
+            if (message.data.startsWith("[DONE]")) {
+                // In this case we don't break because we still want to iterate through the full
+                // stream.
+                done = true
+                continue
+            }
+
+            val error = message.json<JsonValue>().asObject().getOrNull()?.get("error")
+            if (error != null) {
+                val errorMessage =
+                    error.asString().getOrNull()
+                        ?: error.asObject().getOrNull()?.get("message")?.asString()?.getOrNull()
+                        ?: "An error occurred during streaming"
+                throw OpenAIException(errorMessage)
+            }
+            yield(message)
         }
     }
 
@@ -158,11 +129,3 @@ internal inline fun <reified T> Handler<StreamResponse<SseMessage>>.mapJson():
                 }
             }
     }
-
-@JvmSynthetic
-internal fun <T, R> StreamResponse<T>.map(transform: (T) -> R): StreamResponse<R> =
-    object : StreamResponse<R> {
-        override fun stream(): Stream<R> = [email protected]().map(transform)
-
-        override fun close() = [email protected]()
-    }

openai-java-core/src/main/kotlin/com/openai/core/handlers/StreamHandler.kt

@@ -0,0 +1,32 @@
+@file:JvmName("StreamHandler")
+
+package com.openai.core.handlers
+
+import com.openai.core.http.HttpResponse
+import com.openai.core.http.HttpResponse.Handler
+import com.openai.core.http.PhantomReachableClosingStreamResponse
+import com.openai.core.http.StreamResponse
+import java.util.stream.Stream
+import kotlin.streams.asStream
+
+@JvmSynthetic
+internal fun <T> streamHandler(
+    block: suspend SequenceScope<T>.(lines: Sequence<String>) -> Unit
+): Handler<StreamResponse<T>> =
+    object : Handler<StreamResponse<T>> {
+        override fun handle(response: HttpResponse): StreamResponse<T> {
+            val reader = response.body().bufferedReader()
+            val sequence = sequence { reader.useLines { block(it) } }.constrainOnce()
+
+            return PhantomReachableClosingStreamResponse(
+                object : StreamResponse<T> {
+                    override fun stream(): Stream<T> = sequence.asStream()
+
+                    override fun close() {
+                        reader.close()
+                        response.close()
+                    }
+                }
+            )
+        }
+    }

openai-java-core/src/main/kotlin/com/openai/core/http/StreamResponse.kt

@@ -6,3 +6,11 @@ interface StreamResponse<T> : AutoCloseable {
 
     fun stream(): Stream<T>
 }
+
+@JvmSynthetic
+internal fun <T, R> StreamResponse<T>.map(transform: (T) -> R): StreamResponse<R> =
+    object : StreamResponse<R> {
+        override fun stream(): Stream<R> = [email protected]().map(transform)
+
+        override fun close() = [email protected]()
+    }

openai-java-core/src/main/kotlin/com/openai/services/async/CompletionServiceAsyncImpl.kt

@@ -9,7 +9,6 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
@@ -18,6 +17,7 @@ import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.http.toAsync
 import com.openai.core.json
 import com.openai.errors.OpenAIError

openai-java-core/src/main/kotlin/com/openai/services/async/beta/ThreadServiceAsyncImpl.kt

@@ -7,7 +7,6 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
@@ -16,6 +15,7 @@ import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.http.toAsync
 import com.openai.core.json
 import com.openai.errors.OpenAIError

openai-java-core/src/main/kotlin/com/openai/services/async/beta/threads/RunServiceAsyncImpl.kt

@@ -7,7 +7,6 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
@@ -16,6 +15,7 @@ import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.http.toAsync
 import com.openai.core.json
 import com.openai.errors.OpenAIError

openai-java-core/src/main/kotlin/com/openai/services/async/chat/CompletionServiceAsyncImpl.kt

@@ -9,7 +9,6 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
@@ -18,6 +17,7 @@ import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.http.toAsync
 import com.openai.core.json
 import com.openai.errors.OpenAIError

openai-java-core/src/main/kotlin/com/openai/services/blocking/CompletionServiceImpl.kt

@@ -9,14 +9,14 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
 import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.json
 import com.openai.errors.OpenAIError
 import com.openai.models.Completion

openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/ThreadServiceImpl.kt

@@ -7,14 +7,14 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
 import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.json
 import com.openai.errors.OpenAIError
 import com.openai.models.AssistantStreamEvent

openai-java-core/src/main/kotlin/com/openai/services/blocking/beta/threads/RunServiceImpl.kt

@@ -7,14 +7,14 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
 import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.json
 import com.openai.errors.OpenAIError
 import com.openai.models.AssistantStreamEvent

openai-java-core/src/main/kotlin/com/openai/services/blocking/chat/CompletionServiceImpl.kt

@@ -9,14 +9,14 @@ import com.openai.core.JsonValue
 import com.openai.core.RequestOptions
 import com.openai.core.handlers.errorHandler
 import com.openai.core.handlers.jsonHandler
-import com.openai.core.handlers.map
 import com.openai.core.handlers.mapJson
 import com.openai.core.handlers.sseHandler
 import com.openai.core.handlers.withErrorHandler
 import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse.Handler
 import com.openai.core.http.StreamResponse
+import com.openai.core.http.map
 import com.openai.core.json
 import com.openai.errors.OpenAIError
 import com.openai.models.ChatCompletion