Annotation Interface AIExposable

@Documented @Retention(RUNTIME) @Target({TYPE,METHOD,FIELD}) public @interface AIExposable
Marks a class, method, or field as exposed for AI/ML integration.

AI agents can use reflection to discover methods marked with this annotation and understand their purpose, parameters, and expected behavior.

Usage Examples:


@AIExposable(
  description = "Calculate vapor-liquid equilibrium at given T and P",
  category = "thermodynamics",
  example = "ops.TPflash()"
)
public void TPflash() { ... }
Version:
1.0
Author:
NeqSim

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    category
    Category for grouping related functionality.
    String
    description
    Human-readable description of what this element does.
    String
    example
    Example code showing how to use this element.
    int
    priority
    Priority for AI suggestion (higher = more likely to suggest).
    boolean
    safe
    Whether this method/class is safe for automated execution.
    String[]
    tags
    Tags for search and discovery.

  • Element Details

    • description

      String description
      Human-readable description of what this element does.
      Returns:
      description text
      Default:
      ""

    • category

      String category
      Category for grouping related functionality.

      Common categories: "thermodynamics", "process", "optimization", "properties", "flash"

      Returns:
      category name
      Default:
      "general"

    • example

      String example
      Example code showing how to use this element.
      Returns:
      example code snippet
      Default:
      ""

    • priority

      int priority
      Priority for AI suggestion (higher = more likely to suggest).

      Range: 0-100. Default is 50 (normal priority).

      Returns:
      priority value
      Default:
      50

    • safe

      boolean safe
      Whether this method/class is safe for automated execution.

      Methods that modify state or have side effects should be marked as non-safe.

      Returns:
      true if safe to auto-execute
      Default:
      true

    • tags

      String[] tags
      Tags for search and discovery.
      Returns:
      array of tags
      Default:
      {}