Skip to main content
Version: 0.3.1

Prepare for Production

A short checklist before you put the SDK in front of users.

Handle compatibility errors at startup​

The client validates the Engine's contract version and tokenizer identity on first use and raises EngineCompatibilityError when the deployment and the SDK release do not match. Surface this clearly — it means "upgrade the SDK or the Engine", not "retry". SDK 0.3.1 accepts Engine contracts in the range >=1.0.0 <2.0.0; the rules are documented in Compatibility.

Pre-release Engine contracts are rejected unless you opt in explicitly (allowPrereleaseContract / allow_prerelease_contract).

Route deprecation warnings​

The Engine announces upcoming breaking changes as deprecation notices. The SDK surfaces each notice once — by default through console.warn (TypeScript) or the warnings module (Python). In production, route them to your logging system:

const client = new InveraClient({
  baseUrl,
  warn: (message) => logger.warn({ source: "invera" }, message),
});

Timeouts and cancellation​

  • TypeScript — pass an AbortSignal per request (stream({ messages, signal })); abort it to stop the stream.
  • Python — configure timeout_seconds on the client (default 60).

Show what you are connected to​

client.models.current() returns the model id, profile, Engine build, and context window as a stable shape — use it for diagnostics pages and support bundles instead of the raw discovery document.

Treat evidence scores as signals​

Grounding scores quantify how strongly generated words trace back to context — they are not factual verification. Calibrate thresholds against your own data before hiding or blocking content on them, and prefer surfacing requires_review to a human over silently discarding responses. If you need semantic support/contradiction judgements, plug in a verifier.

Pin and upgrade deliberately​

Pin the SDK version in your lockfile or requirements and read the Compatibility rules before upgrading either the SDK or the Engine deployment. Documentation for previous SDK versions is available from the version dropdown in the navigation bar.