Embabel Agent Documentation/com.embabel.agent.spi

Package-level declarations

Types

ActionExecutionSchedule

sealed interface ActionExecutionSchedule

When should an action run?

AgentProcessIdGenerator

fun interface AgentProcessIdGenerator

Generate names for agent processes

AgentProcessRepository

interface AgentProcessRepository

Spring-style repository for agent processes. We don't extend Repository because it confuses Spring's component scanning if JPA/Neo or another Spring Data solution is used on the classpath downstream.

AutoLlmSelectionCriteriaResolver

interface AutoLlmSelectionCriteriaResolver

Replace automatic LLM selection with a custom one based on usage

DelayedActionExecutionSchedule

data class DelayedActionExecutionSchedule(val delay: Duration, val timestamp: Instant = Instant.now()) : ActionExecutionSchedule

Run after a given delay

InteractionId

value class InteractionId(val value: String)

All prompt interactions through the platform need a unique id This allows LLM interactions to be optimized by an AgentPlatform

InvalidLlmReturnFormatException

class InvalidLlmReturnFormatException(val llmReturn: String, val expectedType: Class<*>, cause: Throwable) : RuntimeException

The LLM returned an object of the wrong type.

LlmCall

interface LlmCall : LlmUse, ToolConsumer

Spec for calling an LLM. Optional LlmOptions, plus tool callbacks and prompt contributors.

LlmInteraction

data class LlmInteraction(val id: InteractionId, val llm: <Error class: unknown class> = LlmOptions(), val toolGroups: Set<ToolGroupRequirement> = emptySet(), val toolCallbacks: List<<Error class: unknown class>> = emptyList(), val promptContributors: List<<Error class: unknown class>> = emptyList(), val contextualPromptContributors: List<ContextualPromptElement> = emptyList(), val generateExamples: Boolean? = null) : LlmCall

Encapsulates an interaction with an LLM. An LlmInteraction is a specific instance of an LlmCall. The LLM must have been chosen and the call has a unique identifier.

LlmOperations

interface LlmOperations

Wraps LLM operations. All user-initiated LLM operations go through this, allowing the AgentPlatform to mediate them. This interface is not directly for use in user code. Prefer PromptRunner An LlmOperations implementation is responsible for resolving all relevant tool callbacks for the current AgentProcess (in addition to those passed in directly), and emitting events.

LlmUse

interface LlmUse : ToolGroupConsumer

Spec for calling an LLM. Optional LlmOptions, plus tool groups and prompt contributors.

OperationScheduler

interface OperationScheduler

Schedules operations for an AgentProcess.

PlatformServices

data class PlatformServices(val agentPlatform: AgentPlatform, val llmOperations: LlmOperations, val eventListener: AgenticEventListener, val operationScheduler: OperationScheduler, val asyncer: Asyncer, val ragService: RagService, val objectMapper: <Error class: unknown class>, val outputChannel: OutputChannel, val templateRenderer: <Error class: unknown class>, applicationContext: <Error class: unknown class>?)

Services used by the platform and available to user-authored code.

ProntoActionExecutionSchedule

data class ProntoActionExecutionSchedule(val timestamp: Instant = Instant.now()) : ActionExecutionSchedule

No delay

Ranker

interface Ranker

Rank available choices based on user input and agent metadata. It's possible that no ranking will be high enough to progress with, but that's a matter for the AgentPlatform using this service.

Ranking

data class Ranking<T>(val match: T, val score: <Error class: unknown class>)

Ranking choice returned by the ranker

Rankings

data class Rankings<T>(rankings: List<Ranking<T>>)

Rankings, sorted by score descending

ScheduledActionExecutionSchedule

data class ScheduledActionExecutionSchedule(val till: Instant, val timestamp: Instant = Instant.now()) : ActionExecutionSchedule

Run at the given time in the future

ToolCallSchedule

data class ToolCallSchedule(val delay: Duration = Duration.ZERO, val timestamp: Instant = Instant.now())

ToolDecorator

fun interface ToolDecorator

Decorate tools for use on the platform: for example, to time them and emit events.

ToolGroupResolver

interface ToolGroupResolver