docs: async and sync method comments (#167)

openai · Jan 26, 2025 · 6f11e5d · 6f11e5d
1 parent 4344883
commit 6f11e5d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/openai-java-core/src/main/kotlin/com/openai/client/OpenAIClient.kt b/openai-java-core/src/main/kotlin/com/openai/client/OpenAIClient.kt
@@ -30,6 +30,12 @@ import com.openai.services.blocking.UploadService
  */
 interface OpenAIClient {
 
+    /**
+     * Returns a version of this client that uses asynchronous execution.
+     *
+     * The returned client shares its resources, like its connection pool and thread pools, with
+     * this client.
+     */
     fun async(): OpenAIClientAsync
 
     fun completions(): CompletionService

diff --git a/openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientAsync.kt b/openai-java-core/src/main/kotlin/com/openai/client/OpenAIClientAsync.kt
@@ -30,6 +30,12 @@ import com.openai.services.async.UploadServiceAsync
  */
 interface OpenAIClientAsync {
 
+    /**
+     * Returns a version of this client that uses synchronous execution.
+     *
+     * The returned client shares its resources, like its connection pool and thread pools, with
+     * this client.
+     */
     fun sync(): OpenAIClient
 
     fun completions(): CompletionServiceAsync