commonMain.com.xebia.functional.openai.generated.model.RunObject.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.AssistantObjectToolsInner
import com.xebia.functional.openai.generated.model.AssistantsApiResponseFormatOption
import com.xebia.functional.openai.generated.model.AssistantsApiToolChoiceOption
import com.xebia.functional.openai.generated.model.RunCompletionUsage
import com.xebia.functional.openai.generated.model.RunObjectIncompleteDetails
import com.xebia.functional.openai.generated.model.RunObjectLastError
import com.xebia.functional.openai.generated.model.RunObjectRequiredAction
import com.xebia.functional.openai.generated.model.TruncationObject



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

/**
* Represents an execution run on a [thread](/docs/api-reference/threads).
*
    * @param id The identifier, which can be referenced in API endpoints.
    * @param `object` The object type, which is always `thread.run`.
    * @param createdAt The Unix timestamp (in seconds) for when the run was created.
    * @param threadId The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.
    * @param assistantId The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run.
    * @param status The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.
    * @param requiredAction 
    * @param lastError 
    * @param expiresAt The Unix timestamp (in seconds) for when the run will expire.
    * @param startedAt The Unix timestamp (in seconds) for when the run was started.
    * @param cancelledAt The Unix timestamp (in seconds) for when the run was cancelled.
    * @param failedAt The Unix timestamp (in seconds) for when the run failed.
    * @param completedAt The Unix timestamp (in seconds) for when the run was completed.
    * @param incompleteDetails 
    * @param model The model that the [assistant](/docs/api-reference/assistants) used for this run.
    * @param instructions The instructions that the [assistant](/docs/api-reference/assistants) used for this run.
    * @param tools The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.
    * @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. 
    * @param usage 
    * @param maxPromptTokens The maximum number of prompt tokens specified to have been used over the course of the run. 
    * @param maxCompletionTokens The maximum number of completion tokens specified to have been used over the course of the run. 
    * @param truncationStrategy 
    * @param toolChoice 
    * @param parallelToolCalls Whether to enable [parallel function calling](/docs/guides/function-calling/parallel-function-calling) during tool use.
    * @param responseFormat 
    * @param temperature The sampling temperature used for this run. If not set, defaults to 1.
    * @param topP The nucleus sampling value used for this run. If not set, defaults to 1.
*/
@Serializable


data class RunObject (
        /* The identifier, which can be referenced in API endpoints. */
    @SerialName(value = "id") val id: kotlin.String,
        /* The object type, which is always `thread.run`. */
    @SerialName(value = "object") val `object`: RunObject.`Object`,
        /* The Unix timestamp (in seconds) for when the run was created. */
    @SerialName(value = "created_at") val createdAt: kotlin.Int,
        /* The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run. */
    @SerialName(value = "thread_id") val threadId: kotlin.String,
        /* The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run. */
    @SerialName(value = "assistant_id") val assistantId: kotlin.String,
        /* The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`. */
    @SerialName(value = "status") val status: RunObject.Status,
        @SerialName(value = "required_action") val requiredAction: RunObjectRequiredAction? = null,
        @SerialName(value = "last_error") val lastError: RunObjectLastError?,
        /* The Unix timestamp (in seconds) for when the run will expire. */
    @SerialName(value = "expires_at") val expiresAt: kotlin.Int? = null,
        /* The Unix timestamp (in seconds) for when the run was started. */
    @SerialName(value = "started_at") val startedAt: kotlin.Int?,
        /* The Unix timestamp (in seconds) for when the run was cancelled. */
    @SerialName(value = "cancelled_at") val cancelledAt: kotlin.Int?,
        /* The Unix timestamp (in seconds) for when the run failed. */
    @SerialName(value = "failed_at") val failedAt: kotlin.Int?,
        /* The Unix timestamp (in seconds) for when the run was completed. */
    @SerialName(value = "completed_at") val completedAt: kotlin.Int?,
        @SerialName(value = "incomplete_details") val incompleteDetails: RunObjectIncompleteDetails?,
        /* The model that the [assistant](/docs/api-reference/assistants) used for this run. */
    @SerialName(value = "model") val model: kotlin.String,
        /* The instructions that the [assistant](/docs/api-reference/assistants) used for this run. */
    @SerialName(value = "instructions") val instructions: kotlin.String,
        /* The list of tools that the [assistant](/docs/api-reference/assistants) used for this run. */
    @SerialName(value = "tools") val tools: kotlin.collections.List = arrayListOf(),
        /* 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?,
        @SerialName(value = "usage") val usage: RunCompletionUsage?,
        /* The maximum number of prompt tokens specified to have been used over the course of the run.  */
    @SerialName(value = "max_prompt_tokens") val maxPromptTokens: kotlin.Int?,
        /* The maximum number of completion tokens specified to have been used over the course of the run.  */
    @SerialName(value = "max_completion_tokens") val maxCompletionTokens: kotlin.Int?,
        @SerialName(value = "truncation_strategy") val truncationStrategy: TruncationObject,
        @SerialName(value = "tool_choice") val toolChoice: AssistantsApiToolChoiceOption,
        /* Whether to enable [parallel function calling](/docs/guides/function-calling/parallel-function-calling) during tool use. */
    @SerialName(value = "parallel_tool_calls") val parallelToolCalls: kotlin.Boolean = true,
        @SerialName(value = "response_format") val responseFormat: AssistantsApiResponseFormatOption,
        /* The sampling temperature used for this run. If not set, defaults to 1. */
    @SerialName(value = "temperature") val temperature: kotlin.Double? = null,
        /* The nucleus sampling value used for this run. If not set, defaults to 1. */
    @SerialName(value = "top_p") val topP: kotlin.Double? = null
) {

            /**
            * The object type, which is always `thread.run`.
            *
            * Values: thread_run
            */
            @Serializable
            enum class `Object`(val value: kotlin.String) {
                @SerialName(value = "thread.run") thread_run("thread.run");
                }
            /**
            * The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, `incomplete`, or `expired`.
            *
            * Values: queued,in_progress,requires_action,cancelling,cancelled,failed,completed,incomplete,expired
            */
            @Serializable
            enum class Status(val value: kotlin.String) {
                @SerialName(value = "queued") queued("queued"),
                @SerialName(value = "in_progress") in_progress("in_progress"),
                @SerialName(value = "requires_action") requires_action("requires_action"),
                @SerialName(value = "cancelling") cancelling("cancelling"),
                @SerialName(value = "cancelled") cancelled("cancelled"),
                @SerialName(value = "failed") failed("failed"),
                @SerialName(value = "completed") completed("completed"),
                @SerialName(value = "incomplete") incomplete("incomplete"),
                @SerialName(value = "expired") expired("expired");
                }
}