AgentVersionDetails Class

  • java.lang.Object
    • com.azure.ai.agents.models.AgentVersionDetails

Implements

public final class AgentVersionDetails
implements JsonSerializable<AgentVersionDetails>

The AgentVersionDetails model.

Method Summary

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

Reads an instance of AgentVersionDetails from the JsonReader.

String getAgentGuid()

Get the agentGuid property: The unique GUID identifier of the agent.

AgentIdentity getBlueprint()

Get the blueprint property: The blueprint for the agent.

AgentBlueprintReference getBlueprintReference()

Get the blueprintReference property: The blueprint for the agent.

OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp (seconds) when the agent was created.

AgentDefinition getDefinition()

Get the definition property: The definition property.

String getDescription()

Get the description property: A human-readable description of the agent.

String getId()

Get the id property: The unique identifier of the agent version.

AgentIdentity getInstanceIdentity()

Get the instanceIdentity property: The instance identity of the agent.

Map<String,String> getMetadata()

Get the metadata property: Set of 16 key-value pairs that can be attached to an object.

String getName()

Get the name property: The name of the agent.

AgentObjectType getObjectType()

Get the objectType property: The object type, which is always 'agent.version'.

AgentVersionStatus getStatus()

Get the status property: The provisioning status of the agent version.

String getVersion()

Get the version property: The version identifier of the agent.

Boolean isDraft()

Get the draft property: Whether this agent version is a draft (candidate) rather than a release.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static AgentVersionDetails fromJson(JsonReader jsonReader)

Reads an instance of AgentVersionDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AgentVersionDetails 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.

getAgentGuid

public String getAgentGuid()

Get the agentGuid property: The unique GUID identifier of the agent.

Returns:

the agentGuid value.

getBlueprint

public AgentIdentity getBlueprint()

Get the blueprint property: The blueprint for the agent.

Returns:

the blueprint value.

getBlueprintReference

public AgentBlueprintReference getBlueprintReference()

Get the blueprintReference property: The blueprint for the agent.

Returns:

the blueprintReference value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: The Unix timestamp (seconds) when the agent was created.

Returns:

the createdAt value.

getDefinition

public AgentDefinition getDefinition()

Get the definition property: The definition property.

Returns:

the definition value.

getDescription

public String getDescription()

Get the description property: A human-readable description of the agent.

Returns:

the description value.

getId

public String getId()

Get the id property: The unique identifier of the agent version.

Returns:

the id value.

getInstanceIdentity

public AgentIdentity getInstanceIdentity()

Get the instanceIdentity property: The instance identity of the agent.

Returns:

the instanceIdentity value.

getMetadata

public Map<String,String> getMetadata()

Get the metadata property: 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, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

the metadata value.

getName

public String getName()

Get the name property: The name of the agent. Name can be used to retrieve/update/delete the agent.

Returns:

the name value.

getObjectType

public AgentObjectType getObjectType()

Get the objectType property: The object type, which is always 'agent.version'.

Returns:

the objectType value.

getStatus

public AgentVersionStatus getStatus()

Get the status property: The provisioning status of the agent version. Defaults to 'active' for non-hosted agents. For hosted agents, reflects infrastructure readiness.

Returns:

the status value.

getVersion

public String getVersion()

Get the version property: The version identifier of the agent. Agents are immutable and every update creates a new version while keeping the name same.

Returns:

the version value.

isDraft

public Boolean isDraft()

Get the draft property: Whether this agent version is a draft (candidate) rather than a release. Draft versions are recorded but excluded from default 'latest' resolution and are not auto-promoted. Defaults to false.

Returns:

the draft value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to