Gralkor.Config (jido_gralkor v4.0.0)

Copy Markdown View Source

Configuration for the embedded Gralkor runtime.

Two operator-facing knobs decide what :jido_gralkor does at boot:

  • The FalkorDB connection — either embedded (falkordblite spawns a local redis-server child under a directory chosen by GRALKOR_DATA_DIR) or remote (network host:port plus optional credentials, set via the :jido_gralkor, :falkordb application env). Remote wins when both are configured. See falkordb_spec/0.
  • The LLM and embedder models — set via the GRALKOR_LLM_MODEL and GRALKOR_EMBEDDER_MODEL env vars in "provider:model" form (operator contract). llm_model/0 and embedder_model/0 return them as %{provider: atom(), id: String.t()} maps — the inline-map shape ReqLLM.model/1 accepts without a catalog lookup (no "unverified model" IO.warn when the model id is newer than the LLMDB snapshot bundled with req_llm).

Summary

Types

falkordb_spec()

Resolved FalkorDB selection. :remote carries the validated keyword list the operator supplied; :embedded carries the expanded data directory.

model_spec()

Resolved model spec — the inline-map shape ReqLLM.model/1 accepts directly.

Functions

embedder_model()
falkordb_spec()

Resolve the FalkorDB connection spec from configuration. Returns nil when neither knob is set so the supervisor can run with no children.

llm_model()
ontology()

Resolve the optional deployment-wide ontology from the :jido_gralkor, :ontology application env.

validate_falkordb!(kw)

Validate a remote FalkorDB keyword spec. Raises ArgumentError with a pointed message if the shape is wrong; returns the keyword list unchanged on success.

Types

falkordb_spec()

@type falkordb_spec() :: {:remote, keyword()} | {:embedded, String.t()}

Resolved FalkorDB selection. :remote carries the validated keyword list the operator supplied; :embedded carries the expanded data directory.

model_spec()

@type model_spec() :: %{provider: atom(), id: String.t()}

Resolved model spec — the inline-map shape ReqLLM.model/1 accepts directly.

Functions

embedder_model()

@spec embedder_model() :: model_spec()

falkordb_spec()

@spec falkordb_spec() :: falkordb_spec() | nil

Resolve the FalkorDB connection spec from configuration. Returns nil when neither knob is set so the supervisor can run with no children.

Remote wins over embedded when both are present.

llm_model()

@spec llm_model() :: model_spec()

ontology()

@spec ontology() :: module() | nil

Resolve the optional deployment-wide ontology from the :jido_gralkor, :ontology application env.

This is the single source of truth for ontology: it is never read from agent state, plugin mount opts, or per-call context. Every write path (capture, memory_add) resolves it from here. Returns the module (declared via use Gralkor.Ontology) or nil when unset. Raises ArgumentError on a module that is not an ontology, or any non-module value — fail-fast on operator misconfig at the write boundary rather than as a downstream graphiti failure.

validate_falkordb!(kw)

@spec validate_falkordb!(any()) :: keyword()

Validate a remote FalkorDB keyword spec. Raises ArgumentError with a pointed message if the shape is wrong; returns the keyword list unchanged on success.