ArtifactSinkingTool

All Implemented Interfaces:

com.embabel.agent.api.tool.DelegatingTool , com.embabel.agent.api.tool.Tool , com.embabel.agent.api.tool.ToolInfo
```
public final class ArtifactSinkingTool<T extends Object>
 implements 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Tool.Definition`	`definition`
`private final Tool.Metadata`	`metadata`
`private final Tool`	`delegate`

Constructor Summary

Constructors
Constructor	Description
`ArtifactSinkingTool(Tool delegate, Class<T> clazz, ArtifactSink sink, Function1<T, Boolean> filter, Function1<T, Object> transform)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Tool.Definition`	`getDefinition()`	Tool definition for LLM
`Tool.Metadata`	`getMetadata()`	Optional metadata
`Tool`	`getDelegate()`
`Tool.Result`	`call(String input)`	Execute the tool with JSON input.
`String`	`toString()`

Methods inherited from class com.embabel.agent.api.tool.Tool
withDescription, withName, withNote
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArtifactSinkingTool
```
ArtifactSinkingTool(Tool delegate, Class<T> clazz, ArtifactSink sink, Function1<T, Boolean> filter, Function1<T, Object> transform)
```
    Parameters:
    
    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.
    
    transform - Optional function to transform artifacts before sending to sink.
- Method Detail
  - getDefinition
```
 Tool.Definition getDefinition()
```
    Tool definition for LLM
  - getMetadata
```
 Tool.Metadata getMetadata()
```
    Optional metadata
  - getDelegate
```
 Tool getDelegate()
```
  - call
```
 Tool.Result call(String input)
```
    Execute the tool with JSON input.
    
    Parameters:
    
    input - JSON string matching inputSchema
    
    Returns:
    
    Result to send back to LLM
  - toString
```
 String toString()
```