Versions
Manage and explore different versions of your AI circuit
Versions
Each AI Circuit in ModelWorks can evolve over time. Every change—whether it’s a bug fix, performance improvement, or new feature—creates a new version. The Versions tab lets you:
- Browse all published versions in chronological order.
- Inspect details like creation time, status, and performance metrics.
- Download artifacts (circuit definition, query schema, README, LICENSE).
- Deprecate old or broken versions to guide users toward the latest stable release.
Version List
When you open the Versions tab, you’ll see a paginated list of all versions for the current circuit. Each row (a Version Cell) shows:
- Version ID & Timestamp: A unique identifier plus when it was created.
- Status: One of several states (Staging, Validating, Running, Validated, Deprecated, etc.).
- Metrics: Quick glance at Runs, Embeds, Nodes, Error Rate.
- Actions: Download links and owner-only operations (upload README/LICENSE, deprecate).
Status Overview
Each version transitions through a lifecycle. Common states include:
| State | What It Means |
|---|---|
| BUILDING | The version is being built and uploaded. |
| STAGING | Newly created and under development. |
| VALIDATING | The system is running validation checks (syntax, schema, limits). |
| VALIDATION_FAILED | Validation checks failed; the version cannot be used until fixed. |
| VALIDATED | All checks passed; ready for production use. |
| RUNNING | Actively in use and healthy. |
| DEPRECATED | Marked obsolete—consider using a newer version. |
| DEACTIVATED | Manually deactivated; the version is disabled and cannot be queried. |
| EXCEPTION | Experienced a high error rate in the last 24 hours. |
Tip: Hover over a status badge or refer to the tooltip to see more details on what each state entails.
Performance Metrics
ModelWorks tracks key metrics for every execution of each version. In the Versions list you’ll see:
| Metric | Description |
|---|---|
| Runs | Total number of times this version was used. |
| Embeds | How many embedded calls were made. |
| Nodes | Number of logical steps (tasks) in the circuit. |
| Error Rate | Failure percentage across all runs. |
High error rates may automatically push a version into the EXCEPTION state.
Downloads & Documentation
For each version you can download:
- Query Schema (
.json): The input/output contract for programmatic use. - Circuit Definition (
circuit.json): The raw JSON file that defines the circuit’s logic. - README.md (owner-only): Human-friendly guide—upload or update your README per version.
- LICENSE.md (owner-only): Attach or update per-version licensing details.
Use these artifacts to integrate with CI/CD, terraform, or share with your team.
Adding & Deprecating Versions
Only the circuit author sees the Add Version button:
- Click Add Version to upload a new
circuit.jsonfile. - Wait for validation to complete—your version will move from STAGING → VALIDATED.
To retire an old version, click Deprecate and confirm by typing your username/circuitName. Deprecated versions still function but incur deprecation notices in the UI and API.
Pagination & Navigation
- Versions are displayed 10 per page by default. Use the pagination controls at the bottom to jump between pages.
- Clicking a version ID opens its detail view, where you can see full syntax, history, and change logs.
Now you’re equipped to manage your circuit’s lifecycle—release new features confidently and ensure consumers always target the best version!