Package com.microsoft.semantickernel.semanticfunctions

Class InputVariable

java.lang.Object

com.microsoft.semantickernel.semanticfunctions.InputVariable

public class InputVariable
extends Object

Metadata for an input variable of a KernelFunction.

Constructor Summary

Constructors

Constructor	Description
InputVariable(String name)	Creates a new instance of InputVariable.
InputVariable(String name, String type, String description, String defaultValue, boolean isRequired, List<?> enumValues)	Creates a new instance of InputVariable.

Method Summary

Modifier and Type	Method	Description
static InputVariable	build(String name, Class<?> type, String description, String defaultValue, List<?> enumValues, boolean required)	Creates a new instance of InputVariable.
boolean	equals(Object obj)
String	getDefaultValue()	Gets the default value of the input variable.
String	getDescription()	Gets the description of the input variable.
List<?>	getEnumValues()	Gets the possible enum values of the input variable.
String	getName()	Gets the name of the input variable.
String	getType()	Gets the type of the input variable.
Class<?>	getTypeClass()	Gets the class of the type of the input variable.
int	hashCode()
boolean	isRequired()	Gets whether the input variable is required.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputVariable

public InputVariable(String name,
                     String type,
                     @Nullable
                     String description,
                     @Nullable
                     String defaultValue,
                     boolean isRequired,
                     @Nullable
                     List<?> enumValues)

Creates a new instance of InputVariable.

Parameters:

name - the name of the input variable

type - the type of the input variable

description - the description of the input variable

defaultValue - the default value of the input variable

isRequired - whether the input variable is required

enumValues - the enum values of the input variable

InputVariable

public InputVariable(String name)

Creates a new instance of InputVariable.

Parameters:

name - the name of the input variable

Method Detail

build

public static InputVariable build(String name,
                                  Class<?> type,
                                  @Nullable
                                  String description,
                                  @Nullable
                                  String defaultValue,
                                  @Nullable
                                  List<?> enumValues,
                                  boolean required)

Creates a new instance of InputVariable.

Parameters:

name - the name of the input variable

type - the type of the input variable

description - the description of the input variable

defaultValue - the default value of the input variable

required - whether the input variable is required

Returns:

a new instance of InputVariable

getName

public String getName()

Gets the name of the input variable.

Returns:

the name of the input variable

getDescription

@Nullable
public String getDescription()

Gets the description of the input variable.

Returns:

the description of the input variable

getDefaultValue

@Nullable
public String getDefaultValue()

Gets the default value of the input variable.

Returns:

the default value of the input variable

isRequired

public boolean isRequired()

Gets whether the input variable is required.

Returns:

whether the input variable is required

getType

public String getType()

Gets the type of the input variable.

Returns:

the type of the input variable

getTypeClass

public Class<?> getTypeClass()

Gets the class of the type of the input variable.

Returns:

the class of the type of the input variable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getEnumValues

@Nullable
public List<?> getEnumValues()

Gets the possible enum values of the input variable.

Returns:

the possible enum values of the input variable