Annotation Type AIToolParam

@Retention(RUNTIME) @Target(PARAMETER) public @interface AIToolParam
Annotation used to provide metadata for a parameter of a method annotated with AIToolMethod.

This metadata is used to generate the JSON schema for the function declaration sent to the Gemini API.

Author:
Anahata

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    A detailed description of what this parameter represents and any constraints on its value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    required
    Indicates whether this parameter is required for the tool to function.

  • Element Details

    • value

      String value
      A detailed description of what this parameter represents and any constraints on its value.
      Returns:
      The parameter description.

    • required

      boolean required
      Indicates whether this parameter is required for the tool to function.

      If true, the model will be instructed that it must provide a value for this parameter.

      Returns:
      true if required, false otherwise.
      Default:
      true