Embabel Agent Documentation/com.embabel.agent.tools.file

Package-level declarations

Types

DefaultFileChangeLog

class DefaultFileChangeLog(changes: MutableList<FileModification> = mutableListOf()) : FileChangeLog

Convenient file change log implementation that stores changes in memory and correctly handles duplicates.

DefaultFileReadLog

class DefaultFileReadLog(reads: MutableMap<String, FileReads> = mutableMapOf()) : FileReadLog

Convenient file change log implementation that stores changes in memory and correctly handles duplicates.

FileAccessLog

interface FileAccessLog

Tracks access context

FileChangeLog

interface FileChangeLog

FileModification

data class FileModification(val path: String, val type: FileModificationType)

FileModificationType

enum FileModificationType : Enum<FileModificationType>

FileReadLog

interface FileReadLog

The FileReadLog can be useful for stats and to understand the context that has been accessed

FileReads

data class FileReads(val path: String, val reads: List<Instant> = emptyList())

Represents reads of a file

FileReadTools

interface FileReadTools : DirectoryBased, FileReadLog, FileAccessLog, SelfToolCallbackPublisher

LLM-ready ToolCallbacks and convenience methods for file operations. Use at your own risk: This makes changes to your host machine!!

FileTools

interface FileTools : FileReadTools, FileWriteTools

Read and Write file tools. Extend FileReadTools for safe read only use

FileWriteTools

interface FileWriteTools : DirectoryBased, FileAccessLog, FileChangeLog, SelfToolCallbackPublisher

All file modifications must go through this interface.

PatternSearch

interface PatternSearch : DirectoryBased

Adds low level pattern search methods to the com.embabel.agent.tools.DirectoryBased interface

WellKnownFileContentTransformers

object WellKnownFileContentTransformers

Provides common implementations of FileContentTransformer for reducing file content bloat. These transformers can be used to clean up file content before sending it to LLMs or other text processing systems to reduce token usage and improve performance by helping them to focus on essential code.