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

Package-level declarations

Types

ActionMethodArgumentResolver

interface ActionMethodArgumentResolver

Strategy interface for resolving action method parameters into argument values and input bindings.

ActionMethodManager

interface ActionMethodManager

Creates and invokes actions from annotated methods.

AgenticInfo

data class AgenticInfo(val type: Class<*>)

Agentic info about a type

AgentMetadataReader

class AgentMetadataReader(actionMethodManager: ActionMethodManager = DefaultActionMethodManager(), nameGenerator: MethodDefinedOperationNameGenerator = MethodDefinedOperationNameGenerator(), agentStructureValidator: AgentStructureValidator, goapPathToCompletionValidator: GoapPathToCompletionValidator)

Read AgentMetadata from annotated classes. Looks for @Agentic, @Condition and @Action annotations and properties of type Goal. Warn on invalid or missing annotations but never throw an exception as this could affect application startup.

AiArgumentResolver

class AiArgumentResolver : ActionMethodArgumentResolver

Resolves Ai arguments.

BlackboardArgumentResolver

class BlackboardArgumentResolver : ActionMethodArgumentResolver

Resolves arguments that can be found on the com.embabel.agent.core.Blackboard

DuplicateParameterType

class DuplicateParameterType(val method: Method, val conflictingClassType: Class<*>, val conflictingParameters: List<Parameter>)

A class representing a method with multiple parameters of the same type that have not been annotated with com.embabel.agent.api.annotation.RequireNameMatch.

DuplicateParameterTypeException

class DuplicateParameterTypeException(val method: Method, val duplicates: List<DuplicateParameterType>) : RuntimeException

A class representing a method with multiple parameters of the same type that have not been annotated with com.embabel.agent.api.annotation.RequireNameMatch.

MethodDefinedOperationNameGenerator

fun interface MethodDefinedOperationNameGenerator

Define names for operations defined in methods.

OperationContextArgumentResolver

class OperationContextArgumentResolver : ActionMethodArgumentResolver

Resolves OperationContext arguments.

ProcessContextArgumentResolver

class ProcessContextArgumentResolver : ActionMethodArgumentResolver

Resolves ProcessContext arguments.

Functions

deployAnnotatedInstances

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

Convenient method to deploy instances to an agent platform

getBindingParameterName

fun getBindingParameterName(parameterName: String?, requireNameMatch: RequireNameMatch?): String?

Returns the name of the parameter based on the provided RequireNameMatch.

requireNonAmbiguousParameters

fun requireNonAmbiguousParameters(method: Method)

Checks if a method has multiple parameters with the same type, but no @RequireNameMatch annotation. This prevents any issue when the developer forgets to add @RequireNameMatch when parameters have the same type and the system is unable to determine the correct parameter order.