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

DefaultAgentPlatform

open class DefaultAgentPlatform(val name: String, val description: String, val processType: AgentPlatformProperties.ProcessType, llmOperations: LlmOperations, val toolGroupResolver: ToolGroupResolver, eventListener: AgenticEventListener, agentProcessIdGenerator: AgentProcessIdGenerator = AgentProcessIdGenerator.RANDOM, contextRepository: ContextRepository = InMemoryContextRepository(), agentProcessRepository: AgentProcessRepository = InMemoryAgentProcessRepository(), operationScheduler: OperationScheduler = OperationScheduler.PRONTO, blackboardProvider: BlackboardProvider = InMemoryBlackboardProvider, asyncer: Asyncer, objectMapper: <Error class: unknown class>, outputChannel: OutputChannel, templateRenderer: <Error class: unknown class>, customLogicalExpressionParser: LogicalExpressionParser? = null, applicationContext: <Error class: unknown class>? = null) : AgentPlatform

Constructors

constructor(name: String, description: String, processType: AgentPlatformProperties.ProcessType, llmOperations: LlmOperations, toolGroupResolver: ToolGroupResolver, eventListener: AgenticEventListener, agentProcessIdGenerator: AgentProcessIdGenerator = AgentProcessIdGenerator.RANDOM, contextRepository: ContextRepository = InMemoryContextRepository(), agentProcessRepository: AgentProcessRepository = InMemoryAgentProcessRepository(), operationScheduler: OperationScheduler = OperationScheduler.PRONTO, blackboardProvider: BlackboardProvider = InMemoryBlackboardProvider, asyncer: Asyncer, objectMapper: <Error class: unknown class>, outputChannel: OutputChannel, templateRenderer: <Error class: unknown class>, customLogicalExpressionParser: LogicalExpressionParser? = null, applicationContext: <Error class: unknown class>? = null)

Properties

actions

open override val actions: List<Action>

conditions

open override val conditions: Set<Condition>

description

open val description: String

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>

name

open val name: String

opaque

open override val opaque: Boolean = false

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

platformServices

open override val platformServices: SpringContextPlatformServices

processType

val processType: AgentPlatformProperties.ProcessType

toolGroupResolver

open override val toolGroupResolver: ToolGroupResolver

Functions

agents

open override fun agents(): List<Agent>

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).

createAgent

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

Create a new agent from the given scope

createAgentProcess

open override 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.

createAgentScope

open override fun createAgentScope(): AgentScope

Emit an AgentScope

createChildProcess

open override fun createChildProcess(agent: Agent, parentAgentProcess: AgentProcess): AgentProcess

deploy

open fun deploy(agentScope: AgentScope): AgentPlatform

open override fun deploy(agent: Agent): DefaultAgentPlatform

domainTypeForLabels

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

The domain type matching these labels, if we have one

excluding

open fun excluding(vararg classes: Class<*>): DataDictionary

open fun excluding(classes: Collection<Class<*>>): DataDictionary

Returns a new DataDictionary excluding the specified classes. Only affects JvmType entries; DynamicTypes are preserved.

filter

open fun filter(predicate: (DomainType) -> Boolean): DataDictionary

Returns a new DataDictionary containing only domain types that match the predicate.

getAgentProcess

open override 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

open override fun killAgentProcess(id: String): AgentProcess?

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

minus

open operator fun minus(clazz: Class<*>): DataDictionary

Kotlin operator for excluding a single class. Usage: dictionary - Foo::class.java

open operator fun minus(classes: Collection<Class<*>>): DataDictionary

Kotlin operator for excluding multiple classes. Usage: dictionary - setOf(Foo::class.java, Bar::class.java)

resolveType

open fun resolveType(name: String): DomainType

runAgentFrom

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

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

start

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

Run the given agent process in the background