Annotation Interface AIParameter

@Documented @Retention(RUNTIME) @Target(PARAMETER) public @interface AIParameter
Documents a parameter for AI consumption.

Provides structured metadata about method parameters that AI agents can parse to understand valid inputs, units, and constraints.

Usage:


public void setTemperature(
    @AIParameter(
      name = "temperature",
      description = "Temperature value",
      unit = "K",
      minValue = 0.0,
      maxValue = 1000.0
    ) double temperature
) { ... }
Version:
1.0
Author:
NeqSim

  • Element Details

    • name

      String name
      Parameter name.
      Returns:
      parameter name
      Default:
      ""

    • description

      String description
      Human-readable description.
      Returns:
      description text
      Default:
      ""

    • unit

      String unit
      Physical unit (SI preferred).

      Examples: "K", "bar", "kg/hr", "mol/s", "J/mol", "Pa.s"

      Returns:
      unit string
      Default:
      ""

    • minValue

      double minValue
      Minimum valid value.
      Returns:
      minimum value
      Default:
      -1.0/0.0

    • maxValue

      double maxValue
      Maximum valid value.
      Returns:
      maximum value
      Default:
      1.0/0.0

    • defaultValue

      String defaultValue
      Default value if not specified.
      Returns:
      default value as string
      Default:
      ""

    • required

      boolean required
      Whether this parameter is required.
      Returns:
      true if required
      Default:
      true

    • options

      String[] options
      Valid options for enum-like parameters.
      Returns:
      array of valid options
      Default:
      {}