ToolboxSkillReference Class

Package:
com.azure.ai.agents.models
Maven Artifact:
com.azure:azure-ai-agents:2.2.0

public final class ToolboxSkillReference
extends ToolboxSkill

A reference to an existing skill to include in a toolbox.

Constructor Summary

Constructor Description
ToolboxSkillReference(String name)

Creates an instance of ToolboxSkillReference class.

Method Summary

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

Reads an instance of ToolboxSkillReference from the JsonReader.
String getName()

Get the name property: The name of the skill.
String getType()

Get the type property: The type of skill source.
String getVersion()

Get the version property: The version of the skill.
ToolboxSkillReference setVersion(String version)

Set the version property: The version of the skill.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from ToolboxSkill

fromJson getType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ToolboxSkillReference

public ToolboxSkillReference(String name)

Creates an instance of ToolboxSkillReference class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static ToolboxSkillReference fromJson(JsonReader jsonReader)

Reads an instance of ToolboxSkillReference from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getName

public String getName()

Get the name property: The name of the skill.

Returns:

the name value.

getType

public String getType()

Get the type property: The type of skill source.

Overrides:

ToolboxSkillReference.getType()

Returns:

the type value.

getVersion

public String getVersion()

Get the version property: The version of the skill. If not specified, the skill's default version is used. When a version is specified, the reference is pinned to that immutable version.

Returns:

the version value.

setVersion

public ToolboxSkillReference setVersion(String version)

Set the version property: The version of the skill. If not specified, the skill's default version is used. When a version is specified, the reference is pinned to that immutable version.

Parameters:

version - the version value to set.

Returns:

the ToolboxSkillReference object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ToolboxSkillReference.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to