RoutineRun interface

Package:

@azure/ai-projects

A single routine run returned from the run history API.

Properties

action_correlation_id	The downstream action correlation identifier, when available.
action_type	The action type dispatched for the routine attempt.
agent_endpoint_id	The legacy endpoint-scoped agent identifier recorded for the routine attempt.
agent_id	The project-scoped agent identifier recorded for the routine attempt.
attempt_source	The source path that created the routine attempt.
conversation_id	The conversation identifier used by a responses API dispatch.
dispatch_id	The dispatch identifier associated with the routine attempt.
ended_at	The time when the underlying run reached a terminal state.
error_message	The truncated failure message captured for a failed attempt, when available.
error_status_code	The downstream error status code captured for a failed attempt, when available.
error_type	The fully qualified error type captured for a failed attempt, when available.
id	The unique run identifier for the routine attempt.
phase	The AgentExtensions lifecycle phase for the routine attempt.
response_id	The downstream response or invocation identifier, when available.
scheduled_fire_at	The scheduled fire time recorded for timer and schedule deliveries.
session_id	The hosted-agent session identifier used by an invocations API dispatch.
started_at	The time when the underlying run started.
status	The run status.
task_id	The workspace task identifier linked to the routine attempt, when available.
triggered_at	The logical trigger time recorded for the routine attempt.
trigger_name	The configured trigger name that produced the routine attempt.
trigger_type	The trigger type that produced the routine attempt.

Property Details

action_correlation_id

The downstream action correlation identifier, when available.

action_correlation_id?: string

Property Value

string

action_type

The action type dispatched for the routine attempt.

action_type?: RoutineActionType

Property Value

RoutineActionType

agent_endpoint_id

The legacy endpoint-scoped agent identifier recorded for the routine attempt.

agent_endpoint_id?: string

Property Value

string

agent_id

The project-scoped agent identifier recorded for the routine attempt.

agent_id?: string

Property Value

string

attempt_source

The source path that created the routine attempt.

attempt_source?: RoutineAttemptSource

Property Value

RoutineAttemptSource

conversation_id

The conversation identifier used by a responses API dispatch.

conversation_id?: string

Property Value

string

dispatch_id

The dispatch identifier associated with the routine attempt.

dispatch_id?: string

Property Value

string

ended_at

The time when the underlying run reached a terminal state.

ended_at?: Date

Property Value

Date

error_message

The truncated failure message captured for a failed attempt, when available.

error_message?: string

Property Value

string

error_status_code

The downstream error status code captured for a failed attempt, when available.

error_status_code?: number

Property Value

number

error_type

The fully qualified error type captured for a failed attempt, when available.

error_type?: string

Property Value

string

id

The unique run identifier for the routine attempt.

id: string

Property Value

string

phase

The AgentExtensions lifecycle phase for the routine attempt.

phase?: RoutineRunPhase

Property Value

RoutineRunPhase

response_id

The downstream response or invocation identifier, when available.

response_id?: string

Property Value

string

scheduled_fire_at

The scheduled fire time recorded for timer and schedule deliveries.

scheduled_fire_at?: Date

Property Value

Date

session_id

The hosted-agent session identifier used by an invocations API dispatch.

session_id?: string

Property Value

string

started_at

The time when the underlying run started.

started_at?: Date

Property Value

Date

status

The run status.

status?: string

Property Value

string

task_id

The workspace task identifier linked to the routine attempt, when available.

task_id?: string

Property Value

string

triggered_at

The logical trigger time recorded for the routine attempt.

triggered_at?: Date

Property Value

Date

trigger_name

The configured trigger name that produced the routine attempt.

trigger_name?: string

Property Value

string

trigger_type

The trigger type that produced the routine attempt.

trigger_type?: RoutineTriggerType

Property Value

RoutineTriggerType