Class AIIntegrationHelper

java.lang.Object

neqsim.util.validation.AIIntegrationHelper

All Implemented Interfaces:

Serializable

public class AIIntegrationHelper
extends Object
implements Serializable

AI Integration Helper for NeqSim.

This class provides a unified entry point for AI/ML agents to interact with NeqSim, combining validation, schema discovery, and RL environment access.

Features:

• Pre-run validation to catch errors before simulation
• API schema discovery for dynamic method documentation
• RL environment creation with built-in constraint validation
• Safe execution wrappers that return structured results

Usage:

// Create AI helper
AIIntegrationHelper helper = AIIntegrationHelper.forProcess(process);

// Get API documentation for AI agent
String apiDocs = helper.getAPIDocumentation();

// Validate before running
if (helper.isReady()) {
  helper.safeRun();
} else {
  System.out.println(helper.getValidationReport());
}

// Create RL environment
RLEnvironment env = helper.createRLEnvironment();

Version:

1.0

Author:

NeqSim

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AIIntegrationHelper.ExecutionResult	Result of a safe execution.

Field Summary

Fields

Modifier and Type	Field	Description
private ValidationResult	lastValidation
private final ProcessSystem	process
private final AISchemaDiscovery	schemaDiscovery
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AIIntegrationHelper(ProcessSystem process)	Constructor.

Method Summary

Modifier and Type	Method	Description
RLEnvironment	createRLEnvironment()	Create an RL environment for the process.
static AIIntegrationHelper	forProcess(ProcessSystem process)	Create helper for a ProcessSystem.
String	getAPIDocumentation()	Get API documentation for the process components.
String[]	getIssuesAsText()	Get structured issues for AI parsing.
ProcessSystem	getProcess()	Get the underlying process system.
String	getValidationReport()	Get a human-readable validation report.
boolean	isReady()	Check if the process is ready to run.
AIIntegrationHelper.ExecutionResult	safeRun()	Safely run the process with validation.
ValidationResult	validate()	Validate the process system.
ValidationResult	validateEquipment(ProcessEquipmentInterface equipment)	Validate a specific equipment piece.
ValidationResult	validateFluid(SystemInterface system)	Validate a thermodynamic system.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

process

private final ProcessSystem process

schemaDiscovery

private final AISchemaDiscovery schemaDiscovery

lastValidation

private ValidationResult lastValidation

Constructor Details

AIIntegrationHelper

private AIIntegrationHelper(ProcessSystem process)

Constructor.

Parameters:

process - process system to manage

Method Details

forProcess

@AIExposable(description="Create an AI integration helper for a process system",
             category="ai-integration",
             example="AIIntegrationHelper.forProcess(process)",
             priority=100,
             safe=true)
public static AIIntegrationHelper forProcess(ProcessSystem process)

Create helper for a ProcessSystem.

Parameters:

process - process system to wrap

Returns:

AI integration helper

validate

@AIExposable(description="Validate the process system before running",
             category="validation",
             example="helper.validate()",
             priority=90,
             safe=true)
public ValidationResult validate()

Validate the process system.

Returns:

validation result

isReady

@AIExposable(description="Check if the process is ready to run without errors",
             category="validation",
             example="if (helper.isReady()) { ... }",
             priority=95,
             safe=true)
public boolean isReady()

Check if the process is ready to run.

Returns:

true if ready (no critical/major issues)

getValidationReport

@AIExposable(description="Get a human-readable validation report",
             category="validation",
             example="System.out.println(helper.getValidationReport())",
             priority=85,
             safe=true)
public String getValidationReport()

Get a human-readable validation report.

Returns:

validation report with issues and remediation hints

getIssuesAsText

@AIExposable(description="Get structured validation issues for AI parsing",
             category="validation",
             example="String[] issues = helper.getIssuesAsText()",
             priority=80,
             safe=true)
public String[] getIssuesAsText()

Get structured issues for AI parsing.

Returns:

array of issues as structured text

safeRun

@AIExposable(description="Run the process simulation with pre-validation",
             category="execution",
             example="ExecutionResult result = helper.safeRun()",
             priority=75,
             safe=false)
public AIIntegrationHelper.ExecutionResult safeRun()

Safely run the process with validation.

Returns:

execution result with success/failure info

getAPIDocumentation

@AIExposable(description="Get API documentation for AI agent consumption",
             category="discovery",
             example="String docs = helper.getAPIDocumentation()",
             priority=100,
             safe=true)
public String getAPIDocumentation()

Get API documentation for the process components.

Returns:

formatted API documentation

createRLEnvironment

@AIExposable(description="Create an RL training environment for the process",
             category="ml",
             example="RLEnvironment env = helper.createRLEnvironment()",
             priority=70,
             safe=true)
public RLEnvironment createRLEnvironment()

Create an RL environment for the process.

The RL environment includes built-in validation constraints.

Returns:

configured RL environment

validateEquipment

@AIExposable(description="Validate a specific piece of equipment",
             category="validation",
             example="ValidationResult result = helper.validateEquipment(separator)",
             priority=75,
             safe=true)
public ValidationResult validateEquipment(ProcessEquipmentInterface equipment)

Validate a specific equipment piece.

Parameters:

equipment - equipment to validate

Returns:

validation result

validateFluid

@AIExposable(description="Validate a thermodynamic system configuration",
             category="validation",
             example="ValidationResult result = helper.validateFluid(fluid)",
             priority=75,
             safe=true)
public ValidationResult validateFluid(SystemInterface system)

Validate a thermodynamic system.

Parameters:

system - thermodynamic system to validate

Returns:

validation result

getProcess

public ProcessSystem getProcess()

Get the underlying process system.

Returns:

process system