AzureAIProjectsModelFactory.RoutineRun Method

Definition

A single routine run returned from the run history API.

public static Azure.AI.Projects.RoutineRun RoutineRun(string id = default, BinaryData statusInternal = default, Azure.AI.Projects.RoutineRunPhase? phase = default, Azure.AI.Projects.RoutineTriggerKind? triggerType = default, string triggerName = default, System.Collections.Generic.IDictionary<string,BinaryData> triggerEventPayload = default, Azure.AI.Projects.RoutineAttemptSource? attemptSource = default, Azure.AI.Projects.RoutineActionKind? actionType = default, string agentId = default, string agentEndpointId = default, string conversationId = default, string sessionId = default, DateTimeOffset? triggeredAt = default, DateTimeOffset? scheduledFireAt = default, DateTimeOffset? startedAt = default, DateTimeOffset? endedAt = default, string dispatchId = default, string actionCorrelationId = default, string responseId = default, string taskId = default, int? errorStatusCode = default, string errorType = default, string errorMessage = default);
static member RoutineRun : string * BinaryData * Nullable<Azure.AI.Projects.RoutineRunPhase> * Nullable<Azure.AI.Projects.RoutineTriggerKind> * string * System.Collections.Generic.IDictionary<string, BinaryData> * Nullable<Azure.AI.Projects.RoutineAttemptSource> * Nullable<Azure.AI.Projects.RoutineActionKind> * string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * string * string * string * string * Nullable<int> * string * string -> Azure.AI.Projects.RoutineRun
Public Shared Function RoutineRun (Optional id As String = Nothing, Optional statusInternal As BinaryData = Nothing, Optional phase As Nullable(Of RoutineRunPhase) = Nothing, Optional triggerType As Nullable(Of RoutineTriggerKind) = Nothing, Optional triggerName As String = Nothing, Optional triggerEventPayload As IDictionary(Of String, BinaryData) = Nothing, Optional attemptSource As Nullable(Of RoutineAttemptSource) = Nothing, Optional actionType As Nullable(Of RoutineActionKind) = Nothing, Optional agentId As String = Nothing, Optional agentEndpointId As String = Nothing, Optional conversationId As String = Nothing, Optional sessionId As String = Nothing, Optional triggeredAt As Nullable(Of DateTimeOffset) = Nothing, Optional scheduledFireAt As Nullable(Of DateTimeOffset) = Nothing, Optional startedAt As Nullable(Of DateTimeOffset) = Nothing, Optional endedAt As Nullable(Of DateTimeOffset) = Nothing, Optional dispatchId As String = Nothing, Optional actionCorrelationId As String = Nothing, Optional responseId As String = Nothing, Optional taskId As String = Nothing, Optional errorStatusCode As Nullable(Of Integer) = Nothing, Optional errorType As String = Nothing, Optional errorMessage As String = Nothing) As RoutineRun

Parameters

id
String

The unique run identifier for the routine attempt.

statusInternal
BinaryData

The run status.

phase
Nullable<RoutineRunPhase>

The AgentExtensions lifecycle phase for the routine attempt.

triggerType
Nullable<RoutineTriggerKind>

The trigger type that produced the routine attempt.

triggerName
String

The configured trigger name that produced the routine attempt.

triggerEventPayload
IDictionary<String,BinaryData>

The event payload captured from the event that triggered the routine attempt, when available.

attemptSource
Nullable<RoutineAttemptSource>

The source path that created the routine attempt.

actionType
Nullable<RoutineActionKind>

The action type dispatched for the routine attempt.

agentId
String

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

agentEndpointId
String

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

conversationId
String

The conversation identifier used by a responses API dispatch.

sessionId
String

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

triggeredAt
Nullable<DateTimeOffset>

The logical trigger time recorded for the routine attempt.

scheduledFireAt
Nullable<DateTimeOffset>

The scheduled fire time recorded for timer and schedule deliveries.

startedAt
Nullable<DateTimeOffset>

The time when the underlying run started.

endedAt
Nullable<DateTimeOffset>

The time when the underlying run reached a terminal state.

dispatchId
String

The dispatch identifier associated with the routine attempt.

actionCorrelationId
String

The downstream action correlation identifier, when available.

responseId
String

The downstream response or invocation identifier, when available.

taskId
String

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

errorStatusCode
Nullable<Int32>

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

errorType
String

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

errorMessage
String

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

Returns

A new RoutineRun instance for mocking.

Applies to