Package io.quarkiverse.langchain4j.easyrag.runtime

Interface EasyRagConfig

@ConfigRoot(phase=RUN_TIME)
@ConfigMapping(prefix="quarkus.langchain4j.easy-rag")
public interface EasyRagConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EasyRagConfig.ReuseEmbeddingsConfig

Method Summary

Modifier and Type	Method	Description
IngestionStrategy	ingestionStrategy()	The strategy to decide whether document ingestion into the store should happen at startup or not.
Integer	maxOverlapSize()	Maximum overlap (in tokens) when splitting documents.
Integer	maxResults()	Maximum number of results to return when querying the retrieval augmentor.
Integer	maxSegmentSize()	Maximum segment size when splitting documents, in tokens.
String	path()	Path to the directory containing the documents to be ingested.
String	pathMatcher()	Matcher used for filtering which files from the directory should be ingested.
Boolean	recursive()	Whether to recursively ingest documents from subdirectories.
EasyRagConfig.ReuseEmbeddingsConfig	reuseEmbeddings()	Configuration related to the reusing of embeddings.

Method Details

path

String path()

Path to the directory containing the documents to be ingested.

pathMatcher

@WithDefault("glob:**")
String pathMatcher()

Matcher used for filtering which files from the directory should be ingested. This uses the FileSystem path matcher syntax. Example: `glob:**.txt` to recursively match all files with the `.txt` extension. The default is `glob:**`, recursively matching all files.

recursive

@WithDefault("true")
Boolean recursive()

Whether to recursively ingest documents from subdirectories.

maxSegmentSize

@WithDefault("300")
Integer maxSegmentSize()

Maximum segment size when splitting documents, in tokens.

maxOverlapSize

@WithDefault("30")
Integer maxOverlapSize()

Maximum overlap (in tokens) when splitting documents.

maxResults

@WithDefault("5")
Integer maxResults()

Maximum number of results to return when querying the retrieval augmentor.

ingestionStrategy

@WithDefault("ON")
IngestionStrategy ingestionStrategy()

The strategy to decide whether document ingestion into the store should happen at startup or not. The default is ON. Changing to OFF generally only makes sense if running against a persistent embedding store that was already populated.

reuseEmbeddings

EasyRagConfig.ReuseEmbeddingsConfig reuseEmbeddings()

Configuration related to the reusing of embeddings.

Currently only supported when using an in-memory embedding store.