commonMain.com.xebia.functional.openai.generated.model.CreateUploadRequest.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.*

/**
* 
*
    * @param filename The name of the file to upload. 
    * @param purpose The intended purpose of the uploaded file.  See the [documentation on File purposes](/docs/api-reference/files/create#files-create-purpose). 
    * @param bytes The number of bytes in the file you are uploading. 
    * @param mimeType The MIME type of the file.  This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision. 
*/
@Serializable


data class CreateUploadRequest (
        /* The name of the file to upload.  */
    @SerialName(value = "filename") val filename: kotlin.String,
        /* The intended purpose of the uploaded file.  See the [documentation on File purposes](/docs/api-reference/files/create#files-create-purpose).  */
    @SerialName(value = "purpose") val purpose: CreateUploadRequest.Purpose,
        /* The number of bytes in the file you are uploading.  */
    @SerialName(value = "bytes") val bytes: kotlin.Int,
        /* The MIME type of the file.  This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.  */
    @SerialName(value = "mime_type") val mimeType: kotlin.String
) {

            /**
            * The intended purpose of the uploaded file.  See the [documentation on File purposes](/docs/api-reference/files/create#files-create-purpose). 
            *
            * Values: assistants,batch,fine_tune,vision
            */
            @Serializable
            enum class Purpose(val value: kotlin.String) {
                @SerialName(value = "assistants") assistants("assistants"),
                @SerialName(value = "batch") batch("batch"),
                @SerialName(value = "fine-tune") fine_tune("fine-tune"),
                @SerialName(value = "vision") vision("vision");
                }
}