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

DocumentProvider

interface DocumentProvider<Path, Document>(source)

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

Parameters

Path

The type representing the path or identifier for locating documents.

Document

The type representing the document being operated on.

Inheritors

JVMDocumentProvider

Types

DocumentRange

@Serializable

data class DocumentRange(val start: DocumentProvider.Position, val end: DocumentProvider.Position)

Represents a range within a document, defined by a start and end position.

Edit

interface Edit<Path, Document>

Represents an interface for performing edit operations on a document.

Position

@Serializable

data class Position(val line: Int, val column: Int) : Comparable<DocumentProvider.Position>

Represents a position in a text document identified by a specific line and column. Used for precise referencing of specific locations within multi-line text content.

Functions

document

abstract suspend fun document(path: Path): Document?

Retrieves a document corresponding to the specified path.

text

abstract suspend fun text(document: Document): CharSequence

Retrieves the full text content of the given document as a character sequence.

textFragment

open suspend fun textFragment(document: Document, range: DocumentProvider.DocumentRange): String

Extracts a specified fragment of text from a given document based on a defined range.