Package io.github.ollama4j.tools.annotations

Annotation Type ToolProperty

@Retention(RUNTIME) @Target(PARAMETER) public @interface ToolProperty
Annotates a Method Parameter in a ToolSpec annotated Method. A parameter annotated with this annotation will be part of the tool description that is sent to the llm for tool-calling.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    desc
     
    String
    name
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    required
     

  • Element Details

    • name

      String name
      Returns:
      name of the parameter that is used for the tool description. Has to be set as depending on the caller, method name backtracking is not possible with reflection.

    • desc

      String desc
      Returns:
      a detailed description of the parameter. This is used by the llm called to specify, which property has to be set by the llm and how this should be filled.

    • required

      boolean required
      Returns:
      tells the llm that it has to set a value for this property.
      Default:
      true