AIClientModelFactory.RunStep Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v1.0.0-beta.1

Source:

AIClientModelFactory.cs

Initializes a new instance of RunStep.

public static Azure.AI.Projects.RunStep RunStep (string id = default, Azure.AI.Projects.RunStepType type = default, string agentId = default, string threadId = default, string runId = default, Azure.AI.Projects.RunStepStatus status = default, Azure.AI.Projects.RunStepDetails stepDetails = default, Azure.AI.Projects.RunStepError lastError = default, DateTimeOffset createdAt = default, DateTimeOffset? expiredAt = default, DateTimeOffset? completedAt = default, DateTimeOffset? cancelledAt = default, DateTimeOffset? failedAt = default, Azure.AI.Projects.RunStepCompletionUsage usage = default, System.Collections.Generic.IReadOnlyDictionary<string,string> metadata = default);

static member RunStep : string * Azure.AI.Projects.RunStepType * string * string * string * Azure.AI.Projects.RunStepStatus * Azure.AI.Projects.RunStepDetails * Azure.AI.Projects.RunStepError * DateTimeOffset * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.AI.Projects.RunStepCompletionUsage * System.Collections.Generic.IReadOnlyDictionary<string, string> -> Azure.AI.Projects.RunStep

Public Shared Function RunStep (Optional id As String = Nothing, Optional type As RunStepType = Nothing, Optional agentId As String = Nothing, Optional threadId As String = Nothing, Optional runId As String = Nothing, Optional status As RunStepStatus = Nothing, Optional stepDetails As RunStepDetails = Nothing, Optional lastError As RunStepError = Nothing, Optional createdAt As DateTimeOffset = Nothing, Optional expiredAt As Nullable(Of DateTimeOffset) = Nothing, Optional completedAt As Nullable(Of DateTimeOffset) = Nothing, Optional cancelledAt As Nullable(Of DateTimeOffset) = Nothing, Optional failedAt As Nullable(Of DateTimeOffset) = Nothing, Optional usage As RunStepCompletionUsage = Nothing, Optional metadata As IReadOnlyDictionary(Of String, String) = Nothing) As RunStep

Parameters

id

String

The identifier, which can be referenced in API endpoints.

type

RunStepType

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

agentId

String

The ID of the agent associated with the run step.

threadId

String

The ID of the thread that was run.

runId

String

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

status

RunStepStatus

The status of this run step.

stepDetails

RunStepDetails

The details for this run step.

lastError

RunStepError

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

createdAt

DateTimeOffset

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

expiredAt

Nullable<DateTimeOffset>

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

completedAt

Nullable<DateTimeOffset>

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

cancelledAt

Nullable<DateTimeOffset>

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

failedAt

Nullable<DateTimeOffset>

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

usage

RunStepCompletionUsage

Usage statistics related to the run step.

metadata

IReadOnlyDictionary<String,String>

A set of key/value pairs that can be attached to an object, used for storing additional information.

Returns

RunStep

A new RunStep instance for mocking.