Package com.scaleoutsoftware.modules.abstractions

Annotation Interface ModuleAiMetadata

@Retention(RUNTIME) public @interface ModuleAiMetadata
Annotate a DigitalTwin module's MessageProccessor with the ModuleAiMetadata annotation to describe a module for AI agents.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
    A description of the module.
    String[]
    keyProperties
    The key properties to evaluate within a state objects properties.

  • Element Details

    • description

      String description
      A description of the module.
      Returns:
      the description of the module.

    • keyProperties

      String[] keyProperties
      The key properties to evaluate within a state objects properties.
      Returns:
      key properties to evaluate within a state objects properties.