Table of Contents

Class RunStepResponse

Namespace
OpenAI.Threads
Assembly
OpenAI-DotNet.dll

A detailed list of steps the Assistant took as part of a Run. An Assistant can call tools or create Messages during it's run. Examining Run Steps allows you to introspect how the Assistant is getting to it's final results.

public sealed class RunStepResponse : BaseResponse, IServerSentEvent
Inheritance
RunStepResponse
Implements
Inherited Members
Extension Methods

Constructors

RunStepResponse() 

public RunStepResponse()

Properties

AssistantId

The ID of the assistant associated with the run step.

[JsonInclude]
[JsonPropertyName("assistant_id")]
public string AssistantId { get; }

Property Value

string

CancelledAt 

[JsonIgnore]
public DateTime? CancelledAt { get; }

Property Value

DateTime?

CancelledAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run step was cancelled.

[JsonInclude]
[JsonPropertyName("cancelled_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? CancelledAtUnixTimeSeconds { get; }

Property Value

int?

CompletedAt 

[JsonIgnore]
public DateTime? CompletedAt { get; }

Property Value

DateTime?

CompletedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run step completed.

[JsonInclude]
[JsonPropertyName("completed_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? CompletedAtUnixTimeSeconds { get; }

Property Value

int?

CreatedAt 

[JsonIgnore]
public DateTime? CreatedAt { get; }

Property Value

DateTime?

CreatedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run step was created.

[JsonInclude]
[JsonPropertyName("created_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? CreatedAtUnixTimeSeconds { get; }

Property Value

int?

Delta 

[JsonInclude]
[JsonPropertyName("delta")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public RunStepDelta Delta { get; }

Property Value

RunStepDelta

ExpiredAt 

[JsonIgnore]
public DateTime? ExpiredAt { get; }

Property Value

DateTime?

ExpiredAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.

[JsonInclude]
[JsonPropertyName("expired_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? ExpiredAtUnixTimeSeconds { get; }

Property Value

int?

ExpiresAt 

[JsonIgnore]
[Obsolete("Use ExpiredAt")]
public DateTime? ExpiresAt { get; }

Property Value

DateTime?

ExpiresAtUnitTimeSeconds 

[JsonIgnore]
[Obsolete("use ExpiredAtUnixTimeSeconds")]
public int? ExpiresAtUnitTimeSeconds { get; }

Property Value

int?

FailedAt 

[JsonIgnore]
public DateTime? FailedAt { get; }

Property Value

DateTime?

FailedAtUnixTimeSeconds

The Unix timestamp (in seconds) for when the run step failed.

[JsonInclude]
[JsonPropertyName("failed_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? FailedAtUnixTimeSeconds { get; }

Property Value

int?

Id

The identifier of the run step, which can be referenced in API endpoints.

[JsonInclude]
[JsonPropertyName("id")]
public string Id { get; }

Property Value

string

LastError

The last error associated with this run step. Will be null if there are no errors.

[JsonInclude]
[JsonPropertyName("last_error")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Error LastError { get; }

Property Value

Error

Metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

[JsonInclude]
[JsonPropertyName("metadata")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public IReadOnlyDictionary<string, string> Metadata { get; }

Property Value

IReadOnlyDictionary<string, string>

Object 

[JsonInclude]
[JsonPropertyName("object")]
public string Object { get; }

Property Value

string

RunId

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

[JsonInclude]
[JsonPropertyName("run_id")]
public string RunId { get; }

Property Value

string

Status

The status of the run step.

[JsonInclude]
[JsonPropertyName("status")]
[JsonConverter(typeof(JsonStringEnumConverter<RunStatus>))]
public RunStatus Status { get; }

Property Value

RunStatus

StepDetails

The details of the run step.

[JsonInclude]
[JsonPropertyName("step_details")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public StepDetails StepDetails { get; }

Property Value

StepDetails

ThreadId

The ID of the thread that was run.

[JsonInclude]
[JsonPropertyName("thread_id")]
public string ThreadId { get; }

Property Value

string

Type

The type of run step.

[JsonInclude]
[JsonPropertyName("type")]
[JsonConverter(typeof(JsonStringEnumConverter<RunStepType>))]
public RunStepType Type { get; }

Property Value

RunStepType

Usage

Usage statistics related to the run step. This value will be null while the run step's status is in_progress.

[JsonInclude]
[JsonPropertyName("usage")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Usage Usage { get; }

Property Value

Usage

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator string(RunStepResponse) 

public static implicit operator string(RunStepResponse runStep)

Parameters

runStep RunStepResponse

Returns

string
Edit this page