RoutineRun Class

Definition

A single routine run returned from the run history API.

public class RoutineRun : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.RoutineRun>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.RoutineRun>
type RoutineRun = class
    interface IJsonModel<RoutineRun>
    interface IPersistableModel<RoutineRun>
Public Class RoutineRun
Implements IJsonModel(Of RoutineRun), IPersistableModel(Of RoutineRun)
Inheritance
RoutineRun
Implements

Properties

Name Description
ActionCorrelationId

The downstream action correlation identifier, when available.

ActionType

The action type dispatched for the routine attempt.

AgentEndpointId

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

AgentId

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

AttemptSource

The source path that created the routine attempt.

ConversationId

The conversation identifier used by a responses API dispatch.

DispatchId

The dispatch identifier associated with the routine attempt.

EndedAt

The time when the underlying run reached a terminal state.

ErrorMessage

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

ErrorStatusCode

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

ErrorType

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.

ResponseId

The downstream response or invocation identifier, when available.

ScheduledFireAt

The scheduled fire time recorded for timer and schedule deliveries.

SessionId

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

StartedAt

The time when the underlying run started.

Status

The run status.

TaskId

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

TriggeredAt

The logical trigger time recorded for the routine attempt.

TriggerName

The configured trigger name that produced the routine attempt.

TriggerType

The trigger type that produced the routine attempt.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<RoutineRun>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<RoutineRun>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<RoutineRun>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<RoutineRun>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<RoutineRun>.Write(ModelReaderWriterOptions)

Applies to