Skip to main content

SingleAxis Fabric SDK for Python — inline guardrails, memory, tracing, escalation helpers.

Project description

singleaxis-fabric (Python SDK)

Native Python SDK that tenant agents import in-process. Provides the decision-span contract, guardrail/escalation types, OTel plumbing, and optional adapters for LangGraph, Microsoft Agent Framework, and CrewAI (installed via extras — the core SDK stays framework-neutral).

Authoritative specs

Status

Pre-alpha — Phase 1a shipping.

Shipping now

  • Fabric client (Fabric.from_env, FabricConfig, close())

  • Decision context manager — opens an OTel span per agent call and tags it with the Fabric-standard attributes:

    • fabric.tenant_id, fabric.agent_id, fabric.profile
    • fabric.session_id, fabric.request_id, fabric.user_id
    • fabric.blocked, fabric.blocked.policies (on block)
  • Guardrail types: GuardrailResult, EntitySummary, GuardrailBlocked, GuardrailNotConfiguredError

  • Presidio rail via UDS sidecar: UDSPresidioClient, RedactionResult, RedactionError. Decision.guard_input, guard_output_chunk, and guard_output_final route through the chain and emit fabric.guardrail span events (phase, latency_ms, blocked, entities, policies).

  • NeMo Colang rail via UDS sidecar: UDSNemoClient, NemoResult, NemoError. Wired into the same chain; runs after Presidio so the Colang / LLM checks never see raw PII. May block (action == "block"), with the canned response surfaced on the GuardrailResult.

  • OTel helpers: get_tracer, install_default_provider

  • Decision-level block recording (record_block, raise_for_block)

  • Retrieval recording: RetrievalSource, RetrievalRecord, Decision.record_retrieval(source, query=..., result_count=..., ...). Hashes the query with SHA-256 locally (raw text never hits the span), emits a fabric.retrieval span event with allowlisted attributes, and maintains rolling fabric.retrieval_count and fabric.retrieval_sources on the decision span so the Telemetry Bridge can fold them into the DecisionSummary wire event. Maps onto the Context Graph's Retrieval node (spec 003).

  • Escalation pause primitive: EscalationSummary, EscalationRequested, Decision.request_escalation, Decision.raise_for_escalation. Records fabric.escalated, fabric.escalation.reason/rubric_id/ mode/triggering_score on the span and emits a fabric.escalation span event. EscalationSummary.to_payload() returns the framework-agnostic dict tenants hand to whatever interrupt primitive their orchestrator exposes (LangGraph interrupt(), Agent Framework checkpoints, a bespoke queue). The SDK owns the local signal only; the downstream SASF review + signed-verdict resume lives in the escalation service (spec 007).

  • Memory write recording: MemoryKind, MemoryRecord, Decision.remember(kind=..., content=..., key=..., tags=..., ttl_seconds=...). Tenants perform the actual write against their own memory store; the SDK SHA-256s the content locally (raw text never hits the span) and emits a fabric.memory span event with the allowlisted metadata, plus rolling fabric.memory_write_count and fabric.memory_kinds attributes the Telemetry Bridge folds into the DecisionSummary wire event. Symmetric to record_retrieval — the Context Graph materializes the write as a Retrieval node with source=memory tied to the owning Decision.

    from fabric import MemoryKind
    
    with fabric.decision(session_id=sess, request_id=req) as decision:
        answer = my_agent.run(user_input)
        my_memory_store.write(key="last_answer", value=answer)
        decision.remember(
            kind=MemoryKind.EPISODIC,
            key="last_answer",
            content=answer,
            tags=("turn", "assistant"),
        )
    

When no rails are configured, guard_input / guard_output_* raise GuardrailNotConfiguredError. This is a deliberate fail-loud posture — a silently passing guardrail is a compliance footgun.

Framework adapters (optional)

The core SDK is framework-neutral. Adapters live under fabric.adapters.* and are each gated behind an install extra so the core install does not pull in any orchestration package.

  • fabric.adapters.langgraph.escalate(decision, summary) — records the Fabric escalation on the decision span and calls langgraph.types.interrupt(payload). Returns whatever the host resumes the graph with (typically the signed verdict).
  • fabric.adapters.agent_framework.request_escalation(ctx, decision, summary, *, response_type=...) — records on span, then await ctx.request_info(request_data=..., response_type=...). The resumed response is routed to a MAF @response_handler method (dispatch-based, per MAF design).
  • fabric.adapters.crewai.attach_callbacks(decision) returns CrewCallbacks (step + task callbacks that record CrewAI lifecycle events on the decision span). fabric.adapters.crewai.request_escalation(decision, summary) records on span and returns the canonical payload — the tenant pairs it with their chosen CrewAI HITL channel (@human_feedback Flow, Task(human_input=True), or enterprise /resume).

Install

pip install singleaxis-fabric                         # core
pip install "singleaxis-fabric[otlp]"                 # + OTLP/HTTP exporter
pip install "singleaxis-fabric[langgraph]"            # + LangGraph adapter
pip install "singleaxis-fabric[agent-framework]"      # + MAF adapter
pip install "singleaxis-fabric[crewai]"               # + CrewAI adapter

Quick start

import os
from fabric import Fabric, install_default_provider
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter

# Host chooses how to export — typically an OTLP endpoint pointing at
# the Fabric OTel Collector. install_default_provider is a convenience
# for small agents; production hosts wire the provider themselves.
install_default_provider(
    service_name="support-bot",
    exporter=OTLPSpanExporter(endpoint=os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"]),
)

fabric = Fabric.from_env()

with fabric.decision(
    session_id=session.id,
    request_id=req.id,
    user_id=user.id,
) as decision:
    # real work happens here; the decision span wraps it all
    safe_input = decision.guard_input(req.body)
    output = llm.complete(prompt=safe_input)
    final = decision.guard_output_final(output)
    decision.set_attribute("llm.model", "claude-opus-4-7")

guard_input / guard_output_* are no-ops that raise GuardrailNotConfiguredError unless FABRIC_PRESIDIO_UNIX_SOCKET is set (or a PresidioClient is passed to Fabric(...) directly).

Environment variables

Variable Required Purpose
FABRIC_TENANT_ID yes Tenant scope for all emitted events.
FABRIC_AGENT_ID yes Which agent in the tenant is running.
FABRIC_PROFILE no Regulatory profile (default permissive-dev).
FABRIC_PRESIDIO_UNIX_SOCKET no Unix socket path to the Presidio sidecar (/v1/redact). If unset, the Presidio rail is not installed.
FABRIC_PRESIDIO_TIMEOUT_SECONDS no Per-call timeout for the sidecar (float, default 0.5).
FABRIC_NEMO_UNIX_SOCKET no Unix socket path to the NeMo Colang sidecar (/v1/check). If unset, the NeMo rail is not installed.
FABRIC_NEMO_TIMEOUT_SECONDS no Per-call timeout for the NeMo sidecar (float, default 1.0).

Module layout

sdk/python/
├── pyproject.toml
├── src/fabric/
│   ├── __init__.py
│   ├── client.py          # Fabric, FabricConfig, from_env
│   ├── decision.py        # Decision context manager
│   ├── guardrails.py      # result + error types
│   ├── escalation.py      # EscalationSummary + EscalationRequested
│   ├── presidio.py        # PresidioClient protocol + UDS impl
│   ├── nemo.py            # NemoClient protocol + UDS impl
│   ├── retrieval.py       # RetrievalSource + RetrievalRecord
│   ├── _chain.py          # GuardrailChain (internal)
│   ├── _uds.py            # HTTP-over-unix-socket transport
│   ├── tracing.py         # OTel helpers
│   └── py.typed
└── tests/
    ├── conftest.py
    ├── _fake_sidecar.py
    ├── test_client.py
    ├── test_decision.py
    ├── test_guardrail_chain.py
    ├── test_escalation.py
    ├── test_nemo.py
    ├── test_presidio.py
    ├── test_retrieval.py
    └── test_tracing.py

Tests

python -m venv .venv && . .venv/bin/activate
pip install -e '.[dev]'
pytest

Coverage threshold is 85% at the pyproject level. Current baseline is ~98% because the Phase 1a surface is narrow; as guardrails and memory land, keep the 85% floor honest rather than moving it.

Versioning

Independent of the Fabric umbrella version pre-1.0.0. Tenant agents pin the SDK; the Control Plane advertises compatibility ranges.

License

Apache-2.0. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

singleaxis_fabric-0.1.1.tar.gz (37.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

singleaxis_fabric-0.1.1-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file singleaxis_fabric-0.1.1.tar.gz.

File metadata

  • Download URL: singleaxis_fabric-0.1.1.tar.gz
  • Upload date:
  • Size: 37.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for singleaxis_fabric-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3a6b9a8c86437e182e8ec69fe9671749ef8f710f3c096ff58c422c3f32344024
MD5 7455554cb499b2a5ca5da8241dd55305
BLAKE2b-256 0611cbe61c61bf79b1c2a8c2ba4b107b5c17779300a174b56e0ffff7bb5c94fc

See more details on using hashes here.

Provenance

The following attestation bundles were made for singleaxis_fabric-0.1.1.tar.gz:

Publisher: release.yml on singleaxis/singleaxis-fabric

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file singleaxis_fabric-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for singleaxis_fabric-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 24447c8140b860fba31d116583a5d1b8fbf10d45fa4ceb13bb3e2a2cf086897f
MD5 6cf5f2c3aab1efeae00fa9fc4bca312c
BLAKE2b-256 aa61127e467f826e7cf4a3ed2bddac16f0bd1d62d86aa42ddf34c0746370c1a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for singleaxis_fabric-0.1.1-py3-none-any.whl:

Publisher: release.yml on singleaxis/singleaxis-fabric

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page