openai-core/com.aallam.openai.api.run/MessageCreationStep

MessageCreationStep

@Serializable

data class MessageCreationStep(val id: RunStepId, val createdAt: Int, val assistantId: AssistantId, val threadId: ThreadId, val runId: RunId, val status: Status, val stepDetails: MessageCreationStepDetails, val lastError: LastError? = null, val expiredAt: Int? = null, val cancelledAt: Int? = null, val failedAt: Int? = null, val completedAt: Int? = null, val metadata: Map<String, String>? = null) : RunStep

Constructors

MessageCreationStep

constructor(id: RunStepId, createdAt: Int, assistantId: AssistantId, threadId: ThreadId, runId: RunId, status: Status, stepDetails: MessageCreationStepDetails, lastError: LastError? = null, expiredAt: Int? = null, cancelledAt: Int? = null, failedAt: Int? = null, completedAt: Int? = null, metadata: Map<String, String>? = null)

Properties

assistantId

open override val assistantId: AssistantId

The ID of the assistant associated with the run step.

cancelledAt

open override val cancelledAt: Int? = null

The Unix timestamp (in seconds) for when the run step was Status.Cancelled.

completedAt

open override val completedAt: Int? = null

The Unix timestamp (in seconds) for when the run step completed.

createdAt

open override val createdAt: Int

The Unix timestamp (in seconds) for when the run step was created.

expiredAt

open override val expiredAt: Int? = null

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

failedAt

open override val failedAt: Int? = null

The Unix timestamp (in seconds) for when the run step failed.

open override val id: RunStepId

The identifier of the run step, which can be referenced in API endpoints.

lastError

open override val lastError: LastError? = null

The last error associated with this run step. Will be null if there are no errors.

metadata

open override val metadata: Map<String, String>? = 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 maximum of 512 characters long.

runId

open override val runId: RunId

The ID of the run that this run step is a part of.

status

open override val status: Status

The status of the run step, which can be either Status.InProgress, Status.Cancelled, Status.Failed, Status.Completed, or Status.Expired.

stepDetails

open override val stepDetails: MessageCreationStepDetails

The details of the run step.

threadId

open override val threadId: ThreadId

The ID of the thread that was run.