Python SDK specification

Planned. There is no released RegesARC Python package or verified pip installation command. The current desktop core has no supported public Python client. Installing LM Studio’s SDK does not install a RegesARC SDK.

Intended scope

A Python client should target the versioned public API once that API is qualified. It should discover capabilities, list actual model instances, request explicit loading, stream generation, cancel by request ID, obtain usage and errors, and release only resources it owns. It must not scrape private desktop state or reuse a hidden Lemonade administrative credential.

Resource management

Provide a deliberate synchronous scoped interface and an asynchronous structured-concurrency interface. Connections and background tasks need deterministic cleanup. Cancellation must close or abort the request, wait for terminal settlement and leave the service recoverable; dropping a generator object is not sufficient proof that GPU work stopped.

Timeouts should distinguish connect, model loading, first event and idle stream deadlines. Preserve original error classification and request correlation. Retrying a non-idempotent operation must not create duplicate downloads or model instances.

Types and model identity

Requests should validate exact integers and declared capabilities. Model handles should identify immutable artifacts and loaded instances separately. A convenience alias must not hide a change in quantization, context or weights. Unknown usage/state fields remain absent, not synthetic zeros.

Text generation, embeddings and multimodal input are separate capability families. Embedding dimensions, pooling and token limits require their own qualified model. Tool schemas and execution permissions belong to independent model/host gates.

Qualification checklist

Test supported Python versions, package provenance, authentication, sync/async cleanup, stream assembly, cancellation, error propagation, reconnect behavior and server-version mismatch. Publish an install command only after the actual package, version and distribution identity are established.

The official LM Studio Python documentation is a behavioral reference for its own client, including scoped and asynchronous use. RegesARC’s future client should offer similarly explicit ownership while retaining its own naming, protocol versions and tested behavior.