SkillReferenceParameter Class

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

public final class SkillReferenceParameter
extends ContainerSkill

The SkillReferenceParameter model.

Constructor Summary

Constructor Description
SkillReferenceParameter(String skillId)

Creates an instance of SkillReferenceParameter class.

Method Summary

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

Reads an instance of SkillReferenceParameter from the JsonReader.
String getSkillId()

Get the skillId property: The ID of the referenced skill.
ContainerSkillType getType()

Get the type property: The type property.
String getVersion()

Get the version property: Optional skill version.
SkillReferenceParameter setVersion(String version)

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

Methods inherited from ContainerSkill

fromJson getType toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SkillReferenceParameter

public SkillReferenceParameter(String skillId)

Creates an instance of SkillReferenceParameter class.

Parameters:

skillId - the skillId value to set.

Method Details

fromJson

public static SkillReferenceParameter fromJson(JsonReader jsonReader)

Reads an instance of SkillReferenceParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getSkillId

public String getSkillId()

Get the skillId property: The ID of the referenced skill.

Returns:

the skillId value.

getType

public ContainerSkillType getType()

Get the type property: The type property.

Overrides:

SkillReferenceParameter.getType()

Returns:

the type value.

getVersion

public String getVersion()

Get the version property: Optional skill version. Use a positive integer or 'latest'. Omit for default.

Returns:

the version value.

setVersion

public SkillReferenceParameter setVersion(String version)

Set the version property: Optional skill version. Use a positive integer or 'latest'. Omit for default.

Parameters:

version - the version value to set.

Returns:

the SkillReferenceParameter object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SkillReferenceParameter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to