Package com.axelor.ai.tool.system

Annotation Interface Param

@Retention(RUNTIME) @Target(RECORD_COMPONENT) public @interface Param
Annotates a record component to provide metadata for JSON schema generation. Used by SchemaGenerator to build LLM tool input schemas automatically.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    allowedValues
    Allowed values for string parameters — emitted as JSON Schema enum.
    String
    description
    Human-readable description of this parameter for the LLM.
    boolean
    required
    Whether the LLM must always provide this parameter.

  • Element Details

    • description

      String description
      Human-readable description of this parameter for the LLM.
      Default:
      ""

    • required

      boolean required
      Whether the LLM must always provide this parameter.
      Default:
      false

    • allowedValues

      String[] allowedValues
      Allowed values for string parameters — emitted as JSON Schema enum.
      Default:
      {}