Skip to main content

RagConfig

Struct RagConfig 

Source
pub struct RagConfig {
Show 34 fields pub db_backend: DbBackend, pub database_url: String, pub embed_provider: EmbedProvider, pub embed_model: String, pub embed_dim: usize, pub ollama_base_url: String, pub gemini_api_key: Option<String>, pub gemini_model: String, pub embed_onnx_path: String, pub embed_tokenizer_path: String, pub openrouter_api_key: Option<String>, pub openrouter_base_url: String, pub llm_model: String, pub ocr_lang: OcrLang, pub chunker: ChunkerKind, pub chunk_size: usize, pub chunk_overlap: f32, pub chunk_unit: ChunkUnit, pub chunk_tokenizer: Option<String>, pub retrieval_mode: RetrievalMode, pub top_k: usize, pub rrf_k: f32, pub multiquery_n: usize, pub source: SourceKind, pub source_path: String, pub source_url: Option<String>, pub source_user: Option<String>, pub source_password: Option<String>, pub documents_output: Option<String>, pub queue: QueueKind, pub rabbitmq_url: Option<String>, pub redis_url: Option<String>, pub http_addr: String, pub api_keys: Vec<String>,
}
Expand description

The fully-resolved configuration for a RAG session.

Fields§

§db_backend: DbBackend§database_url: String§embed_provider: EmbedProvider§embed_model: String§embed_dim: usize§ollama_base_url: String§gemini_api_key: Option<String>§gemini_model: String§embed_onnx_path: String§embed_tokenizer_path: String§openrouter_api_key: Option<String>§openrouter_base_url: String§llm_model: String§ocr_lang: OcrLang

OCR recognition language (RAG_OCR_LANG): en (default — English PP-OCRv3, docling-pdf’s own default) or ch (the multilingual conformance-validated model; weak Latin word spacing). Maps onto docling-pdf’s DOCLING_RS_OCR_LANG — explicit DOCLING_OCR_* env overrides always win.

§chunker: ChunkerKind§chunk_size: usize§chunk_overlap: f32§chunk_unit: ChunkUnit§chunk_tokenizer: Option<String>

Path to a HuggingFace tokenizer.json for the hybrid chunker’s token counts (RAG_CHUNK_TOKENIZER). Required when chunker = hybrid.

§retrieval_mode: RetrievalMode§top_k: usize§rrf_k: f32§multiquery_n: usize§source: SourceKind§source_path: String§source_url: Option<String>§source_user: Option<String>§source_password: Option<String>§documents_output: Option<String>

Optional folder to dump each ingested document’s converted Markdown into (for debugging / re-ingestion). None disables the dump.

§queue: QueueKind§rabbitmq_url: Option<String>§redis_url: Option<String>§http_addr: String

Bind address for serve (default 127.0.0.1:8080).

§api_keys: Vec<String>

Accepted API keys (comma-separated in RAG_API_KEYS). The server refuses to start with an empty list — auth is fail-closed.

Implementations§

Source§

impl RagConfig

Source

pub fn from_env() -> Result<Self>

Load a .env file (if present) then resolve config from the environment.

Missing keys fall back to the Default values, so this never fails on an empty environment; it only errors on an invalid value (bad number, unknown backend name).

Source

pub fn validate(&self) -> Result<()>

Sanity-check numeric ranges. Returns the first violation.

Trait Implementations§

Source§

impl Clone for RagConfig

Source§

fn clone(&self) -> RagConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RagConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for RagConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more