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)	Creates a new instance of InputVariable.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the default value of the input variable.
String	getDescription()	Gets the description 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.
boolean	isRequired()	Gets whether the input variable is required.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InputVariable

public InputVariable(String name)

Creates a new instance of InputVariable.

Parameters:

name - the name of the input variable

InputVariable

public InputVariable(String name,
                     String type,
                     @Nullable
                     String description,
                     @Nullable
                     String defaultValue,
                     boolean isRequired)

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

Method Detail

getName

public String getName()

Gets the name of the input variable.

Returns:

the name of the input variable

getType

public String getType()

Gets the type of the input variable.

Returns:

the type 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

getTypeClass

public Class<?> getTypeClass()

Gets the class of the type of the input variable.

Returns:

the class of the type of the input variable