Embabel Agent Documentation/com.embabel.agent.rag.lucene/LuceneRagFacetProvider

LuceneRagFacetProvider

class LuceneRagFacetProvider constructor(val name: String, embeddingModel: <Error class: unknown class>? = null, vectorWeight: Double = 0.5, chunkerConfig: ContentChunker.Config = ContentChunker.DefaultConfig(), indexPath: Path? = null) : AbstractWritableContentElementRepository, RagFacetProvider, Closeable

Lucene RAG facet with optional vector search support via an EmbeddingModel. Supports both in-memory and disk-based persistence. Implements WritableContentElementRepository so we can add to the store.

Parameters

name

Name of this RAG service

embeddingModel

Optional embedding model for vector search; if null, only text search is supported

vectorWeight

Weighting for vector similarity in hybrid search (0.0 to 1.0)

chunkerConfig

Configuration for content chunking

indexPath

Optional path for disk-based index storage; if null, uses in-memory storage

Constructors

LuceneRagFacetProvider

constructor(name: String, embeddingModel: <Error class: unknown class>? = null, vectorWeight: Double = 0.5, chunkerConfig: ContentChunker.Config = ContentChunker.DefaultConfig(), indexPath: Path? = null)

Properties

name

open val name: String

Functions

open fun accept(documents: List<<Error class: unknown class>>)

clear

fun clear()

Clear all stored content - useful for testing

open override fun close()

count

open override fun count(): Int

Return the total number of content elements in the repository

facets

open override fun facets(): List<RagFacet<out Retrievable>>

findAll

fun findAll(): List<Chunk>

findById

open override fun findById(id: String): ContentElement?

findChunksById

open override fun findChunksById(chunkIds: List<String>): List<Chunk>

findChunksForEntity

open override fun findChunksForEntity(entityId: String): List<Chunk>

getStatistics

fun getStatistics(): LuceneStatistics

Get statistics about the current state

infoString

open fun infoString(verbose: Boolean?, indent: Int): String

loadExistingChunksFromDisk

fun loadExistingChunksFromDisk()

Manually trigger loading of existing chunks from disk. Useful for ensuring chunks are loaded immediately after startup.

onNewRetrievables

open override fun onNewRetrievables(retrievables: List<Retrievable>)

The Retrievables have been saved to the store, but Retrievables are special, and we probably want to embed them

provision

open fun provision()

Provision this rag service if necessary

save

open override fun save(element: ContentElement): ContentElement

fun search(ragRequest: RagRequest): RagFacetResults<Chunk>

writeContent

override fun writeContent(root: MaterializedDocument): List<String>

Will call save on the root and all descendants. The database only needs to store each descendant and link by id, rather than otherwise consider the entire structure.