feat(client): add User-Agent header

chore: unknown commit message

Author: stainless-bot

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

@@ -3,6 +3,7 @@
 package com.openai.client
 
 import com.openai.core.ClientOptions
+import com.openai.core.getPackageVersion
 import com.openai.models.*
 import com.openai.services.async.*
 
@@ -11,35 +12,52 @@ constructor(
     private val clientOptions: ClientOptions,
 ) : OpenAIClientAsync {
 
+    private val clientOptionsWithUserAgent =
+        if (clientOptions.headers.containsKey("User-Agent")) clientOptions
+        else
+            clientOptions
+                .toBuilder()
+                .putHeader("User-Agent", "${javaClass.simpleName}/Java ${getPackageVersion()}")
+                .build()
+
+    // Pass the original clientOptions so that this client sets its own User-Agent.
     private val sync: OpenAIClient by lazy { OpenAIClientImpl(clientOptions) }
 
     private val completions: CompletionServiceAsync by lazy {
-        CompletionServiceAsyncImpl(clientOptions)
+        CompletionServiceAsyncImpl(clientOptionsWithUserAgent)
     }
 
-    private val chat: ChatServiceAsync by lazy { ChatServiceAsyncImpl(clientOptions) }
+    private val chat: ChatServiceAsync by lazy { ChatServiceAsyncImpl(clientOptionsWithUserAgent) }
 
     private val embeddings: EmbeddingServiceAsync by lazy {
-        EmbeddingServiceAsyncImpl(clientOptions)
+        EmbeddingServiceAsyncImpl(clientOptionsWithUserAgent)
     }
 
-    private val files: FileServiceAsync by lazy { FileServiceAsyncImpl(clientOptions) }
+    private val files: FileServiceAsync by lazy { FileServiceAsyncImpl(clientOptionsWithUserAgent) }
 
-    private val images: ImageServiceAsync by lazy { ImageServiceAsyncImpl(clientOptions) }
+    private val images: ImageServiceAsync by lazy {
+        ImageServiceAsyncImpl(clientOptionsWithUserAgent)
+    }
 
     private val moderations: ModerationServiceAsync by lazy {
-        ModerationServiceAsyncImpl(clientOptions)
+        ModerationServiceAsyncImpl(clientOptionsWithUserAgent)
     }
 
-    private val models: ModelServiceAsync by lazy { ModelServiceAsyncImpl(clientOptions) }
+    private val models: ModelServiceAsync by lazy {
+        ModelServiceAsyncImpl(clientOptionsWithUserAgent)
+    }
 
     private val fineTuning: FineTuningServiceAsync by lazy {
-        FineTuningServiceAsyncImpl(clientOptions)
+        FineTuningServiceAsyncImpl(clientOptionsWithUserAgent)
     }
 
-    private val batches: BatchServiceAsync by lazy { BatchServiceAsyncImpl(clientOptions) }
+    private val batches: BatchServiceAsync by lazy {
+        BatchServiceAsyncImpl(clientOptionsWithUserAgent)
+    }
 
-    private val uploads: UploadServiceAsync by lazy { UploadServiceAsyncImpl(clientOptions) }
+    private val uploads: UploadServiceAsync by lazy {
+        UploadServiceAsyncImpl(clientOptionsWithUserAgent)
+    }
 
     override fun sync(): OpenAIClient = sync
 

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

@@ -3,6 +3,7 @@
 package com.openai.client
 
 import com.openai.core.ClientOptions
+import com.openai.core.getPackageVersion
 import com.openai.models.*
 import com.openai.services.blocking.*
 
@@ -11,27 +12,44 @@ constructor(
     private val clientOptions: ClientOptions,
 ) : OpenAIClient {
 
+    private val clientOptionsWithUserAgent =
+        if (clientOptions.headers.containsKey("User-Agent")) clientOptions
+        else
+            clientOptions
+                .toBuilder()
+                .putHeader("User-Agent", "${javaClass.simpleName}/Java ${getPackageVersion()}")
+                .build()
+
+    // Pass the original clientOptions so that this client sets its own User-Agent.
     private val async: OpenAIClientAsync by lazy { OpenAIClientAsyncImpl(clientOptions) }
 
-    private val completions: CompletionService by lazy { CompletionServiceImpl(clientOptions) }
+    private val completions: CompletionService by lazy {
+        CompletionServiceImpl(clientOptionsWithUserAgent)
+    }
 
-    private val chat: ChatService by lazy { ChatServiceImpl(clientOptions) }
+    private val chat: ChatService by lazy { ChatServiceImpl(clientOptionsWithUserAgent) }
 
-    private val embeddings: EmbeddingService by lazy { EmbeddingServiceImpl(clientOptions) }
+    private val embeddings: EmbeddingService by lazy {
+        EmbeddingServiceImpl(clientOptionsWithUserAgent)
+    }
 
-    private val files: FileService by lazy { FileServiceImpl(clientOptions) }
+    private val files: FileService by lazy { FileServiceImpl(clientOptionsWithUserAgent) }
 
-    private val images: ImageService by lazy { ImageServiceImpl(clientOptions) }
+    private val images: ImageService by lazy { ImageServiceImpl(clientOptionsWithUserAgent) }
 
-    private val moderations: ModerationService by lazy { ModerationServiceImpl(clientOptions) }
+    private val moderations: ModerationService by lazy {
+        ModerationServiceImpl(clientOptionsWithUserAgent)
+    }
 
-    private val models: ModelService by lazy { ModelServiceImpl(clientOptions) }
+    private val models: ModelService by lazy { ModelServiceImpl(clientOptionsWithUserAgent) }
 
-    private val fineTuning: FineTuningService by lazy { FineTuningServiceImpl(clientOptions) }
+    private val fineTuning: FineTuningService by lazy {
+        FineTuningServiceImpl(clientOptionsWithUserAgent)
+    }
 
-    private val batches: BatchService by lazy { BatchServiceImpl(clientOptions) }
+    private val batches: BatchService by lazy { BatchServiceImpl(clientOptionsWithUserAgent) }
 
-    private val uploads: UploadService by lazy { UploadServiceImpl(clientOptions) }
+    private val uploads: UploadService by lazy { UploadServiceImpl(clientOptionsWithUserAgent) }
 
     override fun async(): OpenAIClientAsync = async
 

openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt

@@ -21,8 +21,11 @@ private constructor(
     @get:JvmName("headers") val headers: ListMultimap<String, String>,
     @get:JvmName("queryParams") val queryParams: ListMultimap<String, String>,
     @get:JvmName("responseValidation") val responseValidation: Boolean,
+    @get:JvmName("maxRetries") val maxRetries: Int,
 ) {
 
+    fun toBuilder() = Builder().from(this)
+
     companion object {
 
         const val PRODUCTION_URL = "https://api.openai.com/v1"
@@ -46,6 +49,27 @@ private constructor(
         private var organization: String? = null
         private var project: String? = null
 
+        @JvmSynthetic
+        internal fun from(clientOptions: ClientOptions) = apply {
+            httpClient = clientOptions.httpClient
+            jsonMapper = clientOptions.jsonMapper
+            clock = clientOptions.clock
+            baseUrl = clientOptions.baseUrl
+            headers =
+                clientOptions.headers.asMap().mapValuesTo(mutableMapOf()) { (_, value) ->
+                    value.toMutableList()
+                }
+            queryParams =
+                clientOptions.queryParams.asMap().mapValuesTo(mutableMapOf()) { (_, value) ->
+                    value.toMutableList()
+                }
+            responseValidation = clientOptions.responseValidation
+            maxRetries = clientOptions.maxRetries
+            apiKey = clientOptions.apiKey
+            organization = clientOptions.organization
+            project = clientOptions.project
+        }
+
         fun httpClient(httpClient: HttpClient) = apply { this.httpClient = httpClient }
 
         fun jsonMapper(jsonMapper: JsonMapper) = apply { this.jsonMapper = jsonMapper }
@@ -150,6 +174,7 @@ private constructor(
                 headers.toUnmodifiable(),
                 queryParams.toUnmodifiable(),
                 responseValidation,
+                maxRetries,
             )
         }
     }