feat(client)!: add/rename methods for headers/query params

chore: unknown commit message
openai · Nov 4, 2024 · 80ca5d9 · 80ca5d9
1 parent 4fd6c23
commit 80ca5d9
Show file tree

Hide file tree

Showing 27 changed files with 982 additions and 54 deletions.
diff --git a/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt b/openai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClient.kt
@@ -50,7 +50,21 @@ class OpenAIOkHttpClient private constructor() {
             clientOptions.putAllHeaders(headers)
         }
 
-        fun removeHeader(name: String) = apply { clientOptions.removeHeader(name) }
+        fun replaceHeaders(name: String, value: String) = apply {
+            clientOptions.replaceHeaders(name, value)
+        }
+
+        fun replaceHeaders(name: String, values: Iterable<String>) = apply {
+            clientOptions.replaceHeaders(name, values)
+        }
+
+        fun replaceAllHeaders(headers: Map<String, Iterable<String>>) = apply {
+            clientOptions.replaceAllHeaders(headers)
+        }
+
+        fun removeHeaders(name: String) = apply { clientOptions.removeHeaders(name) }
+
+        fun removeAllHeaders(names: Set<String>) = apply { clientOptions.removeAllHeaders(names) }
 
         fun queryParams(queryParams: Map<String, Iterable<String>>) = apply {
             clientOptions.queryParams(queryParams)
@@ -68,7 +82,23 @@ class OpenAIOkHttpClient private constructor() {
             clientOptions.putAllQueryParams(queryParams)
         }
 
-        fun removeQueryParam(key: String) = apply { clientOptions.removeQueryParam(key) }
+        fun replaceQueryParams(key: String, value: String) = apply {
+            clientOptions.replaceQueryParams(key, value)
+        }
+
+        fun replaceQueryParams(key: String, values: Iterable<String>) = apply {
+            clientOptions.replaceQueryParams(key, values)
+        }
+
+        fun replaceAllQueryParams(queryParams: Map<String, Iterable<String>>) = apply {
+            clientOptions.replaceAllQueryParams(queryParams)
+        }
+
+        fun removeQueryParams(key: String) = apply { clientOptions.removeQueryParams(key) }
+
+        fun removeAllQueryParams(keys: Set<String>) = apply {
+            clientOptions.removeAllQueryParams(keys)
+        }
 
         fun timeout(timeout: Duration) = apply { this.timeout = timeout }
 

diff --git a/...ai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt b/...ai-java-client-okhttp/src/main/kotlin/com/openai/client/okhttp/OpenAIOkHttpClientAsync.kt
@@ -50,7 +50,21 @@ class OpenAIOkHttpClientAsync private constructor() {
             clientOptions.putAllHeaders(headers)
         }
 
-        fun removeHeader(name: String) = apply { clientOptions.removeHeader(name) }
+        fun replaceHeaders(name: String, value: String) = apply {
+            clientOptions.replaceHeaders(name, value)
+        }
+
+        fun replaceHeaders(name: String, values: Iterable<String>) = apply {
+            clientOptions.replaceHeaders(name, values)
+        }
+
+        fun replaceAllHeaders(headers: Map<String, Iterable<String>>) = apply {
+            clientOptions.replaceAllHeaders(headers)
+        }
+
+        fun removeHeaders(name: String) = apply { clientOptions.removeHeaders(name) }
+
+        fun removeAllHeaders(names: Set<String>) = apply { clientOptions.removeAllHeaders(names) }
 
         fun queryParams(queryParams: Map<String, Iterable<String>>) = apply {
             clientOptions.queryParams(queryParams)
@@ -68,7 +82,23 @@ class OpenAIOkHttpClientAsync private constructor() {
             clientOptions.putAllQueryParams(queryParams)
         }
 
-        fun removeQueryParam(key: String) = apply { clientOptions.removeQueryParam(key) }
+        fun replaceQueryParams(key: String, value: String) = apply {
+            clientOptions.replaceQueryParams(key, value)
+        }
+
+        fun replaceQueryParams(key: String, values: Iterable<String>) = apply {
+            clientOptions.replaceQueryParams(key, values)
+        }
+
+        fun replaceAllQueryParams(queryParams: Map<String, Iterable<String>>) = apply {
+            clientOptions.replaceAllQueryParams(queryParams)
+        }
+
+        fun removeQueryParams(key: String) = apply { clientOptions.removeQueryParams(key) }
+
+        fun removeAllQueryParams(keys: Set<String>) = apply {
+            clientOptions.removeAllQueryParams(keys)
+        }
 
         fun timeout(timeout: Duration) = apply { this.timeout = timeout }
 

diff --git a/openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt b/openai-java-core/src/main/kotlin/com/openai/core/ClientOptions.kt
@@ -89,7 +89,21 @@ private constructor(
             headers.forEach(::putHeaders)
         }
 
-        fun removeHeader(name: String) = apply { headers.removeAll(name) }
+        fun replaceHeaders(name: String, value: String) = apply {
+            headers.replaceValues(name, listOf(value))
+        }
+
+        fun replaceHeaders(name: String, values: Iterable<String>) = apply {
+            headers.replaceValues(name, values)
+        }
+
+        fun replaceAllHeaders(headers: Map<String, Iterable<String>>) = apply {
+            headers.forEach(::replaceHeaders)
+        }
+
+        fun removeHeaders(name: String) = apply { headers.removeAll(name) }
+
+        fun removeAllHeaders(names: Set<String>) = apply { names.forEach(::removeHeaders) }
 
         fun queryParams(queryParams: Map<String, Iterable<String>>) = apply {
             this.queryParams.clear()
@@ -106,7 +120,21 @@ private constructor(
             queryParams.forEach(::putQueryParams)
         }
 
-        fun removeQueryParam(key: String) = apply { queryParams.removeAll(key) }
+        fun replaceQueryParams(key: String, value: String) = apply {
+            queryParams.replaceValues(key, listOf(value))
+        }
+
+        fun replaceQueryParams(key: String, values: Iterable<String>) = apply {
+            queryParams.replaceValues(key, values)
+        }
+
+        fun replaceAllQueryParams(queryParams: Map<String, Iterable<String>>) = apply {
+            queryParams.forEach(::replaceQueryParams)
+        }
+
+        fun removeQueryParams(key: String) = apply { queryParams.removeAll(key) }
+
+        fun removeAllQueryParams(keys: Set<String>) = apply { keys.forEach(::removeQueryParams) }
 
         fun responseValidation(responseValidation: Boolean) = apply {
             this.responseValidation = responseValidation

diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt
@@ -100,7 +100,23 @@ constructor(
             additionalHeaders.forEach(::putAdditionalHeaders)
         }
 
-        fun removeAdditionalHeader(name: String) = apply { additionalHeaders.removeAll(name) }
+        fun replaceAdditionalHeaders(name: String, value: String) = apply {
+            additionalHeaders.replaceValues(name, listOf(value))
+        }
+
+        fun replaceAdditionalHeaders(name: String, values: Iterable<String>) = apply {
+            additionalHeaders.replaceValues(name, values)
+        }
+
+        fun replaceAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply {
+            additionalHeaders.forEach(::replaceAdditionalHeaders)
+        }
+
+        fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.removeAll(name) }
+
+        fun removeAllAdditionalHeaders(names: Set<String>) = apply {
+            names.forEach(::removeAdditionalHeaders)
+        }
 
         fun additionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = apply {
             this.additionalQueryParams.clear()
@@ -120,7 +136,26 @@ constructor(
                 additionalQueryParams.forEach(::putAdditionalQueryParams)
             }
 
-        fun removeAdditionalQueryParam(key: String) = apply { additionalQueryParams.removeAll(key) }
+        fun replaceAdditionalQueryParams(key: String, value: String) = apply {
+            additionalQueryParams.replaceValues(key, listOf(value))
+        }
+
+        fun replaceAdditionalQueryParams(key: String, values: Iterable<String>) = apply {
+            additionalQueryParams.replaceValues(key, values)
+        }
+
+        fun replaceAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) =
+            apply {
+                additionalQueryParams.forEach(::replaceAdditionalQueryParams)
+            }
+
+        fun removeAdditionalQueryParams(key: String) = apply {
+            additionalQueryParams.removeAll(key)
+        }
+
+        fun removeAllAdditionalQueryParams(keys: Set<String>) = apply {
+            keys.forEach(::removeAdditionalQueryParams)
+        }
 
         fun additionalBodyProperties(additionalBodyProperties: Map<String, JsonValue>) = apply {
             this.additionalBodyProperties.clear()

diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt
@@ -306,7 +306,23 @@ constructor(
             additionalHeaders.forEach(::putAdditionalHeaders)
         }
 
-        fun removeAdditionalHeader(name: String) = apply { additionalHeaders.removeAll(name) }
+        fun replaceAdditionalHeaders(name: String, value: String) = apply {
+            additionalHeaders.replaceValues(name, listOf(value))
+        }
+
+        fun replaceAdditionalHeaders(name: String, values: Iterable<String>) = apply {
+            additionalHeaders.replaceValues(name, values)
+        }
+
+        fun replaceAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply {
+            additionalHeaders.forEach(::replaceAdditionalHeaders)
+        }
+
+        fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.removeAll(name) }
+
+        fun removeAllAdditionalHeaders(names: Set<String>) = apply {
+            names.forEach(::removeAdditionalHeaders)
+        }
 
         fun additionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = apply {
             this.additionalQueryParams.clear()
@@ -326,7 +342,26 @@ constructor(
                 additionalQueryParams.forEach(::putAdditionalQueryParams)
             }
 
-        fun removeAdditionalQueryParam(key: String) = apply { additionalQueryParams.removeAll(key) }
+        fun replaceAdditionalQueryParams(key: String, value: String) = apply {
+            additionalQueryParams.replaceValues(key, listOf(value))
+        }
+
+        fun replaceAdditionalQueryParams(key: String, values: Iterable<String>) = apply {
+            additionalQueryParams.replaceValues(key, values)
+        }
+
+        fun replaceAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) =
+            apply {
+                additionalQueryParams.forEach(::replaceAdditionalQueryParams)
+            }
+
+        fun removeAdditionalQueryParams(key: String) = apply {
+            additionalQueryParams.removeAll(key)
+        }
+
+        fun removeAllAdditionalQueryParams(keys: Set<String>) = apply {
+            keys.forEach(::removeAdditionalQueryParams)
+        }
 
         fun additionalBodyProperties(additionalBodyProperties: Map<String, JsonValue>) = apply {
             this.additionalBodyProperties.clear()

diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt
@@ -106,7 +106,23 @@ constructor(
             additionalHeaders.forEach(::putAdditionalHeaders)
         }
 
-        fun removeAdditionalHeader(name: String) = apply { additionalHeaders.removeAll(name) }
+        fun replaceAdditionalHeaders(name: String, value: String) = apply {
+            additionalHeaders.replaceValues(name, listOf(value))
+        }
+
+        fun replaceAdditionalHeaders(name: String, values: Iterable<String>) = apply {
+            additionalHeaders.replaceValues(name, values)
+        }
+
+        fun replaceAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply {
+            additionalHeaders.forEach(::replaceAdditionalHeaders)
+        }
+
+        fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.removeAll(name) }
+
+        fun removeAllAdditionalHeaders(names: Set<String>) = apply {
+            names.forEach(::removeAdditionalHeaders)
+        }
 
         fun additionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = apply {
             this.additionalQueryParams.clear()
@@ -126,7 +142,26 @@ constructor(
                 additionalQueryParams.forEach(::putAdditionalQueryParams)
             }
 
-        fun removeAdditionalQueryParam(key: String) = apply { additionalQueryParams.removeAll(key) }
+        fun replaceAdditionalQueryParams(key: String, value: String) = apply {
+            additionalQueryParams.replaceValues(key, listOf(value))
+        }
+
+        fun replaceAdditionalQueryParams(key: String, values: Iterable<String>) = apply {
+            additionalQueryParams.replaceValues(key, values)
+        }
+
+        fun replaceAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) =
+            apply {
+                additionalQueryParams.forEach(::replaceAdditionalQueryParams)
+            }
+
+        fun removeAdditionalQueryParams(key: String) = apply {
+            additionalQueryParams.removeAll(key)
+        }
+
+        fun removeAllAdditionalQueryParams(keys: Set<String>) = apply {
+            keys.forEach(::removeAdditionalQueryParams)
+        }
 
         fun build(): BatchListParams =
             BatchListParams(

diff --git a/openai-java-core/src/main/kotlin/com/openai/models/BatchRetrieveParams.kt b/openai-java-core/src/main/kotlin/com/openai/models/BatchRetrieveParams.kt
@@ -88,7 +88,23 @@ constructor(
             additionalHeaders.forEach(::putAdditionalHeaders)
         }
 
-        fun removeAdditionalHeader(name: String) = apply { additionalHeaders.removeAll(name) }
+        fun replaceAdditionalHeaders(name: String, value: String) = apply {
+            additionalHeaders.replaceValues(name, listOf(value))
+        }
+
+        fun replaceAdditionalHeaders(name: String, values: Iterable<String>) = apply {
+            additionalHeaders.replaceValues(name, values)
+        }
+
+        fun replaceAllAdditionalHeaders(additionalHeaders: Map<String, Iterable<String>>) = apply {
+            additionalHeaders.forEach(::replaceAdditionalHeaders)
+        }
+
+        fun removeAdditionalHeaders(name: String) = apply { additionalHeaders.removeAll(name) }
+
+        fun removeAllAdditionalHeaders(names: Set<String>) = apply {
+            names.forEach(::removeAdditionalHeaders)
+        }
 
         fun additionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) = apply {
             this.additionalQueryParams.clear()
@@ -108,7 +124,26 @@ constructor(
                 additionalQueryParams.forEach(::putAdditionalQueryParams)
             }
 
-        fun removeAdditionalQueryParam(key: String) = apply { additionalQueryParams.removeAll(key) }
+        fun replaceAdditionalQueryParams(key: String, value: String) = apply {
+            additionalQueryParams.replaceValues(key, listOf(value))
+        }
+
+        fun replaceAdditionalQueryParams(key: String, values: Iterable<String>) = apply {
+            additionalQueryParams.replaceValues(key, values)
+        }
+
+        fun replaceAllAdditionalQueryParams(additionalQueryParams: Map<String, Iterable<String>>) =
+            apply {
+                additionalQueryParams.forEach(::replaceAdditionalQueryParams)
+            }
+
+        fun removeAdditionalQueryParams(key: String) = apply {
+            additionalQueryParams.removeAll(key)
+        }
+
+        fun removeAllAdditionalQueryParams(keys: Set<String>) = apply {
+            keys.forEach(::removeAdditionalQueryParams)
+        }
 
         fun build(): BatchRetrieveParams =
             BatchRetrieveParams(