Skip to content

Commit b744bac

Browse files
docs: async and sync method comments (#167)
1 parent dce52af commit b744bac

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ import com.openai.services.blocking.UploadService
3030
*/
3131
interface OpenAIClient {
3232

33+
/**
34+
* Returns a version of this client that uses asynchronous execution.
35+
*
36+
* The returned client shares its resources, like its connection pool and thread pools, with
37+
* this client.
38+
*/
3339
fun async(): OpenAIClientAsync
3440

3541
fun completions(): CompletionService

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ import com.openai.services.async.UploadServiceAsync
3030
*/
3131
interface OpenAIClientAsync {
3232

33+
/**
34+
* Returns a version of this client that uses synchronous execution.
35+
*
36+
* The returned client shares its resources, like its connection pool and thread pools, with
37+
* this client.
38+
*/
3339
fun sync(): OpenAIClient
3440

3541
fun completions(): CompletionServiceAsync

0 commit comments

Comments
 (0)