commonMain.com.xebia.functional.openai.generated.model.CreateMessageRequest.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.CreateMessageRequestContent
import com.xebia.functional.openai.generated.model.MessageObjectAttachmentsInner



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

/**
* 
*
    * @param role The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. 
    * @param content 
    * @param attachments A list of files attached to the message, and the tools they should be added to.
    * @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 CreateMessageRequest (
        /* The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.  */
    @SerialName(value = "role") val role: CreateMessageRequest.Role,
        @SerialName(value = "content") val content: CreateMessageRequestContent,
        /* A list of files attached to the message, and the tools they should be added to. */
    @SerialName(value = "attachments") val attachments: kotlin.collections.List? = 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 role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. 
            *
            * Values: user,assistant
            */
            @Serializable
            enum class Role(val value: kotlin.String) {
                @SerialName(value = "user") user("user"),
                @SerialName(value = "assistant") assistant("assistant");
                }
}