ThreadRun interface

Package:

@azure/openai-assistants

Data representing a single evaluation run of an assistant thread.

Properties

assistantId	The ID of the assistant associated with the thread this run was performed against.
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.
expiresAt	The Unix timestamp, in seconds, representing when this item expires.
failedAt	The Unix timestamp, in seconds, representing when this failed.
fileIds	A list of attached file IDs, ordered by creation date in ascending order.
id	The identifier, which can be referenced in API endpoints.
instructions	The overriden system instructions used for this assistant thread run.
lastError	The last error, if any, encountered by this assistant thread run.
metadata	A set of key/value pairs used to store additional information about the object.
model	The ID of the model to use.
requiredAction	The details of the action required for the assistant thread run to continue.
startedAt	The Unix timestamp, in seconds, representing when this item was started.
status	The status of the assistant thread run.
threadId	The ID of the thread associated with this run.
tools	The overriden enabled tools used for this assistant thread run.

Property Details

assistantId

The ID of the assistant associated with the thread this run was performed against.

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

expiresAt

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

expiresAt: null | Date

Property Value

null | Date

failedAt

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

failedAt: null | Date

Property Value

null | Date

fileIds

A list of attached file IDs, ordered by creation date in ascending order.

fileIds: string[]

Property Value

string[]

id

The identifier, which can be referenced in API endpoints.

id: string

Property Value

string

instructions

The overriden system instructions used for this assistant thread run.

instructions: string

Property Value

string

lastError

The last error, if any, encountered by this assistant thread run.

lastError?: null | RunError

Property Value

null | RunError

metadata

A set of key/value pairs used to store additional information about the object.

metadata?: null | Record<string, string>

Property Value

null | Record<string, string>

model

The ID of the model to use.

model: string

Property Value

string

requiredAction

The details of the action required for the assistant thread run to continue.

requiredAction?: null | RequiredAction

Property Value

null | RequiredAction

startedAt

The Unix timestamp, in seconds, representing when this item was started.

startedAt: null | Date

Property Value

null | Date

status

The status of the assistant thread run.

status: string

Property Value

string

threadId

The ID of the thread associated with this run.

threadId: string

Property Value

string

tools

The overriden enabled tools used for this assistant thread run.

tools: ToolDefinition[]

Property Value

ToolDefinition[]