Embabel Agent Documentation/com.embabel.agent.api.tool/ArtifactSinkingTool

ArtifactSinkingTool

class ArtifactSinkingTool<T : Any>(val delegate: Tool, clazz: Class<T>, sink: ArtifactSink, filter: (T) -> Boolean = { true }, transform: (T) -> Any = { it }) : DelegatingTool

Tool decorator that captures artifacts from tool results, filters and transforms them, then sends to one or more sinks.

Handles both single artifacts and Iterables of artifacts.

Parameters

The type of artifact to capture

delegate

The tool to wrap

clazz

The class of T for type filtering

sink

Where to send captured artifacts

filter

Optional filter to decide which artifacts to capture. Default accepts all.

transform

Optional function to transform artifacts before sending to sink. Default passes through.

Constructors

ArtifactSinkingTool

constructor(delegate: Tool, clazz: Class<T>, sink: ArtifactSink, filter: (T) -> Boolean = { true }, transform: (T) -> Any = { it })

Properties

definition

open override val definition: Tool.Definition

Tool definition for LLM

delegate

open override val delegate: Tool

metadata

open override val metadata: Tool.Metadata

Optional metadata

Functions

call

open override fun call(input: String): Tool.Result

Execute the tool with JSON input.

requireType

inline fun <T : Any> Tool.requireType(message: String? = null): Tool

Wrap this tool to require a value of type T before execution (reified).

fun <T : Any> Tool.requireType(type: Class<T>, messageProvider: (String) -> String? = { null }): Tool

Wrap this tool to require a value of type T before execution.

toSpringToolCallback

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

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

toString

open override fun toString(): String

unwrapAs

inline fun <T : Tool> Tool.unwrapAs(): T?

Unwrap a tool to find a specific type, or return null if not found.

withAwaiting

fun Tool.withAwaiting(decider: AwaitDecider): Tool

Wrap this tool to conditionally await before execution.

withConfirmation

fun Tool.withConfirmation(messageProvider: (String) -> String): Tool

fun Tool.withConfirmation(message: String): Tool

Wrap this tool to always require confirmation before execution.

withDescription

open fun withDescription(newDescription: String): Tool

Create a new tool with a different description. Useful for providing context-specific descriptions while keeping the same functionality.

withEventPublication

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

Extension function to wrap a Tool with event publication.

withName

open fun withName(newName: String): Tool

Create a new tool with a different name. Useful for namespacing tools when combining multiple tool sources.

withNote

open fun withNote(note: String): Tool

Create a new tool with an additional note appended to the description. Useful for adding context-specific hints to an existing tool.