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

MessageCreationStep

@Serializable
@SerialName(value = "message_creation")
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

Link copied to clipboard
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

Link copied to clipboard
@SerialName(value = "assistant_id")
open override val assistantId: AssistantId

The ID of the assistant associated with the run step.

Link copied to clipboard
@SerialName(value = "cancelled_at")
open override val cancelledAt: Int? = null

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

Link copied to clipboard
@SerialName(value = "completed_at")
open override val completedAt: Int? = null

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

Link copied to clipboard
@SerialName(value = "created_at")
open override val createdAt: Int

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

Link copied to clipboard
@SerialName(value = "expired_at")
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.

Link copied to clipboard
@SerialName(value = "failed_at")
open override val failedAt: Int? = null

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

Link copied to clipboard
@SerialName(value = "id")
open override val id: RunStepId

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

Link copied to clipboard
@SerialName(value = "last_error")
open override val lastError: LastError? = null

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

Link copied to clipboard
@SerialName(value = "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.

Link copied to clipboard
@SerialName(value = "run_id")
open override val runId: RunId

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

Link copied to clipboard
@SerialName(value = "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.

Link copied to clipboard
@SerialName(value = "step_details")
open override val stepDetails: MessageCreationStepDetails

The details of the run step.

Link copied to clipboard
@SerialName(value = "thread_id")
open override val threadId: ThreadId

The ID of the thread that was run.