AgentCardSkill Class

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

Implements

public final class AgentCardSkill
implements JsonSerializable<AgentCardSkill>

The AgentCardSkill model.

Constructor Summary

Constructor Description
AgentCardSkill()

Creates an instance of AgentCardSkill class.

Method Summary

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

Reads an instance of AgentCardSkill from the JsonReader.

String getDescription()

Get the description property: A description of the skill.

List<String> getExamples()

Get the examples property: A list of example scenarios that the skill can perform.

String getId()

Get the id property: a unique identifier for the skill.

String getName()

Get the name property: The name of the skill.

List<String> getTags()

Get the tags property: set of tagwords describing classes of capabilities for the skill.

AgentCardSkill setDescription(String description)

Set the description property: A description of the skill.

AgentCardSkill setExamples(List<String> examples)

Set the examples property: A list of example scenarios that the skill can perform.

AgentCardSkill setId(String id)

Set the id property: a unique identifier for the skill.

AgentCardSkill setName(String name)

Set the name property: The name of the skill.

AgentCardSkill setTags(List<String> tags)

Set the tags property: set of tagwords describing classes of capabilities for the skill.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

AgentCardSkill

public AgentCardSkill()

Creates an instance of AgentCardSkill class.

Method Details

fromJson

public static AgentCardSkill fromJson(JsonReader jsonReader)

Reads an instance of AgentCardSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDescription

public String getDescription()

Get the description property: A description of the skill.

Returns:

the description value.

getExamples

public List<String> getExamples()

Get the examples property: A list of example scenarios that the skill can perform.

Returns:

the examples value.

getId

public String getId()

Get the id property: a unique identifier for the skill.

Returns:

the id value.

getName

public String getName()

Get the name property: The name of the skill.

Returns:

the name value.

getTags

public List<String> getTags()

Get the tags property: set of tagwords describing classes of capabilities for the skill.

Returns:

the tags value.

setDescription

public AgentCardSkill setDescription(String description)

Set the description property: A description of the skill.

Parameters:

description - the description value to set.

Returns:

the AgentCardSkill object itself.

setExamples

public AgentCardSkill setExamples(List<String> examples)

Set the examples property: A list of example scenarios that the skill can perform.

Parameters:

examples - the examples value to set.

Returns:

the AgentCardSkill object itself.

setId

public AgentCardSkill setId(String id)

Set the id property: a unique identifier for the skill.

Required when create the resource.

Parameters:

id - the id value to set.

Returns:

the AgentCardSkill object itself.

setName

public AgentCardSkill setName(String name)

Set the name property: The name of the skill.

Required when create the resource.

Parameters:

name - the name value to set.

Returns:

the AgentCardSkill object itself.

setTags

public AgentCardSkill setTags(List<String> tags)

Set the tags property: set of tagwords describing classes of capabilities for the skill.

Parameters:

tags - the tags value to set.

Returns:

the AgentCardSkill object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to