Package com.microsoft.semantickernel.semanticfunctions

Class InputParameter

java.lang.Object

com.microsoft.semantickernel.semanticfunctions.InputParameter

public class InputParameter
extends Object

Input parameter for semantic functions

Constructor Summary

Constructors

Constructor	Description
InputParameter(String name, String description, String defaultValue)	Creates a new instance of the InputParameter class.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Default value when nothing is provided
String	getDescription()	Parameter description for UI apps and planner.
String	getName()	Name of the parameter to pass to the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputParameter

public InputParameter(String name,
                      String description,
                      String defaultValue)

Creates a new instance of the InputParameter class.

Parameters:

name - name of the parameter

description - description of the parameter

defaultValue - default value of the parameter

Method Detail

getName

public String getName()

Name of the parameter to pass to the function. e.g. when using "{{$input}}" the name is "input", when using "{{$style}}" the name is "style", etc.

Returns:

name

getDescription

public String getDescription()

Parameter description for UI apps and planner. Localization is not supported here.

Returns:

description

getDefaultValue

public String getDefaultValue()

Default value when nothing is provided

Returns:

the default value