rag-base/ai.koog.rag.base/DocumentStorageWithPayload

DocumentStorageWithPayload

interface DocumentStorageWithPayload<Document, Payload>(source)

Defines a generic interface for document storage systems, supporting storing, retrieving, updating, and deleting documents. Each document can be associated with metadata or additional payload.

Parameters

Document

The type representing the document being stored.

Payload

The type representing additional metadata or payload associated with the document.

Inheritors

DocumentStorage

Functions

allDocuments

abstract fun allDocuments(): Flow<Document>

Iterates over the documents

allDocumentsWithPayload

abstract fun allDocumentsWithPayload(): Flow<DocumentWithPayload<Document, Payload>>

Iterates through documents and their corresponding payloads

delete

abstract suspend fun delete(documentId: String): Boolean

Deletes the document with the specified ID from the storage.

getPayload

abstract suspend fun getPayload(documentId: String): Payload?

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

read

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

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

readWithPayload

abstract suspend fun readWithPayload(documentId: String): DocumentWithPayload<Document, Payload>?

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

store

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

Stores a document and its associated payload in the storage.