commonMain.com.xebia.functional.openai.generated.model.CreateBatchRequest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xef-openai-client Show documentation
Building applications with LLMs through composability in Kotlin
The newest version!
/**
 *
 * Please note:
 * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit this file manually.
 *
 */

@file:Suppress(
    "ArrayInDataClass",
    "EnumEntryName",
    "RemoveRedundantQualifierName",
    "UnusedImport"
)

package com.xebia.functional.openai.generated.model




import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.Contextual
import kotlin.js.JsName
import kotlinx.serialization.json.*

/**
* 
*
    * @param inputFileId The ID of an uploaded file that contains requests for the new batch.  See [upload file](/docs/api-reference/files/create) for how to upload a file.  Your input file must be formatted as a [JSONL file](/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 100 MB in size. 
    * @param endpoint 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.
    * @param completionWindow The time frame within which the batch should be processed. Currently only `24h` is supported.
    * @param metadata Optional custom metadata for the batch.
*/
@Serializable


data class CreateBatchRequest (
        /* The ID of an uploaded file that contains requests for the new batch.  See [upload file](/docs/api-reference/files/create) for how to upload a file.  Your input file must be formatted as a [JSONL file](/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 100 MB in size.  */
    @SerialName(value = "input_file_id") val inputFileId: kotlin.String,
        /* 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. */
    @SerialName(value = "endpoint") val endpoint: CreateBatchRequest.Endpoint,
        /* The time frame within which the batch should be processed. Currently only `24h` is supported. */
    @SerialName(value = "completion_window") val completionWindow: CreateBatchRequest.CompletionWindow,
        /* Optional custom metadata for the batch. */
    @SerialName(value = "metadata") val metadata: kotlin.collections.Map? = null
) {

            /**
            * 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.
            *
            * Values: chat_slash_completions,embeddings,completions
            */
            @Serializable
            enum class Endpoint(val value: kotlin.String) {
                @SerialName(value = "/v1/chat/completions") chat_slash_completions("/v1/chat/completions"),
                @SerialName(value = "/v1/embeddings") embeddings("/v1/embeddings"),
                @SerialName(value = "/v1/completions") completions("/v1/completions");
                }
            /**
            * The time frame within which the batch should be processed. Currently only `24h` is supported.
            *
            * Values: _24h
            */
            @Serializable
            enum class CompletionWindow(val value: kotlin.String) {
                @SerialName(value = "24h") _24h("24h");
                }
}