Struct RagSettings 

pub struct RagSettings {

    pub workspace: String,
    pub bibliography: String,
    pub provider: ChatProvider,
    pub models: BTreeMap<ChatProvider, String>,
    pub temperature: f64,
    pub max_tokens: usize,
    pub context_tokens: usize,
    pub system_prompt: String,
    pub system_prompt_path: String,
    pub built_in_prompt: String,
    pub stream: bool,
    pub embed_model: String,
    pub hybrid: bool,
    pub top_k: usize,
    pub similarity_threshold: f64,
    pub chunk_size: usize,
    pub chunk_overlap: usize,
    pub pdf_backend: PdfBackend,
    pub sloppy_pdf: bool,
    pub memory: MemoryChoice,
    pub memory_model: String,
    pub grobid_source: GrobidSource,
    pub grobid_url: String,
    pub grobid_image: String,
    pub rename_pdfs: bool,
    pub openalex: bool,
    pub resolve_citations: bool,
    pub corpus_dirs: Vec<String>,
    pub profile_name: String,
    pub profiles: Vec<String>,
    pub status: Option<String>,
}

Editable configuration shown by the settings page.

This mirrors the Ragrig fields a chat surface exposes. Secrets never enter this struct: cloud API keys are read from the environment by the worker.

Fields

workspace: String

Workspace folder holding the store and sessions.

bibliography: String

Bibliography the library and @key resolution use.

Empty means the conventional <workspace>/.ragrig/references.bib.

provider: ChatProvider

Active chat backend.

models: BTreeMap<ChatProvider, String>

Chat model per provider.

Every provider keeps its own model, so switching backends does not carry a model name into an incompatible API. Missing entries use ChatProvider::default_model when the configuration is built.

temperature: f64

Sampling temperature.

max_tokens: usize

Maximum generated tokens.

context_tokens: usize

Chat context window in tokens.

system_prompt: String

Inline system prompt, used when system_prompt_path is empty.

system_prompt_path: String

Markdown file that overrides the inline prompt; empty uses system_prompt.

built_in_prompt: String

The prompt the host compiles in.

Hosts set this after loading their settings; Use built-in and profile defaults restore it. It is not written to profiles and is ignored by dirty tracking.

stream: bool

Stream tokens into the transcript.

embed_model: String

Ollama embedding model.

hybrid: bool

Hybrid retrieval (BM25 + embeddings). Off runs without an embedding model and skips vector search.

top_k: usize

Chunks retrieved per query.

similarity_threshold: f64

Minimum similarity for a chunk to enter the prompt.

chunk_size: usize

Target chunk size in tokens.

chunk_overlap: usize

Token overlap between chunks.

pdf_backend: PdfBackend

PDF parser selected as primary.

sloppy_pdf: bool

Keep the sloppy PDF fallback registered.

memory: MemoryChoice

Conversation memory strategy.

memory_model: String

Small model used for rewriting and summaries.

grobid_source: GrobidSource

Where the GROBID server comes from.

grobid_url: String

Base URL of the GROBID server.

grobid_image: String

Docker image used when Self::grobid_source is GrobidSource::Managed.

rename_pdfs: bool

Rename PDFs to their metadata name during reference extraction.

openalex: bool

Complete extracted references against OpenAlex.

resolve_citations: bool

Attach @key papers mentioned in a question as one-shot context.

corpus_dirs: Vec<String>

Named folder corpora in name=path form.

profile_name: String

Profile name typed by the user.

profiles: Vec<String>

Profiles found in the workspace.

status: Option<String>

Last settings action result, shown under the Apply row.

Implementations

impl RagSettings

pub fn model(&self) -> &str

The model configured for the active provider.

The value is returned as stored, so an edited field can be empty while the user types. Self::effective_model applies the provider default.

pub fn model_for(&self, provider: ChatProvider) -> &str

The model configured for provider, as stored.

pub fn effective_model(&self) -> &str

The model configured for the active provider, or its default.

pub fn effective_model_for(&self, provider: ChatProvider) -> &str

The model configured for provider, or its default when unset.

pub fn set_model(&mut self, model: impl Into<String>)

Set the model of the active provider.

pub fn set_model_for( &mut self, provider: ChatProvider, model: impl Into<String>, )

Set the model of provider.

pub fn dirty_since(&self, applied: &Self) -> RagChanges

Compare the editable configuration fields with the configuration that is currently running. Profile bookkeeping is ignored.

pub fn reset_to_profile_defaults(&mut self) -> Result<(), String>

Reset the editable fields to the defaults of the last chosen profile.

With no profile selected, the compiled defaults are used while keeping the workspace, bibliography, and profile bookkeeping so the library location is not lost.

impl RagSettings

pub fn from_config(config: &RagrigConfig) -> Self

Read the editable fields from a Ragrig configuration.

pub fn from_layers(workspace: &Path) -> Option<Self>

Read ~/.ragrig/config.json and <workspace>/.ragrig/config.json as partial configurations and merge them over the built-in defaults.

The merge is per setting: a key missing from a higher layer keeps the value from the layer below, so a workspace only states what it changes. Returns None when neither file exists.

pub fn from_layers_over(workspace: &Path, base: &Self) -> Option<Self>

Like Self::from_layers, but keeps the runtime memory and hybrid switches from base when no layer mentions them.

The status-bar switches live in settings.json as well as the workspace layer; this prevents a layer that only sets, say, the chat model from resetting them to their defaults.

pub fn to_config(&self) -> Result<RagrigConfig, String>

Validate and convert to a Ragrig configuration.

pub fn prompt_path(&self) -> Option<PathBuf>

The custom prompt file, resolved against the workspace.

pub fn effective_prompt(&self) -> Result<String, String>

The prompt in effect: the selected file, or the inline prompt.

pub fn use_built_in_prompt(&mut self)

Clear the prompt file and restore the host’s compiled-in prompt.

pub fn to_setup(&self) -> Result<RagSetup, String>

Validate and produce a build setup, including the prompt override.

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

Check the editable values without touching the filesystem.

pub fn refresh_profiles(&mut self)

Re-read the profile list from the workspace and ~/.ragrig.

Workspace profiles shadow global profiles with the same name.

pub fn save_profile(&mut self) -> Result<(), String>

Save these settings as a named profile in the workspace.

pub fn load_profile(&mut self, name: &str) -> Result<(), String>

Load a named profile from the workspace, then from ~/.ragrig.

pub fn add_corpus(&mut self, name: &str, folder: &Path)

Remember a folder corpus so later applies keep it.

Trait Implementations

impl Clone for RagSettings

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 RagSettings

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

Formats the value using the given formatter.

impl Default for RagSettings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RagSettings

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RagSettings