次の方法で共有

RunStep Class

Package:
com.azure.ai.agents.persistent.models
Maven Artifact:
com.azure:azure-ai-agents-persistent:1.0.0-beta.2
  • java.lang.Object
    • com.azure.ai.agents.persistent.models.RunStep

Implements

JsonSerializable<RunStep>

public final class RunStep
implements JsonSerializable<RunStep>

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

Method Summary

Modifier and Type Method and Description
static RunStep fromJson(JsonReader jsonReader)

Reads an instance of RunStep from the JsonReader.
String getAssistantId()

Get the assistantId property: The ID of the agent associated with the run step.
OffsetDateTime getCancelledAt()

Get the cancelledAt property: The Unix timestamp, in seconds, representing when this was cancelled.
OffsetDateTime getCompletedAt()

Get the completedAt property: The Unix timestamp, in seconds, representing when this completed.
OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
OffsetDateTime getExpiredAt()

Get the expiredAt property: The Unix timestamp, in seconds, representing when this item expired.
OffsetDateTime getFailedAt()

Get the failedAt property: The Unix timestamp, in seconds, representing when this failed.
String getId()

Get the id property: The identifier, which can be referenced in API endpoints.
RunStepError getLastError()

Get the lastError property: If applicable, information about the last error encountered by this run step.
Map<String,String> getMetadata()

Get the metadata property: 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.
String getObject()

Get the object property: The object type, which is always 'thread.run.step'.
String getRunId()

Get the runId property: The ID of the run that this run step is a part of.
RunStepStatus getStatus()

Get the status property: The status of this run step.
RunStepDetails getStepDetails()

Get the stepDetails property: The details for this run step.
String getThreadId()

Get the threadId property: The ID of the thread that was run.
RunStepType getType()

Get the type property: The type of run step, which can be either message_creation or tool_calls.
RunStepCompletionUsage getUsage()

Get the usage property: Usage statistics related to the run step.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static RunStep fromJson(JsonReader jsonReader)

Reads an instance of RunStep from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RunStep if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAssistantId

public String getAssistantId()

Get the assistantId property: The ID of the agent associated with the run step.

Returns:

the assistantId value.

getCancelledAt

public OffsetDateTime getCancelledAt()

Get the cancelledAt property: The Unix timestamp, in seconds, representing when this was cancelled.

Returns:

the cancelledAt value.

getCompletedAt

public OffsetDateTime getCompletedAt()

Get the completedAt property: The Unix timestamp, in seconds, representing when this completed.

Returns:

the completedAt value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.

Returns:

the createdAt value.

getExpiredAt

public OffsetDateTime getExpiredAt()

Get the expiredAt property: The Unix timestamp, in seconds, representing when this item expired.

Returns:

the expiredAt value.

getFailedAt

public OffsetDateTime getFailedAt()

Get the failedAt property: The Unix timestamp, in seconds, representing when this failed.

Returns:

the failedAt value.

getId

public String getId()

Get the id property: The identifier, which can be referenced in API endpoints.

Returns:

the id value.

getLastError

public RunStepError getLastError()

Get the lastError property: If applicable, information about the last error encountered by this run step.

Returns:

the lastError value.

getMetadata

public Map<String,String> getMetadata()

Get the metadata property: 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.

Returns:

the metadata value.

getObject

public String getObject()

Get the object property: The object type, which is always 'thread.run.step'.

Returns:

the object value.

getRunId

public String getRunId()

Get the runId property: The ID of the run that this run step is a part of.

Returns:

the runId value.

getStatus

public RunStepStatus getStatus()

Get the status property: The status of this run step.

Returns:

the status value.

getStepDetails

public RunStepDetails getStepDetails()

Get the stepDetails property: The details for this run step.

Returns:

the stepDetails value.

getThreadId

public String getThreadId()

Get the threadId property: The ID of the thread that was run.

Returns:

the threadId value.

getType

public RunStepType getType()

Get the type property: The type of run step, which can be either message_creation or tool_calls.

Returns:

the type value.

getUsage

public RunStepCompletionUsage getUsage()

Get the usage property: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.

Returns:

the usage value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to