Partager via

RunStep Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Assistants
Assembly:
Azure.AI.OpenAI.Assistants.dll
Package:
Azure.AI.OpenAI.Assistants v1.0.0-beta.4
Source:
RunStep.cs

Detailed information about a single step of an assistant thread run.

public class RunStep : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.RunStep>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.RunStep>
type RunStep = class
    interface IJsonModel<RunStep>
    interface IPersistableModel<RunStep>
Public Class RunStep
Implements IJsonModel(Of RunStep), IPersistableModel(Of RunStep)
Inheritance
Object
RunStep
Implements
IJsonModel<RunStep> IPersistableModel<RunStep> IPersistableModel<T>

Properties

AssistantId

The ID of the assistant associated with the run step.
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.
ExpiredAt

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

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

The identifier, which can be referenced in API endpoints.
LastError

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

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
RunId

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

The status of this run step.
StepDetails

The details for this run step. Please note RunStepDetails is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RunStepMessageCreationDetails and RunStepToolCallDetails.
ThreadId

The ID of the thread that was run.
Type

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

Explicit Interface Implementations

IJsonModel<RunStep>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<RunStep>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<RunStep>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<RunStep>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<RunStep>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to