commonMain.com.xebia.functional.openai.generated.model.Batch.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 com.xebia.functional.openai.generated.model.BatchErrors
import com.xebia.functional.openai.generated.model.BatchRequestCounts



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

/**
* 
*
    * @param id 
    * @param `object` The object type, which is always `batch`.
    * @param endpoint The OpenAI API endpoint used by the batch.
    * @param inputFileId The ID of the input file for the batch.
    * @param completionWindow The time frame within which the batch should be processed.
    * @param status The current status of the batch.
    * @param createdAt The Unix timestamp (in seconds) for when the batch was created.
    * @param errors 
    * @param outputFileId The ID of the file containing the outputs of successfully executed requests.
    * @param errorFileId The ID of the file containing the outputs of requests with errors.
    * @param inProgressAt The Unix timestamp (in seconds) for when the batch started processing.
    * @param expiresAt The Unix timestamp (in seconds) for when the batch will expire.
    * @param finalizingAt The Unix timestamp (in seconds) for when the batch started finalizing.
    * @param completedAt The Unix timestamp (in seconds) for when the batch was completed.
    * @param failedAt The Unix timestamp (in seconds) for when the batch failed.
    * @param expiredAt The Unix timestamp (in seconds) for when the batch expired.
    * @param cancellingAt The Unix timestamp (in seconds) for when the batch started cancelling.
    * @param cancelledAt The Unix timestamp (in seconds) for when the batch was cancelled.
    * @param requestCounts 
    * @param metadata Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. 
*/
@Serializable


data class Batch (
        @SerialName(value = "id") val id: kotlin.String,
        /* The object type, which is always `batch`. */
    @SerialName(value = "object") val `object`: Batch.`Object`,
        /* The OpenAI API endpoint used by the batch. */
    @SerialName(value = "endpoint") val endpoint: kotlin.String,
        /* The ID of the input file for the batch. */
    @SerialName(value = "input_file_id") val inputFileId: kotlin.String,
        /* The time frame within which the batch should be processed. */
    @SerialName(value = "completion_window") val completionWindow: kotlin.String,
        /* The current status of the batch. */
    @SerialName(value = "status") val status: Batch.Status,
        /* The Unix timestamp (in seconds) for when the batch was created. */
    @SerialName(value = "created_at") val createdAt: kotlin.Int,
        @SerialName(value = "errors") val errors: BatchErrors? = null,
        /* The ID of the file containing the outputs of successfully executed requests. */
    @SerialName(value = "output_file_id") val outputFileId: kotlin.String? = null,
        /* The ID of the file containing the outputs of requests with errors. */
    @SerialName(value = "error_file_id") val errorFileId: kotlin.String? = null,
        /* The Unix timestamp (in seconds) for when the batch started processing. */
    @SerialName(value = "in_progress_at") val inProgressAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the batch will expire. */
    @SerialName(value = "expires_at") val expiresAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the batch started finalizing. */
    @SerialName(value = "finalizing_at") val finalizingAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the batch was completed. */
    @SerialName(value = "completed_at") val completedAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the batch failed. */
    @SerialName(value = "failed_at") val failedAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the batch expired. */
    @SerialName(value = "expired_at") val expiredAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the batch started cancelling. */
    @SerialName(value = "cancelling_at") val cancellingAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the batch was cancelled. */
    @SerialName(value = "cancelled_at") val cancelledAt: kotlin.Int? = null,
        @SerialName(value = "request_counts") val requestCounts: BatchRequestCounts? = null,
        /* Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.  */
    @SerialName(value = "metadata") val metadata: kotlinx.serialization.json.JsonObject? = null
) {

            /**
            * The object type, which is always `batch`.
            *
            * Values: batch
            */
            @Serializable
            enum class `Object`(val value: kotlin.String) {
                @SerialName(value = "batch") batch("batch");
                }
            /**
            * The current status of the batch.
            *
            * Values: validating,failed,in_progress,finalizing,completed,expired,cancelling,cancelled
            */
            @Serializable
            enum class Status(val value: kotlin.String) {
                @SerialName(value = "validating") validating("validating"),
                @SerialName(value = "failed") failed("failed"),
                @SerialName(value = "in_progress") in_progress("in_progress"),
                @SerialName(value = "finalizing") finalizing("finalizing"),
                @SerialName(value = "completed") completed("completed"),
                @SerialName(value = "expired") expired("expired"),
                @SerialName(value = "cancelling") cancelling("cancelling"),
                @SerialName(value = "cancelled") cancelled("cancelled");
                }
}