A workflow that runs multiple tasks in parallel. More...

#include <parallelization_workflow.h>

Inheritance diagram for agents::workflows::ParallelizationWorkflow:

Classes
struct	Task
	Task definition for parallel execution. More...

Public Types
enum class	Strategy { SECTIONING , VOTING }
	Enum for parallelization strategy. More...

Public Member Functions
	ParallelizationWorkflow (std::shared_ptr< Context > context, Strategy strategy=Strategy::SECTIONING)
	Constructor with context.
virtual	~ParallelizationWorkflow ()=default
	Destructor.
void	addTask (const Task &task)
	Add a task to the workflow.
void	addTask (const std::string &name, const std::string &prompt_template, const JsonObject &context=JsonObject())
	Add a task to the workflow with basic params.
void	addTask (const std::string &name, const std::string &prompt_template, std::function< std::string(const std::string &)> prompt_fn, std::function< JsonObject(const std::string &)> result_parser, const JsonObject &context=JsonObject())
	Add a task to the workflow with generators and parser.
void	setAggregator (std::function< JsonObject(const std::vector< JsonObject > &)> aggregator)
	Set the aggregation function for task results.
void	setStrategy (Strategy strategy)
	Set the strategy.
void	init ()
	Initialize the workflow.
void	setVotingThreshold (double threshold)
	Set the voting threshold (for VOTING mode).
JsonObject	run (const std::string &input) override
	Execute the workflow with input.
JsonObject	run ()
	Execute using the latest USER message from context memory.
virtual void	runAsync (const std::string &input, std::function< void(const JsonObject &)> callback)
	Run the workflow with a user input asynchronously.
std::shared_ptr< Context >	getContext () const
	Get the workflow's context.
void	setStepCallback (std::function< void(const std::string &, const JsonObject &)> callback)
	Set a callback for intermediate steps.
void	setMaxSteps (int max_steps)
	Set maximum number of steps.
int	getMaxSteps () const
	Get maximum number of steps.

Detailed Description

A workflow that runs multiple tasks in parallel.

This workflow allows LLMs to work simultaneously on a task and have their outputs aggregated. It supports two key variations:

Sectioning: Breaking a task into independent subtasks run in parallel
Voting: Running the same task multiple times to get diverse outputs

Examples: parallel_example.cpp.

Member Enumeration Documentation

◆ Strategy

enum class agents::workflows::ParallelizationWorkflow::Strategy

strong

Enum for parallelization strategy.

Note: This is an enum for the parallelization strategy. It contains the SECTIONING and VOTING strategies.

Enumerator
SECTIONING	Break task into independent subtasks.
VOTING	Run same task multiple times for consensus.

Examples: parallel_example.cpp.

Constructor & Destructor Documentation

◆ ParallelizationWorkflow()

agents::workflows::ParallelizationWorkflow::ParallelizationWorkflow	(	std::shared_ptr< Context >	context,
		Strategy	strategy = Strategy::SECTIONING )

Constructor with context.

Parameters

context	The context of the workflow
strategy	The strategy of the workflow

Member Function Documentation

◆ addTask() [1/3]

void agents::workflows::ParallelizationWorkflow::addTask	(	const std::string &	name,
		const std::string &	prompt_template,
		const JsonObject &	context = JsonObject() )

Add a task to the workflow with basic params.

Parameters

name	The name of the task
prompt_template	The prompt template of the task
context	The context of the task

◆ addTask() [2/3]

void agents::workflows::ParallelizationWorkflow::addTask	(	const std::string &	name,
		const std::string &	prompt_template,
		std::function< std::string(const std::string &)>	prompt_fn,
		std::function< JsonObject(const std::string &)>	result_parser,
		const JsonObject &	context = JsonObject() )

Add a task to the workflow with generators and parser.

Parameters

name	The name of the task
prompt_template	The prompt template of the task
prompt_fn	The prompt function of the task
result_parser	The result parser of the task
context	The context of the task

◆ addTask() [3/3]

void agents::workflows::ParallelizationWorkflow::addTask ( const Task & task )

Add a task to the workflow.

Parameters

task	The task to add

Examples: parallel_example.cpp.

◆ getContext()

std::shared_ptr< Context > agents::workflows::Workflow::getContext ( ) const

inherited

Get the workflow's context.

Returns: The context

◆ getMaxSteps()

int agents::workflows::Workflow::getMaxSteps ( ) const

inherited

Get maximum number of steps.

Returns: The maximum number of steps

◆ run() [1/2]

JsonObject agents::workflows::ParallelizationWorkflow::run ( )

Execute using the latest USER message from context memory.

Returns: The output of the workflow

◆ run() [2/2]

JsonObject agents::workflows::ParallelizationWorkflow::run ( const std::string & input )

overridevirtual

Execute the workflow with input.

Parameters

input The input to the workflow

Returns: The output of the workflow

Implements agents::workflows::Workflow.

Examples: parallel_example.cpp.

◆ runAsync()

virtual void agents::workflows::Workflow::runAsync	(	const std::string &	input,
		std::function< void(const JsonObject &)>	callback )

virtualinherited

Run the workflow with a user input asynchronously.

Parameters

input	The user input
callback	The callback

◆ setAggregator()

void agents::workflows::ParallelizationWorkflow::setAggregator ( std::function< JsonObject(const std::vector< JsonObject > &)> aggregator )

Set the aggregation function for task results.

Parameters

aggregator The aggregation function

Examples: parallel_example.cpp.

◆ setMaxSteps()

void agents::workflows::Workflow::setMaxSteps ( int max_steps )

inherited

Set maximum number of steps.

Parameters

max_steps The maximum number of steps

◆ setStepCallback()

void agents::workflows::Workflow::setStepCallback ( std::function< void(const std::string &, const JsonObject &)> callback )

inherited

Set a callback for intermediate steps.

Parameters

callback The callback

Examples: prompt_chain_example.cpp.

◆ setStrategy()

void agents::workflows::ParallelizationWorkflow::setStrategy ( Strategy strategy )

Set the strategy.

Parameters

strategy The strategy

◆ setVotingThreshold()

void agents::workflows::ParallelizationWorkflow::setVotingThreshold ( double threshold )

Set the voting threshold (for VOTING mode).

Parameters

threshold The threshold

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Strategy

Constructor & Destructor Documentation

◆ ParallelizationWorkflow()

Member Function Documentation

◆ addTask() [1/3]

◆ addTask() [2/3]

◆ addTask() [3/3]

◆ getContext()

◆ getMaxSteps()

◆ run() [1/2]

◆ run() [2/2]

◆ runAsync()

◆ setAggregator()

◆ setMaxSteps()

◆ setStepCallback()

◆ setStrategy()

◆ setVotingThreshold()