Class ScriptingAgent

java.lang.Object
com.inductiveautomation.ignition.designer.ai.agent.ScriptingAgent
All Implemented Interfaces:
Agent

public final class ScriptingAgent extends Object implements Agent
  • Field Details

  • Constructor Details

  • Method Details

    • renderFunctionSignature

      public static String renderFunctionSignature(com.inductiveautomation.ignition.common.script.typing.ExtensionFunctionDescriptor descriptor)
      Renders the Markdown body of a "Function signature" context section for an extension function: the def line in a fenced block, the descriptor's prose description if present, and a bulleted list of parameters with their types and per-parameter descriptions.

      Pair with ComposedAgent.Builder.contextSection(String, java.util.function.Supplier) under the heading "Function signature":

      .contextSection("Function signature", () -> ScriptingAgent.renderFunctionSignature(panel.getDescriptor()))
      
      Parameters:
      descriptor - the function descriptor to render.
      Returns:
      the Markdown body, without a heading; never blank.
    • getTypeId

      public String getTypeId()
      Description copied from interface: Agent
      Stable type identifier for this agent type. Useful for diagnostics and routing.
      Specified by:
      getTypeId in interface Agent
    • getName

      public String getName()
      Description copied from interface: Agent
      Human-readable name used in logs and routing.
      Specified by:
      getName in interface Agent
    • getDescription

      public String getDescription()
      Description copied from interface: Agent
      Human and Agent readable description used in logs and routing.
      Specified by:
      getDescription in interface Agent
    • getSystemPrompt

      public String getSystemPrompt()
      Description copied from interface: Agent
      System prompt that primes the model for this agent's role.
      Specified by:
      getSystemPrompt in interface Agent
    • getTools

      public List<CallableTool> getTools()
      Description copied from interface: Agent
      Callable tools exposed to the model. Typically built from Tool-annotated methods via Tools.fromAnnotated(Object...), but may include hand-rolled CallableTool implementations. Returns an empty list if the agent declares no tools.
      Specified by:
      getTools in interface Agent
    • getAdditionalContext

      public Optional<String> getAdditionalContext()
      Description copied from interface: Agent
      Supplemental context to be folded into the prompt (e.g. project state, schema, current selection), or empty if none is provided.
      Specified by:
      getAdditionalContext in interface Agent