Struct RagSetup 

pub struct RagSetup {
    pub config: RagrigConfig,
    pub bibliography: Option<PathBuf>,
    pub system_prompt: Option<String>,
    pub stream: bool,
    pub resolve_citations: bool,
    pub hybrid: bool,
    pub data_dir: Option<PathBuf>,
}

Everything needed to build one ragrig::RagAgent.

Fields

config: RagrigConfig

Ragrig’s own configuration tree.

bibliography: Option<PathBuf>

Bibliography the worker reads and writes.

None uses the conventional <workspace>/.ragrig/references.bib. Hosts that keep their library elsewhere set this so @key citations, the reference rows, and GROBID all agree on one file.

system_prompt: Option<String>

Prompt text applied after building; takes precedence over config.chat.system_prompt_path.

stream: bool

Whether answers stream token by token.

resolve_citations: bool

Whether @key mentions in a question attach the paper as one-shot context. On by default.

hybrid: bool

Whether hybrid retrieval (BM25 + embeddings) is enabled.

Off builds a no-op embedder: questions still use explicit attachments and the bibliographic library, but no vector search runs and no embedding model is required. On by default.

data_dir: Option<PathBuf>

Where the vector store, sessions, and profiles live.

None uses <config.workspace>/.ragrig. A host with a dedicated project folder (for example .ragrig inside the document workspace) sets this explicitly.

Implementations

impl RagSetup

pub fn new(config: RagrigConfig) -> Self

Wrap a config without a prompt override.

pub fn with_system_prompt( config: RagrigConfig, prompt: impl Into<String>, ) -> Self

Wrap a config and apply prompt before the agent is built.

pub fn with_bibliography(self, path: impl Into<PathBuf>) -> Self

Use path for the bibliography instead of the conventional file.

pub fn with_hybrid(self, hybrid: bool) -> Self

Turn hybrid retrieval (embeddings) on or off.

pub fn with_data_dir(self, dir: impl Into<PathBuf>) -> Self

Use dir for the vector store, sessions, and profiles.

pub fn memory_enabled(&self) -> bool

Whether conversation memory is on (false for the Off strategy).

Trait Implementations

impl Clone for RagSetup

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RagSetup

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

Formats the value using the given formatter.

impl From<RagrigConfig> for RagSetup

fn from(config: RagrigConfig) -> Self

Converts to this type from the input type.