AgentCard Class

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

Implements

public final class AgentCard
implements JsonSerializable<AgentCard>

The AgentCard model.

Constructor Summary

Constructor Description
AgentCard()

Creates an instance of AgentCard class.

Method Summary

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

Reads an instance of AgentCard from the JsonReader.

String getDescription()

Get the description property: The description of the agent card.

List<AgentCardSkill> getSkills()

Get the skills property: The set of skills that an agent can perform.

String getVersion()

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

AgentCard setDescription(String description)

Set the description property: The description of the agent card.

AgentCard setSkills(List<AgentCardSkill> skills)

Set the skills property: The set of skills that an agent can perform.

AgentCard setVersion(String version)

Set the version property: The version of the agent card.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

AgentCard

public AgentCard()

Creates an instance of AgentCard class.

Method Details

fromJson

public static AgentCard fromJson(JsonReader jsonReader)

Reads an instance of AgentCard from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the AgentCard.

getDescription

public String getDescription()

Get the description property: The description of the agent card.

Returns:

the description value.

getSkills

public List<AgentCardSkill> getSkills()

Get the skills property: The set of skills that an agent can perform.

Returns:

the skills value.

getVersion

public String getVersion()

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

Returns:

the version value.

setDescription

public AgentCard setDescription(String description)

Set the description property: The description of the agent card.

Parameters:

description - the description value to set.

Returns:

the AgentCard object itself.

setSkills

public AgentCard setSkills(List<AgentCardSkill> skills)

Set the skills property: The set of skills that an agent can perform.

Required when create the resource.

Parameters:

skills - the skills value to set.

Returns:

the AgentCard object itself.

setVersion

public AgentCard setVersion(String version)

Set the version property: The version of the agent card.

Required when create the resource.

Parameters:

version - the version value to set.

Returns:

the AgentCard object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to