feat(client): add close method (#164)

Author: stainless-app[bot]

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

@@ -39,4 +39,17 @@ interface OpenAIClient {
     fun batches(): BatchService
 
     fun uploads(): UploadService
+
+    /**
+     * Closes this client, relinquishing any underlying resources.
+     *
+     * This is purposefully not inherited from [AutoCloseable] because the client is long-lived and
+     * usually should not be synchronously closed via try-with-resources.
+     *
+     * It's also usually not necessary to call this method at all. the default HTTP client
+     * automatically releases threads and connections if they remain idle, but if you are writing an
+     * application that needs to aggressively release unused resources, then you may call this
+     * method.
+     */
+    fun close()
 }

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

@@ -39,4 +39,17 @@ interface OpenAIClientAsync {
     fun batches(): BatchServiceAsync
 
     fun uploads(): UploadServiceAsync
+
+    /**
+     * Closes this client, relinquishing any underlying resources.
+     *
+     * This is purposefully not inherited from [AutoCloseable] because the client is long-lived and
+     * usually should not be synchronously closed via try-with-resources.
+     *
+     * It's also usually not necessary to call this method at all. the default HTTP client
+     * automatically releases threads and connections if they remain idle, but if you are writing an
+     * application that needs to aggressively release unused resources, then you may call this
+     * method.
+     */
+    fun close()
 }

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

@@ -104,4 +104,6 @@ constructor(
     override fun batches(): BatchServiceAsync = batches
 
     override fun uploads(): UploadServiceAsync = uploads
+
+    override fun close() = clientOptions.httpClient.close()
 }

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

@@ -96,4 +96,6 @@ constructor(
     override fun batches(): BatchService = batches
 
     override fun uploads(): UploadService = uploads
+
+    override fun close() = clientOptions.httpClient.close()
 }