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

AgentPlatform

An AgentPlatform can run agents. It can also act as an agent itself, drawing on all of its agents as its own actions, goals, and conditions. An AgentPlatform is stateful, as agents can be deployed to it. See TypedOps for a higher level API with typed I/O. Typically, there is one AgentPlatform per Spring Boot application, with agents discovered by classpath scanning for @Agent annotations, but this is not a requirement.

Properties

actions

open override val actions: List<Action>

conditions

open override val conditions: Set<Condition>

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>

goals

open override val goals: Set<Goal>

jvmTypes

open val jvmTypes: Collection<JvmType>

opaque

abstract val opaque: Boolean

Whether to hide the agent's actions and conditions from the outside world, defaults to false.

platformServices

abstract val platformServices: PlatformServices

toolGroupResolver

abstract val toolGroupResolver: ToolGroupResolver

Functions

agents

abstract fun agents(): List<Agent>

createAgent

open fun createAgent(name: String, provider: String, description: String): Agent

Create a new agent from the given scope

createAgentProcess

abstract fun createAgentProcess(agent: Agent, processOptions: ProcessOptions, bindings: Map<String, Any>): AgentProcess

Create an agent process with the given options and bindings. The process will not be started automatically, so this will return quickly, unlike the run method on the created process. AgentProcess status will be NOT_STARTED.

createAgentProcessFrom

open fun createAgentProcessFrom(agent: Agent, processOptions: ProcessOptions, vararg objectsToAdd: Any): AgentProcess

Create an agent process with the given options and bind all arguments.

createChildProcess

abstract fun createChildProcess(agent: Agent, parentAgentProcess: AgentProcess): AgentProcess

deploy

abstract fun deploy(agent: Agent): AgentPlatform

open fun deploy(agentScope: AgentScope): AgentPlatform

deployAnnotatedInstances

fun AgentPlatform.deployAnnotatedInstances(agentMetadataReader: AgentMetadataReader, vararg instances: Any)

Convenient method to deploy instances to an agent platform

getAgentProcess

abstract fun getAgentProcess(id: String): AgentProcess?

Find an agent process by id. Implementations are only obliged to resolve running processes, although they may choose to return older processes.

infoString

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

killAgentProcess

abstract fun killAgentProcess(id: String): AgentProcess?

Kill an agent process by id. Return the killed process, or null if no such process was found.

resolveType

open fun resolveType(name: String): DomainType

runAgentFrom

abstract fun runAgentFrom(agent: Agent, processOptions: ProcessOptions = ProcessOptions(), bindings: Map<String, Any>): AgentProcess

Run the agent from the given ProcessOptions. We might create a new blackboard or have one

runAgentWithInput

open fun ~~runAgentWithInput~~(agent: Agent, processOptions: ProcessOptions = ProcessOptions(), input: Any): AgentProcess

Run the given agent with the given input, which will be added to the blackboard with the default binding.

start

open fun start(agentProcess: AgentProcess): CompletableFuture<AgentProcess>

Run the given agent process in the background