Class AISchemaDiscovery

java.lang.Object
neqsim.util.annotation.AISchemaDiscovery
All Implemented Interfaces:
Serializable

public class AISchemaDiscovery extends Object implements Serializable
Discovers and documents AI-exposed NeqSim functionality.

This class uses reflection to find methods marked with AIExposable and generates structured documentation that AI agents can parse.

Usage:


AISchemaDiscovery discovery = new AISchemaDiscovery();

// Discover methods in a class
List<MethodSchema> methods = discovery.discoverMethods(SystemSrkEos.class);

// Generate prompt for AI
String prompt = discovery.generateMethodPrompt(methods);

// Get all core NeqSim APIs
Map<String, List<MethodSchema>> coreAPIs = discovery.discoverCoreAPIs();

Version:
1.0
Author:
NeqSim
See Also:
  • Field Details

  • Constructor Details

    • AISchemaDiscovery

      public AISchemaDiscovery()
  • Method Details

    • discoverMethods

      public List<AISchemaDiscovery.MethodSchema> discoverMethods(Class<?> clazz)
      Discover all AI-exposed methods in a class.
      Parameters:
      clazz - class to scan
      Returns:
      list of method schemas
    • discoverCommonMethods

      public List<AISchemaDiscovery.MethodSchema> discoverCommonMethods(Class<?> clazz)
      Discover common NeqSim methods even without annotations.

      This provides a basic discovery of frequently-used methods for AI consumption.

      Parameters:
      clazz - class to scan
      Returns:
      list of common method schemas
    • createMethodSchema

      private AISchemaDiscovery.MethodSchema createMethodSchema(Class<?> clazz, Method method, AIExposable annotation)
      Create MethodSchema from annotation.
    • createMethodSchemaFromMethod

      private AISchemaDiscovery.MethodSchema createMethodSchemaFromMethod(Class<?> clazz, Method method)
      Create MethodSchema from method without annotation.
    • generateDescriptionFromName

      private String generateDescriptionFromName(String methodName)
      Generate a basic description from method name.
    • camelToSpaces

      private String camelToSpaces(String camel)
      Convert camelCase to spaces.
    • generateMethodPrompt

      public String generateMethodPrompt(List<AISchemaDiscovery.MethodSchema> methods)
      Generate a prompt containing discovered methods.
      Parameters:
      methods - list of method schemas
      Returns:
      formatted prompt text
    • discoverCoreAPIs

      public Map<String, List<AISchemaDiscovery.MethodSchema>> discoverCoreAPIs()
      Discover core NeqSim APIs by scanning common classes.
      Returns:
      map of class name to method schemas
    • getQuickStartPrompt

      public String getQuickStartPrompt()
      Get a quick-start prompt for AI agents.
      Returns:
      formatted quick-start prompt