Skip to main content

LlmSection

Struct LlmSection 

Source
pub struct LlmSection {
    pub backend: Option<String>,
    pub model: Option<String>,
    pub base_url: Option<String>,
    pub api_key_env: Option<String>,
    pub api_key_file: Option<String>,
    pub api_key: Option<String>,
    pub auto_tag: Option<LlmAutoTagSection>,
}
Expand description

v0.7.x (#1146) — [llm] sectioned LLM configuration.

Wire format:

[llm]
backend     = "xai"          # ollama | openai | xai | anthropic | gemini | …
model       = "grok-4.3"     # vendor-specific identifier
base_url    = "https://api.x.ai/v1"   # optional; vendor-default if unset
api_key_env = "XAI_API_KEY"           # env var name (mutually exclusive
                                       # with api_key_file)
# api_key_file = "/etc/ai-memory/keys/xai.key"   # mode 0400 enforced

[llm.auto_tag]
# Fast structured-output sibling (auto_tag, query expansion,
# contradiction detection). Fields fall back to parent [llm]
# field-by-field when unset; commonly only `model` is overridden.
model = "gemma3:4b"

Secret handling discipline. Inline api_key = "<literal>" is REJECTED at parse time — operators MUST use either api_key_env = "<ENV_VAR_NAME>" (resolved at runtime) or api_key_file = "/path/to/key" (mode 0400 enforced, override via AI_MEMORY_PASSPHRASE_FILE_ALLOW_LAX_PERMS=1). Both unset selects the per-vendor-alias env-var fallback chain (see src/llm.rs alias_api_key_env_vars).

Precedence. Resolved via AppConfig::resolve_llm through the uniform precedence ladder: CLI flag > AI_MEMORY_LLM_* env vars > [llm] section > legacy flat fields (llm_model, ollama_url) > compiled default (warn-logged once on the resolver’s CompiledDefault arm).

Fields§

§backend: Option<String>

Backend selector. One of: ollama (native /api/chat + /api/embed, no auth), openai-compatible (generic; requires explicit base_url), or an alias that pre-fills base_url (openai, xai, anthropic, gemini, deepseek, kimi, qwen, mistral, groq, together, cerebras, openrouter, fireworks, lmstudio). Unset = inherit legacy resolution (treated as ollama).

§model: Option<String>

Model identifier passed verbatim to the chat endpoint. Vendor-specific (e.g., grok-4.3, gpt-5, claude-opus-4.7). Unset = backend-specific default (see OllamaClient::from_env).

§base_url: Option<String>

Optional base-URL override. Required when backend = "openai-compatible"; ignored otherwise (vendor-default applies). For backend = "ollama", defaults to http://localhost:11434.

§api_key_env: Option<String>

Name of the environment variable to read at runtime for the API-key Bearer auth secret. Mutually exclusive with api_key_file. Example: api_key_env = "XAI_API_KEY". The AI_MEMORY_LLM_API_KEY process-env override (and the per-vendor fallback chain at src/llm.rs alias_api_key_env_vars) take precedence over this field per the uniform precedence ladder.

§api_key_file: Option<String>

Path to a file whose first line is the API-key Bearer secret. Mutually exclusive with api_key_env. File must be mode 0400 or stricter (overridable via AI_MEMORY_PASSPHRASE_FILE_ALLOW_LAX_PERMS=1 per #1055). Tilde expansion applies.

§api_key: Option<String>

REJECTED AT PARSE TIME. Accepting the field name here lets the validator emit a clear “use api_key_env or api_key_file” error instead of serde’s generic “unknown field”. Operators inlining secrets in the config file see the security-rationale message at load time.

§auto_tag: Option<LlmAutoTagSection>

[llm.auto_tag] sub-table for the fast structured-output sibling (auto_tag, query expansion, contradiction detection). Unset = inherit every field from the parent LlmSection. When set, only the explicitly-provided fields override; unset fields fall back to the parent.

Trait Implementations§

Source§

impl Clone for LlmSection

Source§

fn clone(&self) -> LlmSection

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 LlmSection

Source§

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

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

impl Default for LlmSection

Source§

fn default() -> LlmSection

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

impl<'de> Deserialize<'de> for LlmSection

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for LlmSection

Source§

impl PartialEq for LlmSection

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for LlmSection

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for LlmSection

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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<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<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> 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