Package org.netxms.client.ai

Class AiOperator

java.lang.Object
org.netxms.client.ai.AiOperator
public class AiOperator extends Object
AI operator instance - perpetual adaptive monitoring loop. Configuration fields have setters and can be changed by the client; adaptive state fields (current focus, watch list, memento) are managed by the operator itself and are read-only. Standing instructions are written by the operator itself but can be edited or locked by an administrator.

  • Constructor Details

    • AiOperator

      public AiOperator(String name)
      Create new AI operator instance definition with default settings (for subsequent creation on server).
      Parameters:
      name - instance name

    • AiOperator

      public AiOperator(NXCPMessage msg, long baseId)
      Create AI operator instance object from NXCP message.
      Parameters:
      msg - NXCP message
      baseId - base ID for fields

  • Method Details

    • fillMessage

      public void fillMessage(NXCPMessage msg)
      Fill NXCP message with configuration data for create/modify request. Standing instructions are written by the operator itself between client refreshes, so they are sent only if explicitly changed via setInstructions() - server keeps current text when the field is absent.
      Parameters:
      msg - NXCP message

    • getId

      public int getId()
      Returns:
      the id

    • getName

      public String getName()
      Returns:
      the name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getDescription

      public String getDescription()
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - the description to set

    • getOwnerUserId

      public int getOwnerUserId()
      Returns:
      ID of the owner user account the instance executes as

    • setOwnerUserId

      public void setOwnerUserId(int ownerUserId)
      Set owner user account the instance executes as. Value 0 is not sent to the server: on create the server assigns the default AI operator account, on modify the current owner is kept.
      Parameters:
      ownerUserId - owner user ID

    • isEnabled

      public boolean isEnabled()
      Returns:
      true if the instance is enabled

    • setEnabled

      public void setEnabled(boolean enabled)
      Parameters:
      enabled - true to enable the instance

    • isExecuting

      public boolean isExecuting()
      Returns:
      true if a cycle is currently running

    • getScopeFilter

      public String getScopeFilter()
      Returns:
      the scopeFilter

    • setScopeFilter

      public void setScopeFilter(String scopeFilter)
      Parameters:
      scopeFilter - the scopeFilter to set

    • getModelSlot

      public String getModelSlot()
      Returns:
      the modelSlot

    • setModelSlot

      public void setModelSlot(String modelSlot)
      Parameters:
      modelSlot - the modelSlot to set

    • getMinInterval

      public int getMinInterval()
      Returns:
      the minInterval

    • setMinInterval

      public void setMinInterval(int minInterval)
      Parameters:
      minInterval - the minInterval to set

    • getMaxInterval

      public int getMaxInterval()
      Returns:
      the maxInterval

    • setMaxInterval

      public void setMaxInterval(int maxInterval)
      Parameters:
      maxInterval - the maxInterval to set

    • getDailyTokenBudget

      public int getDailyTokenBudget()
      Returns:
      the dailyTokenBudget

    • setDailyTokenBudget

      public void setDailyTokenBudget(int dailyTokenBudget)
      Parameters:
      dailyTokenBudget - the dailyTokenBudget to set

    • getTokensUsedToday

      public long getTokensUsedToday()
      Returns:
      LLM tokens used within the current usage day (UTC)

    • getPersonaPrompt

      public String getPersonaPrompt()
      Returns:
      the personaPrompt

    • setPersonaPrompt

      public void setPersonaPrompt(String personaPrompt)
      Parameters:
      personaPrompt - the personaPrompt to set

    • getCurrentFocus

      public String getCurrentFocus()
      Returns:
      current focus set by the operator itself

    • getWatchList

      public String getWatchList()
      Returns:
      watch list maintained by the operator itself

    • getMemento

      public String getMemento()
      Returns:
      state carried between cycles by the operator itself

    • getObservationRetentionDays

      public int getObservationRetentionDays()
      Returns:
      the observationRetentionDays

    • setObservationRetentionDays

      public void setObservationRetentionDays(int observationRetentionDays)
      Parameters:
      observationRetentionDays - the observationRetentionDays to set

    • getObservationMaxRecords

      public int getObservationMaxRecords()
      Returns:
      the observationMaxRecords

    • setObservationMaxRecords

      public void setObservationMaxRecords(int observationMaxRecords)
      Parameters:
      observationMaxRecords - the observationMaxRecords to set

    • getLastExecutionTime

      public Date getLastExecutionTime()
      Returns:
      the lastExecutionTime

    • getNextExecutionTime

      public Date getNextExecutionTime()
      Returns:
      the nextExecutionTime

    • getCycle

      public int getCycle()
      Returns:
      number of completed cycles

    • getConsecutiveFailures

      public int getConsecutiveFailures()
      Returns:
      number of consecutive failed executions

    • getLastExplanation

      public String getLastExplanation()
      Returns:
      explanation returned by the last execution

    • getCreationTime

      public Date getCreationTime()
      Returns:
      the creationTime

    • getModificationTime

      public Date getModificationTime()
      Returns:
      the modificationTime

    • getInstructions

      public String getInstructions()
      Returns:
      standing instructions authored by the operator itself

    • setInstructions

      public void setInstructions(String instructions)
      Parameters:
      instructions - standing instructions to set (empty string clears); marks instructions as changed so that they will be sent to the server on next modify request

    • isInstructionsLocked

      public boolean isInstructionsLocked()
      Returns:
      true if standing instructions are locked against updates by the operator

    • setInstructionsLocked

      public void setInstructionsLocked(boolean instructionsLocked)
      Parameters:
      instructionsLocked - true to lock standing instructions against updates by the operator