commonMain.com.xebia.functional.openai.generated.model.OpenAIFile.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-jvm Show documentation
Building applications with LLMs through composability in Kotlin
There is a newer version: 0.0.5-alpha.119
Show 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.*

/**
* The `File` object represents a document that has been uploaded to OpenAI.
*
    * @param id The file identifier, which can be referenced in the API endpoints.
    * @param bytes The size of the file, in bytes.
    * @param createdAt The Unix timestamp (in seconds) for when the file was created.
    * @param filename The name of the file.
    * @param `object` The object type, which is always `file`.
    * @param purpose The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`.
    * @param status Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.
    * @param statusDetails Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`.
*/
@Serializable


data class OpenAIFile (
        /* The file identifier, which can be referenced in the API endpoints. */
    @SerialName(value = "id") val id: kotlin.String,
        /* The size of the file, in bytes. */
    @SerialName(value = "bytes") val bytes: kotlin.Int,
        /* The Unix timestamp (in seconds) for when the file was created. */
    @SerialName(value = "created_at") val createdAt: kotlin.Int,
        /* The name of the file. */
    @SerialName(value = "filename") val filename: kotlin.String,
        /* The object type, which is always `file`. */
    @SerialName(value = "object") val `object`: OpenAIFile.`Object`,
        /* The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`. */
    @SerialName(value = "purpose") val purpose: OpenAIFile.Purpose,
        /* Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. */
    @Deprecated(message = "This property is deprecated.")
    @SerialName(value = "status") val status: OpenAIFile.Status,
        /* Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`. */
    @Deprecated(message = "This property is deprecated.")
    @SerialName(value = "status_details") val statusDetails: kotlin.String? = null
) {

            /**
            * The object type, which is always `file`.
            *
            * Values: file
            */
            @Serializable
            enum class `Object`(val value: kotlin.String) {
                @SerialName(value = "file") file("file");
                }
            /**
            * The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`.
            *
            * Values: assistants,assistants_output,batch,batch_output,fine_tune,fine_tune_results,vision
            */
            @Serializable
            enum class Purpose(val value: kotlin.String) {
                @SerialName(value = "assistants") assistants("assistants"),
                @SerialName(value = "assistants_output") assistants_output("assistants_output"),
                @SerialName(value = "batch") batch("batch"),
                @SerialName(value = "batch_output") batch_output("batch_output"),
                @SerialName(value = "fine-tune") fine_tune("fine-tune"),
                @SerialName(value = "fine-tune-results") fine_tune_results("fine-tune-results"),
                @SerialName(value = "vision") vision("vision");
                }
            /**
            * Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`.
            *
            * Values: uploaded,processed,error
            */
            @Serializable
            enum class Status(val value: kotlin.String) {
                @SerialName(value = "uploaded") uploaded("uploaded"),
                @SerialName(value = "processed") processed("processed"),
                @SerialName(value = "error") error("error");
                }
}