Embabel Agent Documentation/com.embabel.chat.support/AssetAddingTool

AssetAddingTool

class AssetAddingTool<T>(val delegate: Tool, val assetTracker: AssetTracker, val converter: (T) -> Asset, val clazz: Class<T>, val artifactFilter: (T) -> Boolean = { true }) : DelegatingTool

Add the result of calling this tool as an asset to the given AssetTracker if it is of the expected type. Also unwraps Iterables of the expected type.

Parameters

The type of artifact to convert to an Asset

delegate

The tool to delegate to

assetTracker

The asset tracker to add assets to

converter

Function to convert from T to Asset

clazz

The class of T

artifactFilter

Optional filter to decide which artifacts become assets. Default accepts all artifacts of the matching type.

Constructors

AssetAddingTool

constructor(delegate: Tool, assetTracker: AssetTracker, converter: (T) -> Asset, clazz: Class<T>, artifactFilter: (T) -> Boolean = { true })

Properties

artifactFilter

val artifactFilter: (T) -> Boolean

assetTracker

val assetTracker: AssetTracker

clazz

val clazz: Class<T>

converter

val converter: (T) -> Asset

definition

open override val definition: Tool.Definition

Tool definition for LLM

delegate

open override val delegate: Tool

metadata

open 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.

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.