Class RunStep
-
- All Implemented Interfaces:
public final class RunStep
Represents a step in execution of a run.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
RunStep.Builder
public final class
RunStep.LastError
The last error associated with this run step. Will be
null
if there are no errors.public final class
RunStep.Object
The object type, which is always
thread.run.step
.public final class
RunStep.Status
The status of the run step, which can be either
in_progress
,cancelled
,failed
,completed
, orexpired
.public final class
RunStep.StepDetails
The details of the run step.
public final class
RunStep.Type
The type of run step, which can be either
message_creation
ortool_calls
.public final class
RunStep.Usage
Usage statistics related to the run step. This value will be
null
while the run step's status isin_progress
.
-
Method Summary
Modifier and Type Method Description final String
id()
The identifier of the run step, which can be referenced in API endpoints. final String
assistantId()
The ID of the assistant associated with the run step. final Optional<Long>
cancelledAt()
The Unix timestamp (in seconds) for when the run step was cancelled. final Optional<Long>
completedAt()
The Unix timestamp (in seconds) for when the run step completed. final Long
createdAt()
The Unix timestamp (in seconds) for when the run step was created. final Optional<Long>
expiredAt()
The Unix timestamp (in seconds) for when the run step expired. final Optional<Long>
failedAt()
The Unix timestamp (in seconds) for when the run step failed. final Optional<RunStep.LastError>
lastError()
The last error associated with this run step. final JsonValue
_metadata()
Set of 16 key-value pairs that can be attached to an object. final RunStep.Object
object_()
The object type, which is always thread.run.step
.final String
runId()
The ID of the run that this run step is a part of. final RunStep.Status
status()
The status of the run step, which can be either in_progress
,cancelled
,failed
,completed
, orexpired
.final RunStep.StepDetails
stepDetails()
The details of the run step. final String
threadId()
The ID of the thread that was run. final RunStep.Type
type()
The type of run step, which can be either message_creation
ortool_calls
.final Optional<RunStep.Usage>
usage()
Usage statistics related to the run step. final JsonField<String>
_id()
The identifier of the run step, which can be referenced in API endpoints. final JsonField<String>
_assistantId()
The ID of the assistant associated with the run step. final JsonField<Long>
_cancelledAt()
The Unix timestamp (in seconds) for when the run step was cancelled. final JsonField<Long>
_completedAt()
The Unix timestamp (in seconds) for when the run step completed. final JsonField<Long>
_createdAt()
The Unix timestamp (in seconds) for when the run step was created. final JsonField<Long>
_expiredAt()
The Unix timestamp (in seconds) for when the run step expired. final JsonField<Long>
_failedAt()
The Unix timestamp (in seconds) for when the run step failed. final JsonField<RunStep.LastError>
_lastError()
The last error associated with this run step. final JsonField<RunStep.Object>
_object_()
The object type, which is always thread.run.step
.final JsonField<String>
_runId()
The ID of the run that this run step is a part of. final JsonField<RunStep.Status>
_status()
The status of the run step, which can be either in_progress
,cancelled
,failed
,completed
, orexpired
.final JsonField<RunStep.StepDetails>
_stepDetails()
The details of the run step. final JsonField<String>
_threadId()
The ID of the thread that was run. final JsonField<RunStep.Type>
_type()
The type of run step, which can be either message_creation
ortool_calls
.final JsonField<RunStep.Usage>
_usage()
Usage statistics related to the run step. final Map<String, JsonValue>
_additionalProperties()
final RunStep
validate()
final RunStep.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RunStep.Builder
builder()
-
-
Method Detail
-
assistantId
final String assistantId()
The ID of the assistant associated with the run step.
-
cancelledAt
final Optional<Long> cancelledAt()
The Unix timestamp (in seconds) for when the run step was cancelled.
-
completedAt
final Optional<Long> completedAt()
The Unix timestamp (in seconds) for when the run step completed.
-
expiredAt
final Optional<Long> expiredAt()
The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
-
failedAt
final Optional<Long> failedAt()
The Unix timestamp (in seconds) for when the run step failed.
-
lastError
final Optional<RunStep.LastError> lastError()
The last error associated with this run step. Will be
null
if there are no errors.
-
_metadata
final JsonValue _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.
-
object_
final RunStep.Object object_()
The object type, which is always
thread.run.step
.
-
status
final RunStep.Status status()
The status of the run step, which can be either
in_progress
,cancelled
,failed
,completed
, orexpired
.
-
stepDetails
final RunStep.StepDetails stepDetails()
The details of the run step.
-
type
final RunStep.Type type()
The type of run step, which can be either
message_creation
ortool_calls
.
-
usage
final Optional<RunStep.Usage> usage()
Usage statistics related to the run step. This value will be
null
while the run step's status isin_progress
.
-
_id
final JsonField<String> _id()
The identifier of the run step, which can be referenced in API endpoints.
-
_assistantId
final JsonField<String> _assistantId()
The ID of the assistant associated with the run step.
-
_cancelledAt
final JsonField<Long> _cancelledAt()
The Unix timestamp (in seconds) for when the run step was cancelled.
-
_completedAt
final JsonField<Long> _completedAt()
The Unix timestamp (in seconds) for when the run step completed.
-
_createdAt
final JsonField<Long> _createdAt()
The Unix timestamp (in seconds) for when the run step was created.
-
_expiredAt
final JsonField<Long> _expiredAt()
The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.
-
_failedAt
final JsonField<Long> _failedAt()
The Unix timestamp (in seconds) for when the run step failed.
-
_lastError
final JsonField<RunStep.LastError> _lastError()
The last error associated with this run step. Will be
null
if there are no errors.
-
_object_
final JsonField<RunStep.Object> _object_()
The object type, which is always
thread.run.step
.
-
_status
final JsonField<RunStep.Status> _status()
The status of the run step, which can be either
in_progress
,cancelled
,failed
,completed
, orexpired
.
-
_stepDetails
final JsonField<RunStep.StepDetails> _stepDetails()
The details of the run step.
-
_type
final JsonField<RunStep.Type> _type()
The type of run step, which can be either
message_creation
ortool_calls
.
-
_usage
final JsonField<RunStep.Usage> _usage()
Usage statistics related to the run step. This value will be
null
while the run step's status isin_progress
.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final RunStep.Builder toBuilder()
-
builder
final static RunStep.Builder builder()
-
-
-
-