Embabel Agent Documentation/com.embabel.agent.api.annotation/Agent

Agent

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Agent(val name: String = "", val provider: String = "", val description: String, val version: String = DEFAULT_VERSION, val planner: Planner = Planner.GOAP, val scan: Boolean = true, val beanName: String = "", val opaque: Boolean = false)

Indicates that this class is an agent. It doesn't just contribute actions, goals and conditions: it is an agent in itself. This is a Spring stereotype annotation, so annotated classes will be picked up on the classpath and injected Either @Agent or @AgentCapabilities should be used: not both

Parameters

name

Name of the agent. If not provided, the name will be the class simple name

provider

provider of the agent. If not provided, will default to the package this annotation is used in

description

Description of the agent. Required. This is used for documentation purposes and to choose an agent

version

Version of the agent

planner

The type of planning this agent uses. Defaults to GOAP (Goal Oriented Action Planning).

scan

Whether to find this agent in the classpath. If false, it will not be found by the agent manager. Defaults to true

beanName

The value may indicate a suggestion for a logical component name, to be turned into a Spring bean in case of an autodetected component. Use only if there's the likelihood of conflict with the default bean name.

opaque

Whether to hide the agent's actions and conditions