Skip to content

Versions

The Versions page in the application allows users to manage different versions of their AI agents. This is crucial for testing new configurations, features, or prompts without affecting the live or production version of an agent. It supports a lifecycle from drafting to live deployment and archiving, with added controls for privacy, exporting, and encryption.

Overview

The page provides functionalities to:

  • Add new versions for a selected agent with specific attributes.
  • List existing versions, including their status and privacy level.
  • Edit the metadata of existing versions.
  • Export versions in two different formats: full or shortcut.
  • Delete versions.

Important Note: When a new version is created, the system captures the current configuration of the selected agent (including its associated prompts, intents, variables, tools, etc.). This snapshot is then stored as a secure JSON data payload within the version record.

Versions

Adding a New Version

To add a new version for the currently selected agent:

  1. Navigate to the Versions page.
  2. Ensure an agent is selected via the global agent selector. If not, you will be prompted to select one.
  3. Expand the "New Version" section to reveal the form.
  4. Fill in the following fields:
    • Current Active Version: (Toggle) If enabled, this new version will become the active one for its specified Version Type. Any other version of the same type for this agent will be automatically deactivated. Default is On.
    • Private Version: (Toggle) If enabled, this version is marked as private. Private version exports will require an encryption key secret to be used. Default is Off.
    • Allow Import: (Toggle) If enabled, this version can be imported into other accounts, provided the user has the necessary permissions and keys. Default is Off.
    • Version Name: (Text Input) A descriptive name for this version (e.g., "v1.0-Release", "Feature-X-Test"). Spaces and underscores are automatically converted to hyphens.
    • Version Type: (Selectbox) The category or stage of this version. Options include draft, development, test, live, and archived.
    • Required Encryption Key: (Selectbox) The encryption key this version will be associated with. This key is used for securing the version data and is required for exporting. The list is populated with active, non-revoked keys available to the selected agent.
    • Version Description: (Text Area) A detailed description of what this version entails or any changes it includes.
  5. The system will indicate that the "Agent will generate using current configuration."
  6. Click the "Create Version" button.
  7. Upon submission, the agent's current configuration is snapshotted, encrypted, and stored as the new version.

Listing Versions

Existing versions for the selected agent are listed under the "Versions" subheader.

  • Filtering: The list is automatically filtered for the globally selected agent.
  • Display: Each version is shown in an expandable section with its name, privacy icon (:material/lock: for private, :material/public: for public), type, status (:white_check_mark: for active, :x: for inactive), and the agent name.
  • Details: Expanding a version's section reveals:
  • Version Type and Last Modified timestamp.
  • The name of the Encryption Key associated with it.
  • Version Description.
  • The snapshotted agent configuration (as JSON, collapsed by default).
  • Each version entry includes buttons for editing, exporting, and deleting.

Exporting a Version

You can export a version as either a full agent file or a shortcut. This is a two-step process: first prepare the export, then download it.

  1. Prepare the Export:
    • Export Agent: Click this to prepare a full, encrypted backup of the agent version. The system generates a file with the .aia extension. This file contains the complete agent definition, encrypted with the version's specified key.
    • Export Shortcut: Click this to generate a lightweight reference file with a .shortcut.aia extension. This file does not contain the agent data itself but includes a prefixed header used to identify and retrieve the full version from its source.
  2. Download the File:
    • After clicking an export button, a "Download" button will appear. Click it to save the prepared file to your local machine.

Editing a Version

To edit an existing version's metadata:

  1. Click the ":material/edit:" button next to the desired version.
  2. The "Edit version" form appears, pre-filled with the version's current information.
  3. You can modify the following fields:
    • Current Active Version: (Toggle) Change the active status.
    • Private: (Toggle) Update the privacy setting.
    • Allow Import: (Toggle) Change whether the version can be imported by others.
    • Version Type: (Selectbox) Re-categorize the version.
    • Encryption Key: (Selectbox) Re-assign the encryption key.
    • Version Description: (Text Area) Update the description.
    • The Version Name and Version Agent Name are displayed but cannot be changed.
  4. Click "Save Changes" to update the version, or "Cancel" to exit.

Deleting a Version

To permanently delete a version:

  1. Click the ":material/delete:" button next to the desired version.
  2. The version record will be removed from the database. This action cannot be undone.