fix(client): return binary content from get /containers/{container_id}/files/{file_id}/content

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 86
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d4bcffecf0cdadf746faa6708ed1ec81fac451f9b857deabbab26f0a343b9314.yml
 openapi_spec_hash: 7c54a18b4381248bda7cc34c52142615
-config_hash: 2102e4b25bbcab5d32d5ffa5d34daa0c
+config_hash: d23f847b9ebb3f427d0f198035bd3e9f

openai-java-core/src/main/kotlin/com/openai/services/async/containers/files/ContentServiceAsync.kt

@@ -16,26 +16,30 @@ interface ContentServiceAsync {
     fun withRawResponse(): WithRawResponse
 
     /** Retrieve Container File Content */
-    fun retrieve(fileId: String, params: ContentRetrieveParams): CompletableFuture<Void?> =
+    @MustBeClosed
+    fun retrieve(fileId: String, params: ContentRetrieveParams): CompletableFuture<HttpResponse> =
         retrieve(fileId, params, RequestOptions.none())
 
     /** @see [retrieve] */
+    @MustBeClosed
     fun retrieve(
         fileId: String,
         params: ContentRetrieveParams,
         requestOptions: RequestOptions = RequestOptions.none(),
-    ): CompletableFuture<Void?> =
+    ): CompletableFuture<HttpResponse> =
         retrieve(params.toBuilder().fileId(fileId).build(), requestOptions)
 
     /** @see [retrieve] */
-    fun retrieve(params: ContentRetrieveParams): CompletableFuture<Void?> =
+    @MustBeClosed
+    fun retrieve(params: ContentRetrieveParams): CompletableFuture<HttpResponse> =
         retrieve(params, RequestOptions.none())
 
     /** @see [retrieve] */
+    @MustBeClosed
     fun retrieve(
         params: ContentRetrieveParams,
         requestOptions: RequestOptions = RequestOptions.none(),
-    ): CompletableFuture<Void?>
+    ): CompletableFuture<HttpResponse>
 
     /**
      * A view of [ContentServiceAsync] that provides access to raw HTTP responses for each method.

openai-java-core/src/main/kotlin/com/openai/services/async/containers/files/ContentServiceAsyncImpl.kt

@@ -5,14 +5,11 @@ package com.openai.services.async.containers.files
 import com.openai.core.ClientOptions
 import com.openai.core.RequestOptions
 import com.openai.core.checkRequired
-import com.openai.core.handlers.emptyHandler
 import com.openai.core.handlers.errorHandler
-import com.openai.core.handlers.withErrorHandler
 import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse
 import com.openai.core.http.HttpResponse.Handler
-import com.openai.core.http.parseable
 import com.openai.core.prepareAsync
 import com.openai.models.ErrorObject
 import com.openai.models.containers.files.content.ContentRetrieveParams
@@ -31,17 +28,15 @@ class ContentServiceAsyncImpl internal constructor(private val clientOptions: Cl
     override fun retrieve(
         params: ContentRetrieveParams,
         requestOptions: RequestOptions,
-    ): CompletableFuture<Void?> =
+    ): CompletableFuture<HttpResponse> =
         // get /containers/{container_id}/files/{file_id}/content
-        withRawResponse().retrieve(params, requestOptions).thenAccept {}
+        withRawResponse().retrieve(params, requestOptions)
 
     class WithRawResponseImpl internal constructor(private val clientOptions: ClientOptions) :
         ContentServiceAsync.WithRawResponse {
 
         private val errorHandler: Handler<ErrorObject?> = errorHandler(clientOptions.jsonMapper)
 
-        private val retrieveHandler: Handler<Void?> = emptyHandler().withErrorHandler(errorHandler)
-
         override fun retrieve(
             params: ContentRetrieveParams,
             requestOptions: RequestOptions,
@@ -62,11 +57,9 @@ class ContentServiceAsyncImpl internal constructor(private val clientOptions: Cl
                     .build()
                     .prepareAsync(clientOptions, params, deploymentModel = null)
             val requestOptions = requestOptions.applyDefaults(RequestOptions.from(clientOptions))
-            return request
-                .thenComposeAsync { clientOptions.httpClient.executeAsync(it, requestOptions) }
-                .thenApply { response ->
-                    response.parseable { response.use { retrieveHandler.handle(it) } }
-                }
+            return request.thenComposeAsync {
+                clientOptions.httpClient.executeAsync(it, requestOptions)
+            }
         }
     }
 }

openai-java-core/src/main/kotlin/com/openai/services/blocking/containers/files/ContentService.kt

@@ -15,24 +15,29 @@ interface ContentService {
     fun withRawResponse(): WithRawResponse
 
     /** Retrieve Container File Content */
-    fun retrieve(fileId: String, params: ContentRetrieveParams) =
+    @MustBeClosed
+    fun retrieve(fileId: String, params: ContentRetrieveParams): HttpResponse =
         retrieve(fileId, params, RequestOptions.none())
 
     /** @see [retrieve] */
+    @MustBeClosed
     fun retrieve(
         fileId: String,
         params: ContentRetrieveParams,
         requestOptions: RequestOptions = RequestOptions.none(),
-    ) = retrieve(params.toBuilder().fileId(fileId).build(), requestOptions)
+    ): HttpResponse = retrieve(params.toBuilder().fileId(fileId).build(), requestOptions)
 
     /** @see [retrieve] */
-    fun retrieve(params: ContentRetrieveParams) = retrieve(params, RequestOptions.none())
+    @MustBeClosed
+    fun retrieve(params: ContentRetrieveParams): HttpResponse =
+        retrieve(params, RequestOptions.none())
 
     /** @see [retrieve] */
+    @MustBeClosed
     fun retrieve(
         params: ContentRetrieveParams,
         requestOptions: RequestOptions = RequestOptions.none(),
-    )
+    ): HttpResponse
 
     /** A view of [ContentService] that provides access to raw HTTP responses for each method. */
     interface WithRawResponse {

openai-java-core/src/main/kotlin/com/openai/services/blocking/containers/files/ContentServiceImpl.kt

@@ -5,14 +5,11 @@ package com.openai.services.blocking.containers.files
 import com.openai.core.ClientOptions
 import com.openai.core.RequestOptions
 import com.openai.core.checkRequired
-import com.openai.core.handlers.emptyHandler
 import com.openai.core.handlers.errorHandler
-import com.openai.core.handlers.withErrorHandler
 import com.openai.core.http.HttpMethod
 import com.openai.core.http.HttpRequest
 import com.openai.core.http.HttpResponse
 import com.openai.core.http.HttpResponse.Handler
-import com.openai.core.http.parseable
 import com.openai.core.prepare
 import com.openai.models.ErrorObject
 import com.openai.models.containers.files.content.ContentRetrieveParams
@@ -27,18 +24,18 @@ class ContentServiceImpl internal constructor(private val clientOptions: ClientO
 
     override fun withRawResponse(): ContentService.WithRawResponse = withRawResponse
 
-    override fun retrieve(params: ContentRetrieveParams, requestOptions: RequestOptions) {
+    override fun retrieve(
+        params: ContentRetrieveParams,
+        requestOptions: RequestOptions,
+    ): HttpResponse =
         // get /containers/{container_id}/files/{file_id}/content
         withRawResponse().retrieve(params, requestOptions)
-    }
 
     class WithRawResponseImpl internal constructor(private val clientOptions: ClientOptions) :
         ContentService.WithRawResponse {
 
         private val errorHandler: Handler<ErrorObject?> = errorHandler(clientOptions.jsonMapper)
 
-        private val retrieveHandler: Handler<Void?> = emptyHandler().withErrorHandler(errorHandler)
-
         override fun retrieve(
             params: ContentRetrieveParams,
             requestOptions: RequestOptions,
@@ -59,8 +56,7 @@ class ContentServiceImpl internal constructor(private val clientOptions: ClientO
                     .build()
                     .prepare(clientOptions, params, deploymentModel = null)
             val requestOptions = requestOptions.applyDefaults(RequestOptions.from(clientOptions))
-            val response = clientOptions.httpClient.execute(request, requestOptions)
-            return response.parseable { response.use { retrieveHandler.handle(it) } }
+            return clientOptions.httpClient.execute(request, requestOptions)
         }
     }
 }

openai-java-core/src/test/kotlin/com/openai/services/async/containers/files/ContentServiceAsyncTest.kt

@@ -2,32 +2,44 @@
 
 package com.openai.services.async.containers.files
 
+import com.github.tomakehurst.wiremock.client.WireMock.anyUrl
+import com.github.tomakehurst.wiremock.client.WireMock.get
+import com.github.tomakehurst.wiremock.client.WireMock.ok
+import com.github.tomakehurst.wiremock.client.WireMock.stubFor
+import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo
+import com.github.tomakehurst.wiremock.junit5.WireMockTest
 import com.openai.TestServerExtension
 import com.openai.client.okhttp.OpenAIOkHttpClientAsync
 import com.openai.models.containers.files.content.ContentRetrieveParams
+import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
+import org.junit.jupiter.api.parallel.ResourceLock
 
 @ExtendWith(TestServerExtension::class)
+@WireMockTest
+@ResourceLock("https://github.com/wiremock/wiremock/issues/169")
 internal class ContentServiceAsyncTest {
 
     @Test
-    fun retrieve() {
+    fun retrieve(wmRuntimeInfo: WireMockRuntimeInfo) {
         val client =
             OpenAIOkHttpClientAsync.builder()
-                .baseUrl(TestServerExtension.BASE_URL)
+                .baseUrl(wmRuntimeInfo.httpBaseUrl)
                 .apiKey("My API Key")
                 .build()
         val contentServiceAsync = client.containers().files().content()
+        stubFor(get(anyUrl()).willReturn(ok().withBody("abc")))
 
-        val future =
+        val contentFuture =
             contentServiceAsync.retrieve(
                 ContentRetrieveParams.builder()
                     .containerId("container_id")
                     .fileId("file_id")
                     .build()
             )
 
-        val response = future.get()
+        val content = contentFuture.get()
+        assertThat(content.body()).hasContent("abc")
     }
 }

openai-java-core/src/test/kotlin/com/openai/services/blocking/containers/files/ContentServiceTest.kt

@@ -2,26 +2,43 @@
 
 package com.openai.services.blocking.containers.files
 
+import com.github.tomakehurst.wiremock.client.WireMock.anyUrl
+import com.github.tomakehurst.wiremock.client.WireMock.get
+import com.github.tomakehurst.wiremock.client.WireMock.ok
+import com.github.tomakehurst.wiremock.client.WireMock.stubFor
+import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo
+import com.github.tomakehurst.wiremock.junit5.WireMockTest
 import com.openai.TestServerExtension
 import com.openai.client.okhttp.OpenAIOkHttpClient
 import com.openai.models.containers.files.content.ContentRetrieveParams
+import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
+import org.junit.jupiter.api.parallel.ResourceLock
 
 @ExtendWith(TestServerExtension::class)
+@WireMockTest
+@ResourceLock("https://github.com/wiremock/wiremock/issues/169")
 internal class ContentServiceTest {
 
     @Test
-    fun retrieve() {
+    fun retrieve(wmRuntimeInfo: WireMockRuntimeInfo) {
         val client =
             OpenAIOkHttpClient.builder()
-                .baseUrl(TestServerExtension.BASE_URL)
+                .baseUrl(wmRuntimeInfo.httpBaseUrl)
                 .apiKey("My API Key")
                 .build()
         val contentService = client.containers().files().content()
+        stubFor(get(anyUrl()).willReturn(ok().withBody("abc")))
 
-        contentService.retrieve(
-            ContentRetrieveParams.builder().containerId("container_id").fileId("file_id").build()
-        )
+        val content =
+            contentService.retrieve(
+                ContentRetrieveParams.builder()
+                    .containerId("container_id")
+                    .fileId("file_id")
+                    .build()
+            )
+
+        assertThat(content.body()).hasContent("abc")
     }
 }