Package org.mule.weave.extension.api.llm.tools

Interface LLMToolParams

public interface LLMToolParams
Represents the parameters of a tool

  • Method Details

    • getStringParam

      Optional<String> getStringParam(String name)
      Returns a param of type String
      Parameters:
      name - The name of the param
      Returns:
      The param if it exists

    • getBooleanParam

      Optional<Boolean> getBooleanParam(String name)
      Returns a param of type Boolean
      Parameters:
      name - The name of the param
      Returns:
      The param if it exists

    • getObjectParam

      Optional<Map<String,Object>> getObjectParam(String name)
      Returns a param of type Map (representing a JSON object)
      Parameters:
      name - The name of the param
      Returns:
      The param if it exists

    • getListParam

      Optional<List<Object>> getListParam(String name)
      Returns a param of type List (representing a JSON array)
      Parameters:
      name - The name of the param
      Returns:
      The param if it exists

    • stringParam

      default String stringParam(String name)
      Returns a param of type String. This is a convenience method that directly returns the String value.
      Parameters:
      name - The name of the param.
      Returns:
      The String value of the param.
      Throws:
      RuntimeException - if the parameter with the given name is not found or is not a String.

    • booleanParam

      default Boolean booleanParam(String name)
      Returns a param of type Boolean. This is a convenience method that directly returns the Boolean value.
      Parameters:
      name - The name of the param.
      Returns:
      The Boolean value of the param.
      Throws:
      RuntimeException - if the parameter with the given name is not found or is not a Boolean.