Class LoopAgentType

Abstract base class for agent type implementations.

Agent types define reusable execution patterns that control how agents behave. Each agent type is associated with a system prompt that guides the LLM's output format and decision-making process. Common agent type patterns include:

Loop: Continues executing until a goal is achieved
SinglePass: Executes once and returns a result
DecisionTree: Makes branching decisions based on conditions
Pipeline: Executes a series of steps in sequence

The agent type's system prompt should be designed to produce output that can be parsed by the DetermineNextStep method to decide what happens next in the agent's execution flow.

BaseAgentType

Example

export class LoopAgentType extends BaseAgentType {
  public async DetermineNextStep(): Promise<BaseAgentNextStep> {
    // Parse LLM output to determine if goal is achieved
    const goalAchieved = // ... parsing logic
    
    return {
      step: goalAchieved ? 'success' : 'action',
      payload: result
    };
  }
}

Hierarchy (View Summary)

BaseAgentType
- LoopAgentType

Constructors

constructor

new LoopAgentType(): LoopAgentType
Returns LoopAgentType
Inherited from BaseAgentType.constructor

Properties

`Protected`_jsonValidator

_jsonValidator: JSONValidator = ...

JSON validator instance for cleaning and validating responses

`Static` `Readonly`CURRENT_PAYLOAD_PLACEHOLDER

CURRENT_PAYLOAD_PLACEHOLDER: "_CURRENT_PAYLOAD" = '_CURRENT_PAYLOAD'

Common placeholder for current payload injection

Static

Accessors

InjectLoopResultsAsMessage

get InjectLoopResultsAsMessage(): boolean
Determines if loop results should be injected as a temporary user message before the next prompt execution (for LLM reasoning).

Default: true (most agent types benefit from seeing loop results) Flow agents override to false (deterministic path navigation, no LLM)

Returns boolean
true to inject results as message, false to skip

Since
2.112.0
Inherited from BaseAgentType.InjectLoopResultsAsMessage
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:535

RequiresAgentLevelPrompts

get RequiresAgentLevelPrompts(): boolean
Indicates whether this agent type requires agent-level prompts (AI Agent Prompts relationship).

Some agent types (like Flow) use step-level prompts exclusively and don't need agent-level prompts. Other agent types (like Loop) require agent-level prompts for their main reasoning loop.

Default: true (most agent types require agent-level prompts)

Returns boolean
True if agent-level prompts are required, false if optional

Since
2.113.0
Inherited from BaseAgentType.RequiresAgentLevelPrompts
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:474

Methods

`Optional`AfterLoopIteration

AfterLoopIteration?(
 iterationResult: {
 actionResults?: ActionResult[];
 currentPayload: P;
 index: number;
 item: any;
 itemVariable: string;
 loopContext: any;
 subAgentResult?: any;
 },
): P
Called after each loop iteration completes to process results.

Flow agents use this to apply ActionOutputMapping and update payload. Loop agents typically don't need this (just collect results).
Type Parameters
- P
Parameters
- iterationResult: {
 actionResults?: ActionResult[];
 currentPayload: P;
 index: number;
 item: any;
 itemVariable: string;
 loopContext: any;
 subAgentResult?: any;
 }
 Results from this iteration
Returns P
Modified payload or null for default behavior (just collect result)

Since
2.112.0
Inherited from BaseAgentType.AfterLoopIteration
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:579

`Optional`BeforeLoopIteration

BeforeLoopIteration?(
 context: {
 actionParams: Record<string, unknown>;
 index: number;
 item: any;
 itemVariable: string;
 loopType: "ForEach" | "While";
 payload: P;
 subAgentRequest?: {
 message: string;
 name: string;
 templateParameters?: Record<string, string>;
 };
 },
): {
 actionParams?: Record<string, unknown>;
 payload?: P;
 subAgentRequest?: {
 message: string;
 name: string;
 templateParameters?: Record<string, string>;
 };
}
Called before each loop iteration to prepare parameters and payload.

Loop agents use this to resolve template variables ("item.email"). Flow agents typically don't need this (params already resolved).
Type Parameters
- P
Parameters
- context: {
 actionParams: Record<string, unknown>;
 index: number;
 item: any;
 itemVariable: string;
 loopType: "ForEach" | "While";
 payload: P;
 subAgentRequest?: {
 message: string;
 name: string;
 templateParameters?: Record<string, string>;
 };
 }
 Current iteration context
Returns {
 actionParams?: Record<string, unknown>;
 payload?: P;
 subAgentRequest?: {
 message: string;
 name: string;
 templateParameters?: Record<string, string>;
 };
}
Modified context or null for default behavior

Since
2.112.0
Inherited from BaseAgentType.BeforeLoopIteration
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:550

`Protected`createNextStep

createNextStep(
 step:
 | "Actions"
 | "Chat"
 | "Failed"
 | "ForEach"
 | "Retry"
 | "Sub-Agent"
 | "Success"
 | "While",
 options?: Partial<BaseAgentNextStep>,
): BaseAgentNextStep
Protected
Creates a standardized next step object with common defaults
Type Parameters
- P
 The payload type
Parameters
- step:
 | "Actions"
 | "Chat"
 | "Failed"
 | "ForEach"
 | "Retry"
 | "Sub-Agent"
 | "Success"
 | "While"
 The step type
- options: Partial<BaseAgentNextStep> = {}
 Additional options to merge
Returns BaseAgentNextStep
The next step object
Inherited from BaseAgentType.createNextStep
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:329

`Protected`createRetryStep

createRetryStep(
errorMessage: string,
options?: Partial<BaseAgentNextStep>,
): BaseAgentNextStep
Protected
Creates a retry step with a standardized error message
Type Parameters
- P
 The payload type
Parameters
- errorMessage: string
 The error message
- options: Partial<BaseAgentNextStep> = {}
 Additional options
Returns BaseAgentNextStep
Retry step
Inherited from BaseAgentType.createRetryStep
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:351

`Protected`createSuccessStep

createSuccessStep(
options?: Partial<BaseAgentNextStep>,
): BaseAgentNextStep
Protected
Creates a success step with optional payload changes
Type Parameters
- P
 The payload type
Parameters
- options: Partial<BaseAgentNextStep> = {}
 Success options
Returns BaseAgentNextStep
Success step
Inherited from BaseAgentType.createSuccessStep
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:372

DetermineInitialStep

DetermineInitialStep(
params: ExecuteAgentParams,
): Promise<BaseAgentNextStep>
Determines the initial step for loop agent types.

Loop agents always start with a prompt execution to determine the initial actions.
Type Parameters
- P = any
Parameters
- params: ExecuteAgentParams
 The full execution parameters
Returns Promise<BaseAgentNextStep>
Always returns null to use default behavior

Since
2.76.0
Overrides BaseAgentType.DetermineInitialStep
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:592

DetermineNextStep

DetermineNextStep(
 promptResult: AIPromptRunResult<unknown>,
 params: ExecuteAgentParams<any, P>,
 payload: P,
 agentTypeState: ATS,
): Promise<BaseAgentNextStep>
Determines the next step based on the structured response from the AI model.

This method parses the JSON response from the loop agent prompt and translates it into appropriate BaseAgentNextStep directives. It handles task completion, sub-agent delegation, action execution, and error conditions.
Type Parameters
- P = any
- ATS = any
Parameters
- promptResult: AIPromptRunResult<unknown>
 The result from executing the agent's prompt
- params: ExecuteAgentParams<any, P>
- payload: P
- agentTypeState: ATS
Returns Promise<BaseAgentNextStep>
The next step to take in the agent execution

Throws
Implicitly through failed parsing, but returns failed step instead
Overrides BaseAgentType.DetermineNextStep
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:144

GetPromptConfigurationGuidance

GetPromptConfigurationGuidance(): string
Provides agent-type-specific guidance for configuration errors related to missing prompts. This allows each agent type to give contextual help based on its architecture.

Default implementation provides generic guidance. Agent types should override to provide specific instructions relevant to their configuration requirements.

Returns string
Configuration guidance specific to this agent type

Since
2.113.0
Inherited from BaseAgentType.GetPromptConfigurationGuidance
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:488

GetPromptForStep

GetPromptForStep(
 params: ExecuteAgentParams,
 config: AgentConfiguration,
 payload: P,
 agentTypeState: ATS,
 previousDecision?: BaseAgentNextStep,
): Promise<MJAIPromptEntityExtended>
Gets the prompt to use for a specific step. Loop agents always use the default prompt from configuration.
Type Parameters
- P = any
- ATS = any
Parameters
- params: ExecuteAgentParams
 The execution parameters (unused)
- config: AgentConfiguration
 The loaded agent configuration
- payload: P
- agentTypeState: ATS
- OptionalpreviousDecision: BaseAgentNextStep
 The previous step decision (unused)
Returns Promise<MJAIPromptEntityExtended>
Returns config.childPrompt

Since
2.76.0
Overrides BaseAgentType.GetPromptForStep
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:631

HandleStepFallback

HandleStepFallback(
 step: BaseAgentNextStep,
 config: AgentConfiguration,
 params: ExecuteAgentParams,
 payload: P,
 agentTypeState: ATS,
): Promise<BaseAgentNextStep>
Determines how to handle Success or Failed steps when no explicit termination is requested.

This allows agent types to control their own fallback behavior:
- Loop agents use default behavior (return null) to process results with their main prompt
- Flow agents should terminate instead of falling back to prompts (return terminate step)
- Pipeline agents might want to move to the next stage
Default implementation returns null, which causes base-agent to fall back to prompt execution if prompts are configured. Agent types can override this to provide custom behavior.
Type Parameters
- P = any
- ATS = any
Parameters
- step: BaseAgentNextStep
 The Success or Failed step that needs fallback handling
- config: AgentConfiguration
 The loaded agent configuration
- params: ExecuteAgentParams
 The execution parameters
- payload: P
 The current payload
- agentTypeState: ATS
 Agent type's state
Returns Promise<BaseAgentNextStep>
Custom step to execute, or null for default behavior

Since
2.113.0
Inherited from BaseAgentType.HandleStepFallback
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:513

InitializeAgentTypeState

InitializeAgentTypeState<ATS = any, P = any>(
params: ExecuteAgentParams<any, P>,
): Promise<ATS>
This method allows each agent type to initialize its agent-run-specific state package as required. Not all agent types require this and are able to live off just the current payload or other properties passed to them to DetermineNextStep(), but some require more complex internal state tracking.
Type Parameters
- ATS = any
- P = any
Parameters
- params: ExecuteAgentParams<any, P>
 the agent execution params
Returns Promise<ATS>
the fully initialized initial agent-type state
Overrides BaseAgentType.InitializeAgentTypeState
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:126

InjectPayload

InjectPayload<T = any, ATS = any>(
 payload: T,
 agentTypeState: ATS,
 prompt: AIPromptParams,
 agentInfo: { agentId: string; agentRunId?: string },
): Promise<void>
Injects a payload into the prompt parameters. For LoopAgentType, this could be used to inject previous loop results or context.
Type Parameters
- T = any
- ATS = any
Parameters
- payload: T
 The payload to inject
- agentTypeState: ATS
- prompt: AIPromptParams
 The prompt parameters to update
- agentInfo: { agentId: string; agentRunId?: string }
 Agent identification info (unused by LoopAgentType)
Returns Promise<void>
Overrides BaseAgentType.InjectPayload
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:567

`Protected`isValidLoopResponse

isValidLoopResponse(
simpleResponse: unknown,
): { message?: string; success: boolean }
Protected
Validates that the response conforms to the expected LoopAgentResponse structure.
Parameters
- simpleResponse: unknown
Returns { message?: string; success: boolean }
True if the response is valid, false otherwise
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:416

`Protected`parseJSONResponse

parseJSONResponse<T>(promptResult: AIPromptRunResult): T
Protected
Parses JSON response from prompt execution with automatic validation syntax cleaning
Type Parameters
- T
 The expected response type
Parameters
- promptResult: AIPromptRunResult
 The prompt execution result
Returns T
Parsed response or null if parsing fails
Inherited from BaseAgentType.parseJSONResponse
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:291

PostProcessActionStep

PostProcessActionStep(
 actionResults: ActionResult[],
 actions: AgentAction[],
 currentPayload: P,
 agentTypeState: ATS,
 currentStep: BaseAgentNextStep,
): Promise<AgentPayloadChangeRequest>
Post-processes the result of action execution.

This method is called by BaseAgent after action(s) have been executed. Agent types can override this method to perform custom processing of action results, such as mapping output parameters to the payload or storing results in agent-specific context.
Type Parameters
- P = any
- ATS = any
Parameters
- actionResults: ActionResult[]
 The results from action execution
- actions: AgentAction[]
 The actions that were executed
- currentPayload: P
 The current payload
- agentTypeState: ATS
- currentStep: BaseAgentNextStep
 The current step being executed
Returns Promise<AgentPayloadChangeRequest>
Optional payload change request

Since
2.76.0
Inherited from BaseAgentType.PostProcessActionStep
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:423

PostProcessSubAgentStep

PostProcessSubAgentStep(
 subAgentResult: any,
 subAgentRequest: AgentSubAgentRequest,
 currentPayload: P,
 agentTypeState: ATS,
 currentStep: BaseAgentNextStep,
): Promise<AgentPayloadChangeRequest>
Post-processes the result of sub-agent execution.

This method is called by BaseAgent after a sub-agent has been executed. Agent types can override this method to perform custom processing of sub-agent results, such as extracting specific data from the sub-agent's payload or updating context.
Type Parameters
- P = any
- ATS = any
Parameters
- subAgentResult: any
 The result from sub-agent execution
- subAgentRequest: AgentSubAgentRequest
 The sub-agent request that was executed
- currentPayload: P
 The current payload
- agentTypeState: ATS
- currentStep: BaseAgentNextStep
 The current step being executed
Returns Promise<AgentPayloadChangeRequest>
Optional payload change request

Since
2.76.0
Inherited from BaseAgentType.PostProcessSubAgentStep
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:451

PreProcessActionStep

PreProcessActionStep(
 actions: AgentAction[],
 currentPayload: P,
 agentTypeState: ATS,
 currentStep: BaseAgentNextStep,
 params?: ExecuteAgentParams,
): Promise<void>
Pre-processes action parameters to resolve conversation references.

Loop agents get action parameters directly from the LLM's JSON response. This method resolves any "conversation.*" references in those parameters before the actions are executed.
Type Parameters
- P = any
- ATS = any
Parameters
- actions: AgentAction[]
 The actions that will be executed (modified in place)
- currentPayload: P
 The current payload
- agentTypeState: ATS
 The agent type state
- currentStep: BaseAgentNextStep
 The current step being executed
- Optionalparams: ExecuteAgentParams
 The execution parameters with conversation messages
Returns Promise<void>
Actions are modified in place

Since
2.120.0
Overrides BaseAgentType.PreProcessActionStep
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:660

PreProcessNextStep

PreProcessNextStep(
 params: ExecuteAgentParams,
 step: BaseAgentNextStep,
 payload: P,
 agentTypeState: ATS,
): Promise<BaseAgentNextStep>
Pre-processes steps for loop agent types.

Loop agents use the default next step behavior which executes the prompt again.
Type Parameters
- P = any
- ATS = any
Parameters
- params: ExecuteAgentParams
 The full execution parameters
- step: BaseAgentNextStep
 The step that needs to be preprocessed
- payload: P
- agentTypeState: ATS
Returns Promise<BaseAgentNextStep>
Always returns null to use default behavior

Since
2.76.0
Overrides BaseAgentType.PreProcessNextStep
- Defined in AI/Agents/src/agent-types/loop-agent-type.ts:609

`Protected` `Static`getAgentInstanceWithDriverClass

getAgentInstanceWithDriverClass(driverClass: string): Promise<BaseAgentType>
Protected
Instantiates an agent type class using a specific driver class name.

This method is used when an individual agent has its own DriverClass override, allowing for specialized implementations per agent instance.
Parameters
- driverClass: string
 The driver class name to instantiate
Returns Promise<BaseAgentType>
Instance of the agent type class
Inherited from BaseAgentType.getAgentInstanceWithDriverClass
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:266

`Protected` `Static`getAgentTypeInstance

getAgentTypeInstance(agentType: MJAIAgentTypeEntity): Promise<BaseAgentType>
Protected
Instantiates the appropriate agent type class based on the agent type entity.

This method uses the MemberJunction class factory to dynamically instantiate agent type classes. It uses the DriverClass field. If DriverClass is not specified it throws an error.
Parameters
- agentType: MJAIAgentTypeEntity
 The agent type entity to instantiate
Returns Promise<BaseAgentType>
Instance of the agent type class
Example
```
// For an agent type with DriverClass "LoopAgentType"
const agentTypeInstance = await this.getAgentTypeInstance(loopAgentType);

@protected
```
Inherited from BaseAgentType.getAgentTypeInstance
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:244

`Static`GetAgentTypeInstance

GetAgentTypeInstance(agentType: MJAIAgentTypeEntity): Promise<BaseAgentType>
Helper method that retrieves an instance of the agent type based on the provided agent type entity.

This method uses the ClassFactory to create an instance of the agent type class specified in the DriverClass field of the agent type entity. If the DriverClass is not specified, it throws an error.
Parameters
- agentType: MJAIAgentTypeEntity
 The agent type entity to instantiate
Returns Promise<BaseAgentType>
An instance of the agent type class

Async
Static
Method
GetAgentTypeInstance

Throws
If the agent type does not have a DriverClass specified or if instantiation fails
Inherited from BaseAgentType.GetAgentTypeInstance
- Defined in AI/Agents/src/agent-types/base-agent-type.ts:216

Class LoopAgentType

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns LoopAgentType

Properties

Protected_jsonValidator

Static ReadonlyCURRENT_PAYLOAD_PLACEHOLDER

Static

Accessors

InjectLoopResultsAsMessage

Returns boolean

Since

RequiresAgentLevelPrompts

Returns boolean

Since

Methods

OptionalAfterLoopIteration

Type Parameters

Parameters

Returns P

Since

OptionalBeforeLoopIteration

Type Parameters

Parameters

Returns { actionParams?: Record<string, unknown>; payload?: P; subAgentRequest?: { message: string; name: string; templateParameters?: Record<string, string>; };}

Since

ProtectedcreateNextStep

Type Parameters

Parameters

Returns BaseAgentNextStep<P>

ProtectedcreateRetryStep

Type Parameters

Parameters

Returns BaseAgentNextStep<P>

ProtectedcreateSuccessStep

Type Parameters

Parameters

Returns BaseAgentNextStep<P>

DetermineInitialStep

Type Parameters

Parameters

Returns Promise<BaseAgentNextStep<P>>

Since

DetermineNextStep

Type Parameters

Parameters

Returns Promise<BaseAgentNextStep<P>>

Throws

GetPromptConfigurationGuidance

Returns string

Since

GetPromptForStep

Type Parameters

Parameters

Returns Promise<MJAIPromptEntityExtended>

Since

HandleStepFallback

Type Parameters

Parameters

Returns Promise<BaseAgentNextStep<P>>

Since

InitializeAgentTypeState

Type Parameters

Parameters

Returns Promise<ATS>

InjectPayload

Type Parameters

Parameters

Returns Promise<void>

ProtectedisValidLoopResponse

Parameters

Returns { message?: string; success: boolean }

ProtectedparseJSONResponse

`Protected`_jsonValidator

`Static` `Readonly`CURRENT_PAYLOAD_PLACEHOLDER

`Optional`AfterLoopIteration

`Optional`BeforeLoopIteration

Returns {
actionParams?: Record<string, unknown>;
payload?: P;
subAgentRequest?: {
message: string;
name: string;
templateParameters?: Record<string, string>;
};
}

`Protected`createNextStep

`Protected`createRetryStep

`Protected`createSuccessStep

`Protected`isValidLoopResponse

`Protected`parseJSONResponse

`Protected` `Static`getAgentInstanceWithDriverClass

`Protected` `Static`getAgentTypeInstance

`Static`GetAgentTypeInstance