agent-lifecycle

Agent Lifecycle

One of the most powerful features of Synapse is the Agent Lifecycle, which governs how an agent executes its tasks and allows for modification at various stages.

PendingAgentTask

The PendingAgentTask class drives the agent's execution and stores all information about the current run. This class provides several public methods that can be accessed and modified:

• addInput(string $key, mixed $value): Adds an input to the array used to generate the prompt.
• agent(): Returns the agent instance.
• currentIteration(): Returns the CurrentIteration object containing the raw response and message.
• inputs(): Retrieves the current input array.
• getInput(string $key): Retrieves a specific input by key.
• iterationMemory(): Accesses the agent's memory for the current task.
• tools(): Retrieves the tools available to the agent.

Lifecycle

The agent lifecycle is divided into the following stages:

Initialize Agent

The agent is set up, and all hooks are initialized.

To modify the agent at this stage, use the HasBootAgentHook in the Hook Traits section.

Code Calls the handle Method

The handle method is invoked, a new CurrentIteration is created, and the inputs and extraAgentArgs are set.

$simpleAgent = new SimpleAgent;
$result = $agent->handle(['input' => 'hello!'], ['model' => 'gpt-4o-mini']); // [!code highlight]

To modify the agent at this stage, use the HasStartThreadHook in the Hook Traits section.

Start 'Iteration Loop'

The 'Iteration Loop' begins by executing the StartIterationPipeline. Each loop iteration triggers all pipelines, which are executed multiple times if the agent calls multiple tools.

To modify the agent at this stage, use the HasStartIterationHook in the Hook Traits section.

Get Prompt

The agent combines the view with inputs to create the prompt.

To modify the agent at this stage, use the HasPromptGeneratedHook in the Hook Traits section.