API Reference¶
This section is the auto-generated reference for the crp Python package. Every page is built from source docstrings using mkdocstrings, so it stays in sync with the code.
Progressive SDK
New to CRP? Start with the SDK Reference for guided tutorials. This API reference is the concise, symbol-by-symbol companion.
Namespace map¶
The SDKClient exposes advanced capabilities through typed namespaces. Each namespace corresponds to a subsystem documented on its own page below.
| SDK namespace | Underlying subsystem | Typical use |
|---|---|---|
client.activation | ActivationMode | Activation stages and onboarding |
client.agent | AgentSafetyBudget | Multi-agent safety budgets |
client.audit | ComplianceAuditTrail | Tamper-evident audit trail |
client.ckf | ContextualKnowledgeFabric, CDGRResult | Knowledge graph queries and search |
client.compliance | RiskClassifier, ComplianceReporter | Regulatory classification and reports |
client.comply | ComplyGatewayClient | Comply Gateway client, quota gate, and billing webhooks |
client.cso | CognitiveStateObject | Cross-window state relay |
client.events | EventEmitter proxy | Observability event bus |
client.extract | ExtractionPipeline, Fact | Document and tool-result extraction |
client.gateway | GatewaySession, ProviderRouter | Gateway session, router, and key vault |
client.headers | CRP header helpers | Header emission, parsing, and halt detection |
client.knowledge | CKF proxy | Semantic search and pattern query |
client.observability | AuditLogger, MetricsExporter | Audit logs, metrics, telemetry, and structured logging |
client.policy | Safety policy surface | Policy enforcement, profiles, and violation reporting |
client.providers | LLMProvider | Provider adapters and discovery |
client.provenance | DecisionProvenanceEngine | Claim grounding and hallucination detection |
client.reasoning | MetaLearningEngine | Reasoning scaffolding and meta-learning |
client.safety | SafetyControlPlane, Checkpoint | Safety rules, checkpoints, human oversight |
client.scan | CRPScanGitHubApp, RemediationEngine | GitHub App, remediation, and semantic code ingestion |
client.storage | WarmStateStore, CoverageSet | Warm-state and coverage visibility |
client.core | CRPOrchestrator, WindowDAG | Orchestrator, session, DAG, config, and ledger |
client.continuation | ContinuationManager, DocumentMap | Continuation, document map, flow, voice, gap |
client.envelope | EnvelopeBuilder, CrossEncoderCache | Envelope builder, packer, reranker, CDR |
client.state | WarmStateStore, SnapshotManager | Warm store, cold storage, snapshots, event log |
client.security | SafetyManifest, RBACEnforcer | Audit trail, consent, RBAC, checkpoints |
client.resources | AdaptiveAllocator, CostModel | Adaptive allocator, cost model, resource manager |
client.advanced | LLMContextCurator, MetaLearningEngine | Curator, feedback, meta-learning, grounding |
client.cli | CRPSidecarHandler, StartupResult | Sidecar handler and startup helpers |
client.errors | CRPError, SafetyViolation | Public exception classes |
How to read these pages¶
- SDK proxy pages document the public namespace returned by
client.<namespace>. They are thin, typed facades over the internal subsystem. - Internal module pages document the underlying classes and functions that power the SDK. Import them directly when building on top of CRP rather than using the high-level client.
- Options on every
:::block hide source code (show_source: false) and private members (filters: ["!^_"]).
Full coverage accessors¶
The curated SDK namespaces above cover the common path. For complete access to every public CRP symbol, use the dynamic accessors:
# Live orchestrator - every method/subsystem on CRPOrchestrator
client.orchestrator.dispatch(system_prompt="...", task_input="...")
client.orchestrator.ckf.retrieve(query_embedding=...)
# Any public class/function in any crp.* module
client.modules.envelope.cdr.cdr_rank(...)
ConsentManager = client.modules.security.consent.ConsentManager
The Full Module Reference auto-documents every crp.* module and is regenerated by scripts/generate_api_reference.py.