RagConfig class

Configuration options for RagEngine initialization.

Constructors

RagConfig({required String tokenizerAsset, required String modelAsset, String? preparedTokenizerPath, String? preparedModelPath, int? expectedEmbeddingDimension, String? databaseName, int maxChunkChars = kDefaultMaxChunkChars, int overlapChars = kDefaultOverlapChars, int? embeddingIntraOpNumThreads, ThreadUseLevel? threadLevel, bool deferIndexWarmup = false, double defaultVectorWeight = kDefaultVectorWeight, double defaultBm25Weight = kDefaultBm25Weight})
Creates a RagConfig with all options.
const
RagConfig.fromAssets({required String tokenizerAsset, required String modelAsset, String? databaseName, int maxChunkChars = kDefaultMaxChunkChars, int overlapChars = kDefaultOverlapChars, int? embeddingIntraOpNumThreads, ThreadUseLevel? threadLevel, bool deferIndexWarmup = false, double defaultVectorWeight = kDefaultVectorWeight, double defaultBm25Weight = kDefaultBm25Weight})
Convenience factory for asset-based initialization.
factory
RagConfig.fromPreparedFiles({required String tokenizerPath, required String modelPath, required int expectedEmbeddingDimension, String? databaseName, int maxChunkChars = kDefaultMaxChunkChars, int overlapChars = kDefaultOverlapChars, int? embeddingIntraOpNumThreads, ThreadUseLevel? threadLevel, bool deferIndexWarmup = false, double defaultVectorWeight = kDefaultVectorWeight, double defaultBm25Weight = kDefaultBm25Weight})
Configuration for files already verified by RagModelPackResolver.
factory

Properties

databaseName → String?
Name of the SQLite database file.
final
defaultBm25Weight → double
BM25 (keyword) weight for hybrid searches that do not pass bm25Weight. Default kDefaultBm25Weight (0.8). See defaultVectorWeight.
final
defaultVectorWeight → double
Vector weight for hybrid searches that do not pass vectorWeight (searchHybrid, searchHybridWithContext, searchMeta, ask, prepareAsk, RagSearchTool.fromMobileRag). Default kDefaultVectorWeight (0.2), which suits the English-only default model. A multilingual model such as KoEn-E5-Tiny does better with more vector weight; see docs/guides/model_setup.md.
final
deferIndexWarmup → bool
Whether to defer index warmup during initialization.
final
embeddingIntraOpNumThreads → int?
Maximum number of threads for intra-op parallelism in ONNX runtime.
final
expectedEmbeddingDimension → int?
Expected output dimension of a verified model pack, if one was used.
final
hashCode → int
The hash code for this object.
no setterinherited
maxChunkChars → int
Maximum characters per chunk (default: kDefaultMaxChunkChars).
final
modelAsset → String
Asset path for ONNX embedding model.
final
overlapChars → int
Overlap characters between chunks for context continuity (default: kDefaultOverlapChars).
final
preparedModelPath → String?
final
preparedTokenizerPath → String?
Already verified file paths produced by a Model Pack resolver.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
threadLevel → ThreadUseLevel?
High-level thread usage configuration.
final
tokenizerAsset → String
Asset path for tokenizer JSON file.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited