feat(client): put body field in params, add more convenience methods, and add missing docs (#77)

Author: stainless-app[bot]

openai-java-core/src/main/kotlin/com/openai/models/BatchCancelParams.kt

@@ -27,9 +27,8 @@ constructor(
     fun _additionalBodyProperties(): Map<String, JsonValue> = additionalBodyProperties
 
     @JvmSynthetic
-    internal fun getBody(): Optional<Map<String, JsonValue>> {
-        return Optional.ofNullable(additionalBodyProperties.ifEmpty { null })
-    }
+    internal fun getBody(): Optional<Map<String, JsonValue>> =
+        Optional.ofNullable(additionalBodyProperties.ifEmpty { null })
 
     @JvmSynthetic internal fun getHeaders(): Headers = additionalHeaders
 

openai-java-core/src/main/kotlin/com/openai/models/BatchCreateParams.kt

@@ -21,39 +21,46 @@ import java.util.Optional
 
 class BatchCreateParams
 constructor(
-    private val completionWindow: CompletionWindow,
-    private val endpoint: Endpoint,
-    private val inputFileId: String,
-    private val metadata: Metadata?,
+    private val body: BatchCreateBody,
     private val additionalHeaders: Headers,
     private val additionalQueryParams: QueryParams,
-    private val additionalBodyProperties: Map<String, JsonValue>,
 ) {
 
-    fun completionWindow(): CompletionWindow = completionWindow
+    /**
+     * The time frame within which the batch should be processed. Currently only `24h` is supported.
+     */
+    fun completionWindow(): CompletionWindow = body.completionWindow()
+
+    /**
+     * The endpoint to be used for all requests in the batch. Currently `/v1/chat/completions`,
+     * `/v1/embeddings`, and `/v1/completions` are supported. Note that `/v1/embeddings` batches are
+     * also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.
+     */
+    fun endpoint(): Endpoint = body.endpoint()
+
+    /**
+     * The ID of an uploaded file that contains requests for the new batch.
+     *
+     * See [upload file](https://platform.openai.com/docs/api-reference/files/create) for how to
+     * upload a file.
+     *
+     * Your input file must be formatted as a
+     * [JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input), and must be
+     * uploaded with the purpose `batch`. The file can contain up to 50,000 requests, and can be up
+     * to 200 MB in size.
+     */
+    fun inputFileId(): String = body.inputFileId()
 
-    fun endpoint(): Endpoint = endpoint
-
-    fun inputFileId(): String = inputFileId
-
-    fun metadata(): Optional<Metadata> = Optional.ofNullable(metadata)
+    /** Optional custom metadata for the batch. */
+    fun metadata(): Optional<Metadata> = body.metadata()
 
     fun _additionalHeaders(): Headers = additionalHeaders
 
     fun _additionalQueryParams(): QueryParams = additionalQueryParams
 
-    fun _additionalBodyProperties(): Map<String, JsonValue> = additionalBodyProperties
-
-    @JvmSynthetic
-    internal fun getBody(): BatchCreateBody {
-        return BatchCreateBody(
-            completionWindow,
-            endpoint,
-            inputFileId,
-            metadata,
-            additionalBodyProperties,
-        )
-    }
+    fun _additionalBodyProperties(): Map<String, JsonValue> = body._additionalProperties()
+
+    @JvmSynthetic internal fun getBody(): BatchCreateBody = body
 
     @JvmSynthetic internal fun getHeaders(): Headers = additionalHeaders
 
@@ -221,31 +228,23 @@ constructor(
     @NoAutoDetect
     class Builder {
 
-        private var completionWindow: CompletionWindow? = null
-        private var endpoint: Endpoint? = null
-        private var inputFileId: String? = null
-        private var metadata: Metadata? = null
+        private var body: BatchCreateBody.Builder = BatchCreateBody.builder()
         private var additionalHeaders: Headers.Builder = Headers.builder()
         private var additionalQueryParams: QueryParams.Builder = QueryParams.builder()
-        private var additionalBodyProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
         internal fun from(batchCreateParams: BatchCreateParams) = apply {
-            completionWindow = batchCreateParams.completionWindow
-            endpoint = batchCreateParams.endpoint
-            inputFileId = batchCreateParams.inputFileId
-            metadata = batchCreateParams.metadata
+            body = batchCreateParams.body.toBuilder()
             additionalHeaders = batchCreateParams.additionalHeaders.toBuilder()
             additionalQueryParams = batchCreateParams.additionalQueryParams.toBuilder()
-            additionalBodyProperties = batchCreateParams.additionalBodyProperties.toMutableMap()
         }
 
         /**
          * The time frame within which the batch should be processed. Currently only `24h` is
          * supported.
          */
         fun completionWindow(completionWindow: CompletionWindow) = apply {
-            this.completionWindow = completionWindow
+            body.completionWindow(completionWindow)
         }
 
         /**
@@ -254,7 +253,7 @@ constructor(
          * are also restricted to a maximum of 50,000 embedding inputs across all requests in the
          * batch.
          */
-        fun endpoint(endpoint: Endpoint) = apply { this.endpoint = endpoint }
+        fun endpoint(endpoint: Endpoint) = apply { body.endpoint(endpoint) }
 
         /**
          * The ID of an uploaded file that contains requests for the new batch.
@@ -267,10 +266,10 @@ constructor(
          * must be uploaded with the purpose `batch`. The file can contain up to 50,000 requests,
          * and can be up to 200 MB in size.
          */
-        fun inputFileId(inputFileId: String) = apply { this.inputFileId = inputFileId }
+        fun inputFileId(inputFileId: String) = apply { body.inputFileId(inputFileId) }
 
         /** Optional custom metadata for the batch. */
-        fun metadata(metadata: Metadata) = apply { this.metadata = metadata }
+        fun metadata(metadata: Metadata) = apply { body.metadata(metadata) }
 
         fun additionalHeaders(additionalHeaders: Headers) = apply {
             this.additionalHeaders.clear()
@@ -371,36 +370,29 @@ constructor(
         }
 
         fun additionalBodyProperties(additionalBodyProperties: Map<String, JsonValue>) = apply {
-            this.additionalBodyProperties.clear()
-            putAllAdditionalBodyProperties(additionalBodyProperties)
+            body.additionalProperties(additionalBodyProperties)
         }
 
         fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply {
-            additionalBodyProperties.put(key, value)
+            body.putAdditionalProperty(key, value)
         }
 
         fun putAllAdditionalBodyProperties(additionalBodyProperties: Map<String, JsonValue>) =
             apply {
-                this.additionalBodyProperties.putAll(additionalBodyProperties)
+                body.putAllAdditionalProperties(additionalBodyProperties)
             }
 
-        fun removeAdditionalBodyProperty(key: String) = apply {
-            additionalBodyProperties.remove(key)
-        }
+        fun removeAdditionalBodyProperty(key: String) = apply { body.removeAdditionalProperty(key) }
 
         fun removeAllAdditionalBodyProperties(keys: Set<String>) = apply {
-            keys.forEach(::removeAdditionalBodyProperty)
+            body.removeAllAdditionalProperties(keys)
         }
 
         fun build(): BatchCreateParams =
             BatchCreateParams(
-                checkNotNull(completionWindow) { "`completionWindow` is required but was not set" },
-                checkNotNull(endpoint) { "`endpoint` is required but was not set" },
-                checkNotNull(inputFileId) { "`inputFileId` is required but was not set" },
-                metadata,
+                body.build(),
                 additionalHeaders.build(),
                 additionalQueryParams.build(),
-                additionalBodyProperties.toImmutable(),
             )
     }
 
@@ -591,11 +583,11 @@ constructor(
             return true
         }
 
-        return /* spotless:off */ other is BatchCreateParams && completionWindow == other.completionWindow && endpoint == other.endpoint && inputFileId == other.inputFileId && metadata == other.metadata && additionalHeaders == other.additionalHeaders && additionalQueryParams == other.additionalQueryParams && additionalBodyProperties == other.additionalBodyProperties /* spotless:on */
+        return /* spotless:off */ other is BatchCreateParams && body == other.body && additionalHeaders == other.additionalHeaders && additionalQueryParams == other.additionalQueryParams /* spotless:on */
     }
 
-    override fun hashCode(): Int = /* spotless:off */ Objects.hash(completionWindow, endpoint, inputFileId, metadata, additionalHeaders, additionalQueryParams, additionalBodyProperties) /* spotless:on */
+    override fun hashCode(): Int = /* spotless:off */ Objects.hash(body, additionalHeaders, additionalQueryParams) /* spotless:on */
 
     override fun toString() =
-        "BatchCreateParams{completionWindow=$completionWindow, endpoint=$endpoint, inputFileId=$inputFileId, metadata=$metadata, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams, additionalBodyProperties=$additionalBodyProperties}"
+        "BatchCreateParams{body=$body, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}"
 }

openai-java-core/src/main/kotlin/com/openai/models/BatchListParams.kt

@@ -16,8 +16,17 @@ constructor(
     private val additionalQueryParams: QueryParams,
 ) {
 
+    /**
+     * A cursor for use in pagination. `after` is an object ID that defines your place in the list.
+     * For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
+     * subsequent call can include after=obj_foo in order to fetch the next page of the list.
+     */
     fun after(): Optional<String> = Optional.ofNullable(after)
 
+    /**
+     * A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
+     * default is 20.
+     */
     fun limit(): Optional<Long> = Optional.ofNullable(limit)
 
     fun _additionalHeaders(): Headers = additionalHeaders