Embabel Agent Documentation/com.embabel.agent.spi.support.springai

Package-level declarations

Types

class ChatModelCallEvent<O> : AbstractAgentProcessEvent

Spring AI low level event: ChatModel call.

class DefaultToolDecorator(toolGroupResolver: ToolGroupResolver? = null, observationRegistry: <Error class: unknown class>? = null, outputTransformer: StringTransformer = StringTransformer.IDENTITY) : ToolDecorator

Decorate tools with metadata and publish events.

EventPublishingToolCallback

class EventPublishingToolCallback(delegate: <Error class: unknown class>, agentProcess: AgentProcess, action: Action?, llmOptions: <Error class: unknown class>)

ExceptionWrappingConverter

class ExceptionWrappingConverter<T>(expectedType: Class<T>, delegate: <Error class: unknown class><T>)

Wrap in our exception handling to capture return string

MetadataEnrichedToolCallback

class MetadataEnrichedToolCallback(val toolGroupMetadata: ToolGroupMetadata?, delegate: <Error class: unknown class>)

Add metadata about the tool group to which this tool belongs.

SpringAiLlmService

data class SpringAiLlmService constructor(val name: String, val provider: String, val chatModel: <Error class: unknown class>, val optionsConverter: <Error class: unknown class><out <Error class: unknown class>> = DefaultOptionsConverter, val knowledgeCutoffDate: LocalDate? = null, val promptContributors: List<<Error class: unknown class>> = buildList { knowledgeCutoffDate?.let { add(KnowledgeCutoffDate(it)) } }, val pricingModel: <Error class: unknown class>? = null) : LlmService<SpringAiLlmService>

Spring AI implementation that provides decoupled LLM operations.

SpringToolCallbackAdapter

class SpringToolCallbackAdapter(tool: Tool)

Adapts an Embabel Tool to Spring AI's ToolCallback interface.

SpringToolCallbackWrapper

class SpringToolCallbackWrapper(callback: <Error class: unknown class>) : Tool

Wraps a Spring AI ToolCallback as an Embabel Tool.

SuppressThinkingConverter

class SuppressThinkingConverter<T>(delegate: <Error class: unknown class><T>, thinkBlockFinders: List<ThinkBlockFinder> = listOf(FindMarkupThinkBlock, FindPrefixThinkBlock))

A decorator for Spring AI's StructuredOutputConverter that cleans up LLM outputs by removing "thinking" blocks.

ThinkBlockFinder

typealias ThinkBlockFinder = (String) -> String?

WithExampleConverter

class WithExampleConverter<T>(delegate: <Error class: unknown class><T>, outputClass: Class<T>, ifPossible: Boolean, generateExamples: Boolean)

Decorator for Spring's StructuredOutputConverter that adds few-shot examples to the output format description.

Properties

FindMarkupThinkBlock

val FindMarkupThinkBlock: ThinkBlockFinder

FindPrefixThinkBlock

val FindPrefixThinkBlock: ThinkBlockFinder

PROMPT_ELEMENT_SEPARATOR

const val PROMPT_ELEMENT_SEPARATOR: String

Functions

chatModelCallEvent

fun <O> LlmRequestEvent<O>.chatModelCallEvent(springAiPrompt: <Error class: unknown class>): ChatModelCallEvent<O>

Return a low level event showing Spring AI prompt details.

stringWithoutThinkBlocks

fun stringWithoutThinkBlocks(source: String, thinkBlockFinders: List<ThinkBlockFinder> = listOf(FindMarkupThinkBlock)): String

toEmbabelMessage

fun <Error class: unknown class>.toEmbabelMessage(): Message

Convert a Spring AI AssistantMessage to an Embabel message. Handles both regular messages and messages with tool calls.

toEmbabelTool

fun <Error class: unknown class>.toEmbabelTool(): Tool

Extension function to wrap a Spring AI ToolCallback as an Embabel Tool.

toEmbabelTools

fun List<<Error class: unknown class>>.toEmbabelTools(): List<Tool>

Extension function to wrap a list of Spring AI ToolCallbacks as Embabel Tools.

toSpringAiMessage

fun Message.toSpringAiMessage(): <Error class: unknown class>

Convert one of our messages to a Spring AI message with multimodal support.

toSpringToolCallback

fun Tool.toSpringToolCallback(): <Error class: unknown class>

Extension function to convert an Embabel Tool to a Spring AI ToolCallback.

toSpringToolCallbacks

fun List<Tool>.toSpringToolCallbacks(): List<<Error class: unknown class>>

Extension function to convert a list of Embabel Tools to Spring AI ToolCallbacks.

withEventPublication

fun <Error class: unknown class>.withEventPublication(agentProcess: AgentProcess, action: Action?, llmOptions: <Error class: unknown class>): <Error class: unknown class>

HOF to decorate a ToolCallback to time the call and emit events.