InputParameter Class

Package:
com.microsoft.semantickernel.semanticfunctions
Maven Artifact:
com.microsoft.semantic-kernel:semantickernel-api:1.4.0
  • java.lang.Object
    • com.microsoft.semantickernel.semanticfunctions.InputParameter

public class InputParameter

Input parameter for semantic functions

Constructor Summary

Constructor Description
InputParameter(String name, String description, String defaultValue)

Creates a new instance of the InputParameter class.

Method Summary

Modifier and Type Method and Description
java.lang.String getDefaultValue()

Default value when nothing is provided
java.lang.String getDescription()

Parameter description for UI apps and planner.
java.lang.String getName()

Name of the parameter to pass to the function.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

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 Details

getDefaultValue

public String getDefaultValue()

Default value when nothing is provided

Returns:

the default value

getDescription

public String getDescription()

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

Returns:

description

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

Applies to