API Reference¶
Complete API documentation for the CRP Python SDK.
Quick Links¶
-
crp.Client— Create sessions, configure providers, manage lifecycle. -
All 9 dispatch strategies with signatures and return types.
-
Risk classification, PII scanning, audit trail, human oversight.
Import Patterns¶
# Main client (recommended)
from crp import Client
# Direct orchestrator import
from crp.core import CRPOrchestrator
# Client is an alias for CRPOrchestrator
assert Client is CRPOrchestrator
Key Return Types¶
| Type | From | Fields |
|---|---|---|
QualityReport |
All dispatch methods | output, quality_tier, continuation_windows, envelope_saturation, facts_extracted, security_flags, telemetry |
ExtractionResult |
ingest() |
facts_extracted, source_label, fact_ids |
SessionStatus |
session_status() |
session_id, windows_completed, total_input_tokens, total_output_tokens, facts_in_warm_state, overhead_ratio, remaining_budget, total_cost |
EnvelopePreview |
preview_envelope() |
total_tokens, envelope_tokens, generation_reserve, facts_included, facts_available, saturation |
StreamEvent |
dispatch_stream() |
event_type, data |