Manage Versions

The versioning feature in Max AI allows users to save, restore, and publish different states of a copilot, enabling efficient management of changes. This guide will walk you through how to use the versioning feature to ensure smooth workflow and user experience.

Managing Assistant Versions

The versioning feature enables you to organize and control assistant updates without disrupting end users. Here’s how to manage versions:

Accessing the Versioning Panel

1. Navigate to Skill Studio: Open the assistant whose versions you want to manage.
2. Open the Versioning Menu: Click the "Settings" tab and navigate to "Versions"
3. Select "Manage Versions": This opens the versioning panel, displaying a list of all existing versions with details such as:
   • Creation date
   • Creator
   • Title
   • Description
4. Manage Versions: Click on any version to view options such as:
   • Delete
   • Publish
   • Edit
   • Export

Creating a New Version

When significant changes are made to a assistant—such as updating skills, dataset configurations, or system prompts—versions help you preserve your work and test changes safely.

Steps to Create a Version

1. Open the Versioning Panel: Use the steps above to access the versioning panel.
2. Save a New Version: Click "Save Version" to capture the current configuration.
3. Name the Version: Give your version a meaningful title, and optionally, add a description for clarity.

Use Cases

• Backup Configurations: Store configurations before making major changes.
• Compare Changes: Test new features or updates against a saved version.
• Publish for End-Users: Ensure that only stable versions are available to end users, de-risking any development changes.

Restoring a Previous Version

The restore feature allows you to revert back to a previous state if needed, while ensuring you don't lose any recent changes.

Steps to Restore a Version

1. Select the Version to Restore: Open the versioning panel and find the desired version.
2. Restore the Version: Click on the kebab menu (three vertical dots) next to the version, then select "Restore Version."
3. Backup Current State: The system automatically creates a backup of the current state before applying the older version.
4. Confirm the Restore: Click "Revert" to confirm and apply the restored version to your assistant.

Publishing a Version

Once a version is tested and ready for use, it can be published for all users. Publishing ensures that users interact with a stable, curated assistant, unaffected by ongoing edits or tests.

Steps to Publish a Version

1. Open the Version History Panel: Access the versioning panel and locate the version you wish to publish.
2. Publish the Version: Click the kebab menu next to the version and select "Publish Version."
3. Confirm Publishing: Click "Publish" to finalize.
4. Verification: A yellow checkmark will appear next to the published version, indicating that it is now live for all users.

Key Benefits of Versioning

• Controlled User Experience: Publishing ensures that end-users always interact with a stable and curated assistant version.
• Safeguard Changes: Preserve your work by creating versions before major updates or configuration changes.
• Test without Impact: Manage and experiment with different versions in Skill Studio without affecting the live experience for end-users.

Conclusion

By leveraging the versioning feature in Max AI, you can efficiently manage, restore, and publish assistant versions. This ensures that your product remains stable for users while giving you the flexibility to test and refine changes behind the scenes.