Version management allows you to track changes to your Neurons, maintain different versions of your configurations, and control what version is currently deployed and serving requests.

​
Version Management

Version management interface

​
Creating Versions

Each time you make changes to your Neuron, you can create a new version:

  • Give your version a custom name for easy identification
  • Track when versions were created and by whom
  • See detailed timestamps by hovering over the version date
    • UTC timestamp
    • Local time conversion
    • Relative time (e.g., “17 days ago”)

Versions serve as snapshots of your Neuron configuration. They include all node configurations, and connections between nodes at the time of creation.

Settings are not versioned and exist at the Neuron level. This means that if you make changes to a setting, it will affect all versions of the Neuron, including already deployed versions.

​
Version History

The version history shows:

  • All versions of your Neuron
  • When each version was created
  • Who created each version
  • Which version is currently deployed

Once a version is deployed, it cannot be edited. This ensures consistency in production. If you try to make changes to a deployed version, Prompteus will offer to create a duplicate of it first.

​
Deployment

Deploying a version

​
Deploying a Version

To make your Neuron available for use, you must deploy a version:

  1. Select the version you want to deploy
  2. Click the “Deploy” button
  3. Confirm the deployment

Your Neuron is not available for use until you deploy a version. This ensures that only intentionally released configurations can be called.

​
Deployment Rules

When deploying a version:

  • Only one version can be deployed at a time
  • Deploying a new version will replace the currently deployed version
  • The deployed version becomes read-only
  • You can still delete a deployed version, but you should deploy another version first

​
Making Changes to Deployed Versions

If you need to modify a deployed version:

  1. Click the ”…” menu on the version
  2. Select “Duplicate”
  3. Make your changes to the duplicate
  4. Deploy the new version when ready

​
Best Practices

  1. Version Naming

    • Use descriptive names for versions
    • Include the purpose of changes
    • Consider including version numbers

  2. Deployment Strategy

    • Test versions thoroughly before deployment
    • Consider maintaining a staging version by duplicating your Neuron
    • Document changes between versions

  3. Version Management

    • Keep track of which changes are in each version
    • Clean up unused versions periodically
    • Maintain at least one stable version