Nyraxis/ docs
Guides
Developer documentation

Local SDK rehearsal

Run the repository’s synthetic SDK lifecycle rehearsal without treating it as a live-model benchmark.

The backend repository includes a self-contained Python support rehearsal at sdk/python/examples/support_pilot. It exercises decisions, error handling, streaming lifecycle, and an owned local telemetry receiver. Its model and evaluator are scripted fixtures; use the separate LangGraph guide for a real model/tool integration.

Get the example

Check out the backend revision that matches the SDK release and read sdk/python/examples/support_pilot/README.md. The scripts are shipped in that repository; no privately supplied release-owner file or historical development wheel is required by this guide.

Use Nyraxis Python SDK 1.3.2, not a similarly named package. The SDK reference version is 1.3.2; use a supported Python interpreter such as Python 3.12. Create a dedicated virtual environment and install the example's documented dependencies. For approved offline use, prepare a complete compatible wheelhouse and verify release artifact hashes against your release process.

What it verifies

The runner uses synthetic support records and local HTTP fixtures. It checks complete allows, blocks, incomplete and malformed decisions, access denial, model failure, early stream closure, and sync/async cleanup. The configured OpenTelemetry receiver checks actual exported parent/child spans.

Read the runner's emitted result and exit code. The recorded rehearsal's expected 14 scenarios and six mock model operations are fixture acceptance criteria, not a customer accuracy or performance benchmark.

Move to a live integration

  1. Create a real organization-scoped ingest key and an enabled agent-scoped Secrets policy.
  2. Run the quickstart against your actual backend.
  3. Use the live LangGraph example with your model-provider key.
  4. Count provider operations in warning, blocking, unavailable, and input-block cases.
  5. Inspect actual stored traces and capture behavior.

The published SDK's availability does not certify every provider, framework, operating system, or deployment. See coverage.

On this page