Embabel Agent Documentation/com.embabel.agent.core.support/AbstractAgentProcess

AbstractAgentProcess

abstract class AbstractAgentProcess(val id: String, val parentId: String?, val agent: Agent, processOptions: ProcessOptions, blackboard: Blackboard, platformServices: PlatformServices, val timestamp: Instant = Instant.now()) : AgentProcess, Blackboard

Abstract implementation of AgentProcess that provides common functionality

Constructors

constructor(id: String, parentId: String?, agent: Agent, processOptions: ProcessOptions, blackboard: Blackboard, platformServices: PlatformServices, timestamp: Instant = Instant.now())

Properties

agent

open override val agent: Agent

The agent that this process is running. Many processes can run the same agent.

blackboardId

open override val blackboardId: String

Unique identifier of this blackboard. Blackboard doesn't extend StableIdentified to avoid conflict with implementations that are otherwise identified

failureInfo

open override val failureInfo: Any?

If we failed, this may contain the reason for the failure.

goal

open override val goal: Goal?

Goal of this process.

history

open override val history: List<ActionInvocation>

open override val id: String

Unique id of this process

lastWorldState

open override val lastWorldState: WorldState?

The last world state that was used to plan the next action Will be non-null if the process is running

llmInvocations

abstract val llmInvocations: List<LlmInvocation>

objects

open override val objects: List<Any>

Entries in the order they were added. The default instance of any type is the last one Objects are immutable and may not be removed.

parentId

open override val parentId: String?

planner

abstract val planner: Planner<*, *, *>

Get the planner for this process

processContext

open override val processContext: ProcessContext

runningTime

open val runningTime: Duration

How long this process has been running

status

open override val status: AgentProcessStatusCode

Status of this operation

timestamp

open val timestamp: Instant

toolsStats

open override val toolsStats: ToolsStats

Functions

addAll

open override fun addAll(objects: List<Any>)

addObject

open override fun addObject(value: Any): Bindable

Add to entries without binding to a variable name. Implementations must respect the order in which entities were added. This is equivalent to using the default binding name as the key. For example, if you add a Dog to the blackboard without a key, it will be bound to the default binding name "it" and will be the last entry in the list of objects. Equivalent:

all

inline fun <T> Blackboard.all(): List<T>

Return all entries of a specific type

fun <T> Blackboard.all(clazz: Class<T>): List<T>

bind

open override fun bind(key: String, value: Any): Bindable

bindAll

open override fun bindAll(bindings: Map<String, Any>)

cost

open fun cost(): Double

costInfoString

open fun costInfoString(verbose: Boolean): String

count

open override fun <T> count(clazz: Class<T>): Int

count

inline fun <T> Blackboard.count(): Int

Count entries of the given type

expressionEvaluationModel

open override fun expressionEvaluationModel(): Map<String, Any>

Expose the model data for use in prompts Prefer more strongly typed usage patterns

get

open operator override fun get(name: String): Any?

Return the value of a variable, if it is set. Does not limit return via type information.

getCondition

open override fun getCondition(key: String): Boolean?

getValue

open override fun getValue(variable: String, type: String, dataDictionary: DataDictionary): Any?

Resolve the value of a variable, if it is set. Resolve superclasses For example, getValue("it", "Animal") will match a Dog if Dog extends Animal

kill

open override fun kill(): ProcessKilledEvent?

Kill this process and return an event describing the kill if we are successful

last

open override fun <T> last(clazz: Class<T>): T?

Last entry of the given type, if there is one

last

inline fun <T> Blackboard.last(): T?

Last entry of the given type, if there is one

lastOrNull

inline fun <T> Blackboard.lastOrNull(predicate: (t: T) -> Boolean): T?

fun <T> Blackboard.lastOrNull(clazz: Class<T>, predicate: (t: T) -> Boolean): T?

lastResult

open override fun lastResult(): Any?

Last result, of any type, if there is one.

modelsUsed

open fun modelsUsed(): List<<Error class: unknown class>>

Distinct list of LLMs use, sorted by name.

plusAssign

open operator override fun plusAssign(pair: <Error class: unknown class><String, Any>)

open operator override fun plusAssign(value: Any)

recordLlmInvocation

abstract fun recordLlmInvocation(llmInvocation: LlmInvocation)

resultOfType

open fun <O> resultOfType(outputClass: Class<O>): O

resultOfType

inline fun <O> AgentProcess.resultOfType(): O

Convenience function to get the result of a specific type

run

open override fun run(): AgentProcess

Run the process as far as we can. Might complete, fail, get stuck or hit a waiting state. This is a slow operation. We may wish to run this async. Events will be emitted as the process runs, so we can track progress.

set

open operator override fun set(key: String, value: Any)

Bind a value to a name

setCondition

open override fun setCondition(key: String, value: Boolean): Blackboard

Explicitly set the condition value Used in planning.

spawn

open override fun spawn(): Blackboard

Spawn an independent child blackboard based on the content of this

statusReport

open fun statusReport(): AgentProcessStatusReport

Return a serializable status report for this process.

tick

open override fun tick(): AgentProcess

Perform the next step only. Return when an action has been completed and the process is ready to plan, regardless of the result of the action.

usage

open fun usage(): <Error class: unknown class>

Note that this is not apples to apples: The usage may be across different LLMs, and the cost may be different. Cost will correctly reflect this. Look in the list for more details about what tokens were spent where.