commonMain.com.xebia.functional.openai.generated.model.CreateCompletionResponse.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.CompletionUsage
import com.xebia.functional.openai.generated.model.CreateCompletionResponseChoicesInner



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

/**
* Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint). 
*
    * @param id A unique identifier for the completion.
    * @param choices The list of completion choices the model generated for the input prompt.
    * @param created The Unix timestamp (in seconds) of when the completion was created.
    * @param model The model used for completion.
    * @param `object` The object type, which is always \"text_completion\"
    * @param systemFingerprint This fingerprint represents the backend configuration that the model runs with.  Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. 
    * @param usage 
*/
@Serializable


data class CreateCompletionResponse (
        /* A unique identifier for the completion. */
    @SerialName(value = "id") val id: kotlin.String,
        /* The list of completion choices the model generated for the input prompt. */
    @SerialName(value = "choices") val choices: kotlin.collections.List,
        /* The Unix timestamp (in seconds) of when the completion was created. */
    @SerialName(value = "created") val created: kotlin.Int,
        /* The model used for completion. */
    @SerialName(value = "model") val model: kotlin.String,
        /* The object type, which is always \"text_completion\" */
    @SerialName(value = "object") val `object`: CreateCompletionResponse.`Object`,
        /* This fingerprint represents the backend configuration that the model runs with.  Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.  */
    @SerialName(value = "system_fingerprint") val systemFingerprint: kotlin.String? = null,
        @SerialName(value = "usage") val usage: CompletionUsage? = null
) {

            /**
            * The object type, which is always \"text_completion\"
            *
            * Values: text_completion
            */
            @Serializable
            enum class `Object`(val value: kotlin.String) {
                @SerialName(value = "text_completion") text_completion("text_completion");
                }
}