rag-base/ai.koog.rag.base.files

Package-level declarations

Types

interface DocumentProvider<Path, Document>

Interface representing a provider for managing documents and their contents. It allows retrieval of documents, manipulation of text, and extraction of content fragments.

FileMetadata

@Serializable

data class FileMetadata(val type: FileMetadata.FileType, val hidden: Boolean)

Represents metadata associated with a file or directory.

FileSystemProvider

object FileSystemProvider

Provides ReadOnly and ReadWrite interfaces for interacting with a filesystem through file operations and content reading/writing.

JVMDocumentProvider

object JVMDocumentProvider : DocumentProvider<Path, Path>

An implementation of the DocumentProvider interface for handling documents represented as Path objects. This object provides functionality to read and write text from files, allowing for document editing and text transformation while normalizing line separators.

JVMFileSystemProvider

object JVMFileSystemProvider

Provides access to the JVM-specific file system functionality. This object includes implementations for operations like serialization of Path objects, file selection, read, write, and combined read-write operations.

Functions

createDirectory

suspend fun <Path> FileSystemProvider.ReadWrite<Path>.createDirectory(path: Path)

Creates a directory at the specified path. Parent directories will be created automatically if they don't exist.

createFile

suspend fun <Path> FileSystemProvider.ReadWrite<Path>.createFile(path: Path)

Creates a file at the specified path. Parent directories will be created automatically if they don't exist.

filter

fun <Path> FileSystemProvider.ReadOnly<Path>.filter(filter: TraversalFilter<Path>): FileSystemProvider.ReadOnly<Path>

Filters the current read-only file system implementation such that only paths that are accepted by filter are visible and accessible.

fun <Path> FileSystemProvider.ReadWrite<Path>.filter(filter: TraversalFilter<Path>): FileSystemProvider.ReadWrite<Path>

Filters the current read-write file system implementation such that only paths that are accepted by filter are visible and accessible.

readText

suspend fun <Path> FileSystemProvider.ReadOnly<Path>.readText(path: Path): String

suspend fun <Path, Document> FileSystemProvider.ReadOnly<Path>.readText(path: Path, documentProvider: DocumentProvider<Path, Document>?): String

Reads the entire content of a file as a string.

writeText

suspend fun <Path> FileSystemProvider.ReadWrite<Path>.writeText(path: Path, content: String)

Writes a string to a file, replacing any existing content.