ProcessOptions

data class ProcessOptions constructor(val contextId: ContextId? = null, val identities: Identities = Identities(), val blackboard: Blackboard? = null, val verbosity: Verbosity = Verbosity(), val budget: Budget = Budget(), val processControl: ProcessControl = ProcessControl( toolDelay = Delay.NONE, operationDelay = Delay.NONE, earlyTerminationPolicy = budget.earlyTerminationPolicy(), ), val prune: Boolean = false, val listeners: List<AgenticEventListener> = emptyList(), val outputChannel: OutputChannel = DevNullOutputChannel, val plannerType: PlannerType = PlannerType.GOAP)

How to run an AgentProcess Create and customize using withers

Parameters

contextId

context id to use for this process. Can be null. If set it can enable connection to external resources and persistence from previous runs.

identities

identities associated with this process.

blackboard

an existing blackboard to use for this process. By default, it will be modified as the process runs. Whether this is an independent copy is up to the caller, who can call spawn() before passing this argument.

budget

budget constraints for this process. Will be exposed to actions and tools and enforced by default ProcessControl.

processControl

custom ProcessControl if specified. If not specified, default will be based on Budget. If specified, this overrides the budget-based defaults and may not relate to the budget.

verbosity

detailed verbosity settings for logging etc.

prune

whether to prune the agent to only relevant actions

listeners

additional listeners (beyond platform event listeners) to receive events from this process.

outputChannel

custom output channel to use for this process.

plannerType

the type of planner to use for this process. Defaults to GOAP planner.

Constructors

Link copied to clipboard
constructor(contextId: ContextId? = null, identities: Identities = Identities(), blackboard: Blackboard? = null, verbosity: Verbosity = Verbosity(), budget: Budget = Budget(), processControl: ProcessControl = ProcessControl( toolDelay = Delay.NONE, operationDelay = Delay.NONE, earlyTerminationPolicy = budget.earlyTerminationPolicy(), ), prune: Boolean = false, listeners: List<AgenticEventListener> = emptyList(), outputChannel: OutputChannel = DevNullOutputChannel, plannerType: PlannerType = PlannerType.GOAP)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val blackboard: Blackboard? = null
Link copied to clipboard
Link copied to clipboard
val contextId: ContextId? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val prune: Boolean = false
Link copied to clipboard

Functions

Link copied to clipboard

Get the context ID as a String for Java interop.

Link copied to clipboard

Add an additional early termination policy to this process. This is normally what you want rather than replacing the existing policy,

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Add an additional listener to this process.

Link copied to clipboard

Add additional listeners to this process.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard