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

There is a newer version: 0.0.5-alpha.118

/**
 *
 * 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 fileId The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose=\"vision\"` when uploading the File if you need to later display the file content.
    * @param detail Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.
*/
@Serializable


data class MessageContentImageFileObjectImageFile (
        /* The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose=\"vision\"` when uploading the File if you need to later display the file content. */
    @SerialName(value = "file_id") val fileId: kotlin.String,
        /* Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`. */
    @SerialName(value = "detail") val detail: MessageContentImageFileObjectImageFile.Detail? = Detail.auto
) {

            /**
            * Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.
            *
            * Values: auto,low,high
            */
            @Serializable
            enum class Detail(val value: kotlin.String) {
                @SerialName(value = "auto") auto("auto"),
                @SerialName(value = "low") low("low"),
                @SerialName(value = "high") high("high");
                }
}