agents::workflows::Workflow Class Reference

Abstract base class for workflows. More...

#include <workflow.h>

Inheritance diagram for agents::workflows::Workflow:

Public Member Functions
	Workflow (std::shared_ptr< Context > context)
	Constructor.
	~Workflow ()=default
	Destructor.
virtual JsonObject	run (const std::string &input)=0
	Run the workflow with a user input and return the result.
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

Abstract base class for workflows.

A workflow is a pattern for executing a series of LLM operations to accomplish a task.

Constructor & Destructor Documentation

Workflow()

agents::workflows::Workflow::Workflow

(

std::shared_ptr< Context >

context

)

Constructor.

Parameters

context

The context

Member Function Documentation

getContext()

std::shared_ptr< Context > agents::workflows::Workflow::getContext

(

)

const

Get the workflow's context.

Returns

The context

getMaxSteps()

int agents::workflows::Workflow::getMaxSteps

(

)

const

Get maximum number of steps.

Returns

The maximum number of steps

run()

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

pure virtual

Run the workflow with a user input and return the result.

Parameters

input

The user input

Returns

The result

Implemented in agents::workflows::EvaluatorWorkflow, agents::workflows::OrchestratorWorkflow, agents::workflows::ParallelizationWorkflow, agents::workflows::PromptChainingWorkflow, and agents::workflows::RoutingWorkflow.

runAsync()

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

virtual

Run the workflow with a user input asynchronously.

Parameters

input	The user input
callback	The callback

setMaxSteps()

void agents::workflows::Workflow::setMaxSteps

(

int

max_steps

)

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

)

Set a callback for intermediate steps.

Parameters

callback

The callback

Examples

prompt_chain_example.cpp.