0.3.0

rag-base/ai.koog.rag.base/DocumentStorage

DocumentStorage

interface DocumentStorage<Document> : DocumentStorageWithPayload<Document, Unit> (source)

Represents a generic storage system for documents, without the need for additional metadata or payloads. This interface provides basic document storage operations such as storing, retrieving, and deleting documents.

Parameters

Document

The type of document being stored or processed.

By inheriting from DocumentStorageWithPayload with a fixed payload type of Unit, DocumentStorage simplifies the use case for scenarios where no additional payload is required alongside the document.

Inheritors

RankedDocumentStorage

Functions

abstract fun allDocuments(): Flow<Document>

Iterates over the documents

allDocumentsWithPayload

open override fun allDocumentsWithPayload(): Flow<DocumentWithPayload<Document, Unit>>

Iterates through documents and their corresponding payloads

abstract suspend fun delete(documentId: String): Boolean

Deletes the document with the specified ID from the storage.

open suspend override fun getPayload(documentId: String)

Retrieves the payload associated with the document identified by the given document ID.

abstract suspend fun read(documentId: String): Document?

Reads a document associated with the given document ID and returns it.

readWithPayload

open suspend override fun readWithPayload(documentId: String): DocumentWithPayload<Document, Unit>?

Reads a document along with its associated payload based on the given document ID.

open suspend fun store(document: Document): String

Stores a document in the storage system without any additional payload.

abstract suspend fun store(document: Document, data: Unit): String

Stores a document and its associated payload in the storage.