ThreadRunStep class

Represents a step in execution of a run. https://platform.openai.com/docs/api-reference/runs/step-object

Annotations
  • @freezed

Constructors

ThreadRunStep({required String id, @Default('thread.run.step') String object, required int createdAt, required String assistantId, required String threadId, required String runId, required String type, required String status, required StepDetails stepDetails, String? lastError, int? expiredAt, int? cancelledAt, int? failedAt, int? completedAt, @Default({}) Map<String, dynamic> metadata})
const
factory
ThreadRunStep.fromJson(Map<String, dynamic> json)
factory

Properties

assistantId → String
The ID of the assistant associated with the run step.
no setterinherited
cancelledAt → int?
The Unix timestamp (in seconds) for when the run step was cancelled.
no setterinherited
completedAt → int?
The Unix timestamp (in seconds) for when the run step completed.
no setterinherited
copyWith → $ThreadRunStepCopyWith<ThreadRunStep>
no setterinherited
createdAt → int
The Unix timestamp (in seconds) for when the run step was created.
no setterinherited
expiredAt → int?
The Unix timestamp (in seconds) for when the run step expired.
no setterinherited
failedAt → int?
The Unix timestamp (in seconds) for when the run step failed.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
The identifier of the run step, which can be referenced in API endpoints.
no setterinherited
lastError → String?
The last error associated with this run step. Will be null if there are no errors.
no setterinherited
metadata → Map<String, dynamic>
A set of 16 key-value pairs that can be attached to the object. 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.
no setterinherited
object → String
The object type, which is always thread.run.step.
no setterinherited
runId → String
The ID of the run that this run step is a part of.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → String
The status of the run step, which can be either in_progress, cancelled, failed, completed, or expired.
no setterinherited
stepDetails → StepDetails
The details of the run step.
no setterinherited
threadId → String
The ID of the thread that was run.
no setterinherited
type → String
The type of run step, which can be either message_creation or tool_calls.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited