agents::Agent Class Reference

Interface for agents. More...

#include <agent.h>

Inheritance diagram for agents::Agent:

Classes
struct	Options
	Agent execution options. More...

Public Types
enum class	State {   READY ,   RUNNING ,   WAITING ,   COMPLETED ,   FAILED ,   STOPPED }
	Agent execution state. More...

Public Member Functions
	Agent (std::shared_ptr< Context > context)
	Constructor.
virtual	~Agent ()=default
	Destructor.
virtual void	init ()=0
	Initialize the agent.
virtual Task< JsonObject >	run (const std::string &task)=0
	Run the agent with a task using coroutines.
virtual void	runAsync (const std::string &task, std::function< void(const JsonObject &)> callback)
	Run the agent with a callback.
virtual void	stop ()
	Stop the agent.
std::shared_ptr< Context >	getContext () const
	Get the agent's context.
State	getState () const
	Get the agent's current state.
void	setOptions (const Options &options)
	Set execution options.
const Options &	getOptions () const
	Get execution options.
void	setStatusCallback (std::function< void(const std::string &)> callback)
	Set a callback for status updates.
virtual void	provideFeedback (const std::string &feedback)
	Provide human feedback.
virtual Task< std::string >	waitForFeedback (const std::string &message, const JsonObject &context)
	Wait for feedback using coroutines.

Detailed Description

Interface for agents.

Agents are LLM-powered systems that can use tools and make decisions to accomplish a task.

Member Enumeration Documentation

State

enum class agents::Agent::State

strong

Agent execution state.

Enumerator
READY	Ready to start execution.
RUNNING	Currently executing.
WAITING	Waiting for human input.
COMPLETED	Execution completed successfully.
FAILED	Execution failed.
STOPPED	Execution stopped by user.

Constructor & Destructor Documentation

Agent()

agents::Agent::Agent

(

std::shared_ptr< Context >

context

)

Constructor.

Parameters

context

The agent context

Member Function Documentation

getContext()

std::shared_ptr< Context > agents::Agent::getContext

(

)

const

Get the agent's context.

Returns

The agent context

getOptions()

const Options & agents::Agent::getOptions

(

)

const

Get execution options.

Returns

The execution options

getState()

State agents::Agent::getState

(

)

const

Get the agent's current state.

Returns

The agent state

init()

virtual void agents::Agent::init ( )

pure virtual

Initialize the agent.

Implemented in agents::ActorAgent, agents::AutonomousAgent, and agents::VoiceAgent.

provideFeedback()

virtual void agents::Agent::provideFeedback ( const std::string & feedback )

virtual

Provide human feedback.

Parameters

feedback

The feedback to provide

Reimplemented in agents::ActorAgent, and agents::AutonomousAgent.

run()

virtual Task< JsonObject > agents::Agent::run ( const std::string & task )

pure virtual

Run the agent with a task using coroutines.

Parameters

task	The task to run

Returns

The result of the task

Implemented in agents::ActorAgent, and agents::AutonomousAgent.

runAsync()

virtual void agents::Agent::runAsync ( const std::string & task, std::function< void(const JsonObject &)> callback )

virtual

Run the agent with a callback.

Parameters

task	The task to run
callback	The callback to run

Reimplemented in agents::ActorAgent, and agents::AutonomousAgent.

setOptions()

void agents::Agent::setOptions

(

const Options &

options

)

Set execution options.

Parameters

options

The execution options

setStatusCallback()

void agents::Agent::setStatusCallback

(

std::function< void(const std::string &)>

callback

)

Set a callback for status updates.

Parameters

callback

The callback to set

Examples

simple_agent.cpp.

stop()

virtual void agents::Agent::stop ( )

virtual

Stop the agent.

Reimplemented in agents::ActorAgent, and agents::AutonomousAgent.

waitForFeedback()

virtual Task< std::string > agents::Agent::waitForFeedback ( const std::string & message, const JsonObject & context )

inlinevirtual

Wait for feedback using coroutines.

Parameters

message	The message to wait for feedback
context	The context to wait for feedback

Returns

The feedback

Reimplemented in agents::ActorAgent, and agents::AutonomousAgent.