RunStep interface

Package:

@azure/openai-assistants

Detailed information about a single step of an assistant thread run.

Properties

assistantId	The ID of the assistant associated with the run step.
cancelledAt	The Unix timestamp, in seconds, representing when this was cancelled.
completedAt	The Unix timestamp, in seconds, representing when this completed.
createdAt	The Unix timestamp, in seconds, representing when this object was created.
expiredAt	The Unix timestamp, in seconds, representing when this item expired.
failedAt	The Unix timestamp, in seconds, representing when this failed.
id	The identifier, which can be referenced in API endpoints.
lastError	If applicable, information about the last error encountered by this run step.
metadata	A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
runId	The ID of the run that this run step is a part of.
status	The status of this run step.
stepDetails	The details for this run step.
threadId	The ID of the thread that was run.
type	The type of run step, which can be either message_creation or tool_calls.

Property Details

assistantId

The ID of the assistant associated with the run step.

assistantId: string

Property Value

string

cancelledAt

The Unix timestamp, in seconds, representing when this was cancelled.

cancelledAt: null | Date

Property Value

null | Date

completedAt

The Unix timestamp, in seconds, representing when this completed.

completedAt: null | Date

Property Value

null | Date

createdAt

The Unix timestamp, in seconds, representing when this object was created.

createdAt: Date

Property Value

Date

expiredAt

The Unix timestamp, in seconds, representing when this item expired.

expiredAt: null | Date

Property Value

null | Date

failedAt

The Unix timestamp, in seconds, representing when this failed.

failedAt: null | Date

Property Value

null | Date

id

The identifier, which can be referenced in API endpoints.

id: string

Property Value

string

lastError

If applicable, information about the last error encountered by this run step.

lastError: null | RunStepError

Property Value

null | RunStepError

metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

metadata?: null | Record<string, string>

Property Value

null | Record<string, string>

runId

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

runId: string

Property Value

string

status

The status of this run step.

status: string

Property Value

string

stepDetails

The details for this run step.

stepDetails: RunStepDetails

Property Value

RunStepDetails

threadId

The ID of the thread that was run.

threadId: string

Property Value

string

type

The type of run step, which can be either message_creation or tool_calls.

type: string

Property Value

string