ExOKF — the reference Elixir implementation of the Open Knowledge Format (OKF).
Provides standards-compliant parsing, validation with rich diagnostics, lossless reading/writing, link resolution, graph indexing, querying, and provenance-aware AI context assembly.
Public API
{:ok, bundle} = ExOKF.load("path/to/bundle")
{:ok, diags} = ExOKF.validate(bundle)
:ok = ExOKF.write(bundle, "path/to/out")
concepts = ExOKF.query(bundle, type: "BigQuery Table")
{:ok, ctx} = ExOKF.context(bundle, "tables/orders")GraphBLAS acceleration, advanced ranking, and MCP integration are ExOKF extensions layered on top of core OKF conformance — see the roadmap in the project README.
Summary
Functions
Assembles provenance-aware context for a concept.
Loads an OKF bundle from a filesystem path.
Queries concepts in the bundle.
Validates a bundle, returning diagnostics.
Writes a bundle to destination (lossless round-trip of known + unknown frontmatter).
Functions
@spec context(ExOKF.Bundle.t(), String.t(), keyword()) :: {:ok, ExOKF.Context.t()} | {:error, term()}
Assembles provenance-aware context for a concept.
Delegates to ExOKF.Context.build/3.
Parameters
bundle(ExOKF.Bundle.t()) — loaded OKF bundleconcept_id(String.t()) — seed concept idopts(keyword()) —:depth,:token_budget,:include_seed,:chars_per_token
Returns
{:ok, ExOKF.Context.t()}— assembled context{:error, term()}— e.g.{:unknown_concept, id}
Examples
iex> bundle = ExOKF.TestSupport.sample_bundle()
iex> {:ok, ctx} = ExOKF.context(bundle, "tables/orders", depth: 1)
iex> ctx.seed
"tables/orders"@spec load( String.t(), keyword() ) :: {:ok, ExOKF.Bundle.t()} | {:error, term()}
Loads an OKF bundle from a filesystem path.
Delegates to ExOKF.Parser.load/2.
Parameters
path(String.t()) — path to the bundle directoryopts(keyword()) — parser options::max_concurrency(pos_integer()) — parallel parse tasks:timeout(timeout()) — per-task timeout:build_graph(boolean()) — index link graph (defaulttrue)
Returns
{:ok, ExOKF.Bundle.t()}— loaded bundle{:error, term()}— e.g.{:not_a_directory, path}
Examples
iex> {:ok, bundle} = ExOKF.load(ExOKF.TestSupport.minimal_fixture_path())
iex> ExOKF.Bundle.size(bundle) >= 1
true@spec query( ExOKF.Bundle.t(), keyword() ) :: [ExOKF.Concept.t()]
Queries concepts in the bundle.
Delegates to ExOKF.Query.query/2. See that module for filter types.
Parameters
bundle(ExOKF.Bundle.t()) — loaded OKF bundlefilters(keyword()) — AND-combined filters (:type,:tag,:id,:has_resource)
Returns
A list of matching ExOKF.Concept.t().
Examples
iex> bundle = ExOKF.TestSupport.sample_bundle()
iex> ExOKF.query(bundle, type: "BigQuery Dataset") |> Enum.map(& &1.id)
["datasets/sales"]@spec validate(ExOKF.Bundle.t()) :: {:ok | :error, ExOKF.Diagnostics.t()}
Validates a bundle, returning diagnostics.
Warnings alone do not fail validation. Only error-severity diagnostics
produce {:error, diagnostics}.
Delegates to ExOKF.Validator.validate/1.
Parameters
bundle(ExOKF.Bundle.t()) — loaded OKF bundle
Returns
{:ok, ExOKF.Diagnostics.t()}— conformant (warnings allowed){:error, ExOKF.Diagnostics.t()}— non-conformant
Examples
iex> bundle = ExOKF.TestSupport.sample_bundle()
iex> {:ok, diags} = ExOKF.validate(bundle)
iex> is_struct(diags, ExOKF.Diagnostics)
true@spec write(ExOKF.Bundle.t(), String.t()) :: :ok | {:error, term()}
Writes a bundle to destination (lossless round-trip of known + unknown frontmatter).
Delegates to ExOKF.Writer.write/2.
Parameters
bundle(ExOKF.Bundle.t()) — in-memory bundledestination(String.t()) — output directory path
Returns
:ok— success{:error, term()}— filesystem error
Examples
iex> bundle = ExOKF.TestSupport.minimal_bundle()
iex> dest = Path.join(System.tmp_dir!(), "ex_okf_api_write_" <> Integer.to_string(:erlang.phash2(make_ref())))
iex> ExOKF.write(bundle, dest)
:ok