Embabel Agent Documentation/com.embabel.agent.api.common/Ai

Ai

interface Ai

Gateway to AI functionality in the context of an operation. This includes both LLM and embedding models.

Functions

@ApiStatus.Experimental

open fun classifications(): ServiceSelector<ClassificationService>

Returns the selector for classification services. Decision services are also classification services, so this family includes them.

decisions

@ApiStatus.Experimental

open fun decisions(): ServiceSelector<DecisionService>

Returns the selector for decision services.

withAutoLlm

open fun withAutoLlm(): PromptRunner

Get a configurable PromptRunner for this context using automatic model selection criteria. This may consider prompt and tools, so is not the same as default.

withDefaultEmbeddingService

open fun withDefaultEmbeddingService(): EmbeddingService

withDefaultLlm

open fun withDefaultLlm(): PromptRunner

Get a configurable PromptRunner for this context using the default model selection criteria.

withEmbeddingService

abstract fun withEmbeddingService(criteria: ModelSelectionCriteria): EmbeddingService

Return an embedding service matching the given criteria.

open fun withEmbeddingService(model: String): EmbeddingService

Return an embedding service with the given name

withFirstAvailableLlmOf

open fun withFirstAvailableLlmOf(vararg llms: String): PromptRunner

withLlm

abstract fun withLlm(llm: LlmOptions): PromptRunner

Get a configurable PromptRunner for this context using the given LLM. Allows full control over LLM options.

open fun withLlm(model: String): PromptRunner

Get a configurable PromptRunner for this context choosing the given model by name and the default LLM options. Does not allow for any other LLM options to be set.

withLlmByRole

open fun withLlmByRole(role: String): PromptRunner

Get a configurable PromptRunner for this context choosing the given model by role and the default LLM options. Does not allow for any other LLM options to be set. Users must configure roles, for example in application.properties.

withLlmService

open fun withLlmService(llmService: LlmService<*>): PromptRunner

Get a configurable PromptRunner using a pre-resolved LLM service. Bypasses ModelProvider resolution — useful for BYOK (bring your own per-user key) scenarios, testing, or dynamic provider selection.