Embabel Agent Documentation/com.embabel.agent.core/Action

Action

interface Action : DataFlowStep, ConditionAction, ActionRunner, DataDictionary, ToolGroupConsumer

Core Action model in Agent system. An individual action step used in an Agent Not intended for direct use by application code. User applications should use the annotation programming model with @Agentic and @Action or the Kotlin DSL, or a non-code representation such as YML.

Inheritors

AbstractAction

Properties

canRerun

abstract val canRerun: Boolean

Can this action be run again if it has already run in the given AgentProcess? Must be set to true to allow looping style behavior.

cost

abstract val cost: CostComputation

Cost of performing this action Must be between 0 and 1 1 is the most expensive imaginable.

domainTypes

open override val domainTypes: Collection<DomainType>

All known types referenced by this component. These may or may not be backed by JVM objects.

dynamicTypes

open val dynamicTypes: Collection<DynamicType>

effects

abstract val effects: EffectSpec

Expected effects of this action. World state should be checked afterward as these effects may not have been achieved

inputs

abstract val inputs: Set<IoBinding>

Data inputs to this step. Will be used to build preconditions, in addition to explicit preconditions.

jvmTypes

open val jvmTypes: Collection<JvmType>

knownConditions

abstract val knownConditions: Set<String>

The names of all conditions that are referenced by this step

name

abstract val name: String

Unique name of the step

outputs

abstract val outputs: Set<IoBinding>

Expected data outputs of the step.

preconditions

abstract val preconditions: EffectSpec

Conditions that must be true for this step to execute

qos

abstract val qos: ActionQos

Quality of Service for this action.

toolGroups

abstract val toolGroups: Set<ToolGroupRequirement>

Tool groups exposed. This will include directly registered tool groups and tool groups resolved from ToolGroups.

value

abstract val value: CostComputation

Function to compute the value of completing this step. From 0 (least valuable) to 1 (most valuable) Steps with 0 value will still be planned if necessary to achieve a result

Functions

allowedRelationships

open fun allowedRelationships(): List<AllowedRelationship>

Get all relationships between domain types in this dictionary. A relationship is a property that references another DomainType (not a simple property).

domainTypeForLabels

open fun domainTypeForLabels(labels: Set<String>): DomainType?

The domain type matching these labels, if we have one

execute

abstract fun execute(processContext: ProcessContext): ActionStatus

Execute an action

infoString

open override fun infoString(verbose: Boolean?, indent: Int): String

isAchievable

open fun isAchievable(currentState: ConditionWorldState): Boolean

Whether the step is available in the current world state

referencedInputProperties

abstract fun referencedInputProperties(variable: String): Set<String>

Properties referenced from input variable Say "person" is passed. Return "name" and other references

shortName

open fun shortName(): String