AgentDetails Class

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

Implements

public final class AgentDetails
implements JsonSerializable<AgentDetails>

The AgentDetails model.

Method Summary

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

Reads an instance of AgentDetails from the JsonReader.

AgentCard getAgentCard()

Get the agentCard property: The agent_card property.

AgentEndpointConfig getAgentEndpoint()

Get the agentEndpoint property: The endpoint configuration for the agent.

AgentIdentity getBlueprintIdentity()

Get the blueprintIdentity property: The blueprint for the agent.

AgentBlueprintReference getBlueprintReference()

Get the blueprintReference property: The blueprint for the agent.

AgentState getConfigurationState()

Get the configurationState property: The administrative configuration state of the agent.

DigitalWorkerType getDigitalWorkerType()

Get the digitalWorkerType property: (Preview) The type of digital worker (previously known as `autopilot`).

String getId()

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

AgentIdentity getInstanceIdentity()

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

String getName()

Get the name property: The name of the agent.

AgentObjectType getObjectType()

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

AgentState getState()

Get the state property: The operational state of the agent.

AgentStateSource getStateSource()

Get the stateSource property: The source of the agent's operational state.

AgentDetailsVersions getVersions()

Get the versions property: The latest version of the agent.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Method Details

fromJson

public static AgentDetails fromJson(JsonReader jsonReader)

Reads an instance of AgentDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAgentCard

public AgentCard getAgentCard()

Get the agentCard property: The agent_card property.

Returns:

the agentCard value.

getAgentEndpoint

public AgentEndpointConfig getAgentEndpoint()

Get the agentEndpoint property: The endpoint configuration for the agent.

Returns:

the agentEndpoint value.

getBlueprintIdentity

public AgentIdentity getBlueprintIdentity()

Get the blueprintIdentity property: The blueprint for the agent.

Returns:

the blueprintIdentity value.

getBlueprintReference

public AgentBlueprintReference getBlueprintReference()

Get the blueprintReference property: The blueprint for the agent.

Returns:

the blueprintReference value.

getConfigurationState

public AgentState getConfigurationState()

Get the configurationState property: The administrative configuration state of the agent. This reflects whether the agent was explicitly enabled or disabled, independently of identity-derived operational state.

Returns:

the configurationState value.

getDigitalWorkerType

public DigitalWorkerType getDigitalWorkerType()

Get the digitalWorkerType property: (Preview) The type of digital worker (previously known as `autopilot`). If omitted, it is not a digital worker.

Returns:

the digitalWorkerType value.

getId

public String getId()

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

Returns:

the id value.

getInstanceIdentity

public AgentIdentity getInstanceIdentity()

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

Returns:

the instanceIdentity value.

getName

public String getName()

Get the name property: The name of the agent.

Returns:

the name value.

getObjectType

public AgentObjectType getObjectType()

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

Returns:

the objectType value.

getState

public AgentState getState()

Get the state property: The operational state of the agent. Controls whether the agent endpoint accepts or rejects requests.

Returns:

the state value.

getStateSource

public AgentStateSource getStateSource()

Get the stateSource property: The source of the agent's operational state. When the agent is disabled, indicates where the disabled state originates from. Empty when not derived from a specific source.

Returns:

the stateSource value.

getVersions

public AgentDetailsVersions getVersions()

Get the versions property: The latest version of the agent.

Returns:

the versions value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to