Open ContextOCTX
v0.1中文
Docs/Export and Configuration

Build and Integrate

Export and Configuration

OCTX export and the boundary of local configuration.

Status: v0.1 design baseline. This document uses SAG to explain how to export .octx files and which local configuration must not enter a Package.

Exporting OCTX from SAG

python
result = export_octx(source_or_asset, output, version=...)

Default behavior:

  • A locally created working asset retains its asset_id.
  • Export the structure and declare sag-structured only when chunks, events, entities, and both relation layers are complete.
  • Do not include a partially completed structure in the Package.
  • Every exported vector target must be complete; omit incomplete targets.
  • documents_only=True exports Markdown only.

Locally enriched data generated after importing a Package must first become a new Derived Asset before it can be redistributed, with the following source recorded:

json
{
  "asset_id": "source-asset-uuid",
  "version": "source-version",
  "package_digest": "sha256:source-digest"
}

An externally imported asset always remains read-only, verifiable, and upgradeable.

Local Configuration Boundary

The following information belongs to an Installation or local product state and is not written back to an OCTX Package:

  • SAG Source IDs and database primary keys.
  • Agent bindings, favorites, permissions, and local tags.
  • Vector databases, index parameters, and retrieval distance metrics. Whether bundled vectors are normalized is a compatibility fact in vectors/config.json.
  • API addresses, keys, and vendor connection configuration.
  • Local entity alignment and retrieval caches.
  • indexing / ready / degraded state.

A Package stores only exchangeable asset facts and explicitly declared derived payloads.