Package com.microsoft.semantickernel.semanticfunctions.annotations

Annotation Type KernelFunctionParameter

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static String NO_DEFAULT_VALUE
      A special value that is used to indicate that no default value is provided.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      The name of the parameter.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String defaultValue
      The default value of the parameter.
      String description
      The description of the parameter.
      boolean required
      Whether a value is required for this argument.
      Class<?> type
      The type of the parameter.

    • Field Detail

      • NO_DEFAULT_VALUE

        static final String NO_DEFAULT_VALUE
        A special value that is used to indicate that no default value is provided.

    • Element Detail

      • name

        String name
        The name of the parameter. This element is required.
        Returns:
        the name of the parameter, or an empty string if no name is provided.

      • description

        String description
        The description of the parameter. The description should be short and concise. The model uses the description to determine what value to pass to the function.
        Returns:
        the description of the parameter, or an empty string if no description is provided.
        Default:
        ""

      • defaultValue

        String defaultValue
        The default value of the parameter. If no value is set, null will be passed as the value to this argument.
        Returns:
        the default value of the parameter, or NO_DEFAULT_VALUE if no default value is provided.
        Default:
        "SKFunctionParameters__NO_INPUT_PROVIDED"

      • required

        boolean required
        Whether a value is required for this argument. If required is false, the model is free to choose whether to provide a value. If the model does not provide a value, the default value is used.
        Returns:
        whether a value is required for this argument.
        Default:
        true

      • type

        Class<?> type
        The type of the parameter. The Semantic Kernel will use the type to find a ContextVariableType to convert the value from a prompt string to the correct argument type. The type defaults to String if not provided.
        Returns:
        the type of the parameter
        Default:
        java.lang.String.class