Configure Agent types

The following figure shows the Agent Configuration page.

Agent types

Users select an Agent type first when they create an instance. The Agent type determines which configuration template the instance uses, which configuration file it writes to, which SandboxSet it is associated with, which user it starts as, and how to modify models and channels.

A new environment deployed through Compute Nest includes the following built-in Agent types by default:

View Agent configuration

You can view the configuration of an Agent type in the administrator console:

1. Log on to the administrator console.

2. Open Agent Configuration.

3. Select the target Agent type in the list.

4. View the basic configuration, configuration template, channel template, and command scripts.

The following figure shows the configuration of an Agent type.

Configuration templates

A configuration template generates the Agent configuration file for each instance.

Templates support placeholders. When a user creates an instance or an administrator saves the configuration, the system writes the model, channel, and custom variable values into the template.

Common placeholders include:

When you add a model provider, apiKeyPlaceholder and domainPlaceholder must exactly match the placeholder names used in the template and the command scripts.

Configuration write path and sandbox user

An Agent type must declare where the configuration file is written and which sandbox user it runs as.

Common examples:

The sandbox user must match the user that actually runs in the SandboxSet image. For Hermes, confirm the actual user in the image configuration before you save.

Custom variables

Custom variables pass the business parameters that differ from instance to instance into the Agent, such as a project token, a webhook address, an external service API key, or a system prompt.

Define the fields in the custom variable area of Agent Configuration. When a user creates an instance, the page displays an input box for each defined field.

The following table describes the custom variable fields.

Channel templates

Agent types that support channels maintain channel templates. A channel template defines the IM or conversation access parameters that users fill in when they create an instance, such as the app ID, secret, webhook, or token for Lark, DingTalk, WeCom, or QQ.

When you configure a channel template, make sure that:

• The field names match the placeholders in the Agent configuration template.

• Secret fields use the password type, so that they are not displayed in plain text on pages or in logs.

• The channel template describes only the channels that this Agent type supports. Do not mix in private fields from other Agent types.

After a user creates an instance and selects a channel, the page displays a form based on the channel template and writes the submitted values into the instance configuration.

Upgrade configuration entry

The Agent type details page contains the Backup & Upgrade Configuration tab, which stores the pre-upgrade backup command, the post-upgrade restore command, and the command timeout.

When an Agent upgrade starts, the platform reads these settings and applies them to the target sandbox.

These settings only define how to back up and restore the data of this Agent type during an upgrade. For instance backup operations, see Agent backup. To select a sandbox, start an upgrade, view the history, and handle failed tasks, see Agent upgrade.

Add an Agent type

You can add an Agent type in two ways: copy an existing type, or create a custom type. Choose one of the two methods.

A built-in type that already declares its configuration write path, sandbox user, and startup command can be used to create instances directly. To adjust a built-in type, copy it first and test the copy.

Copy an existing type when you only need to change the name, code, template, commands, or channel configuration of an existing type. Create a custom type when you need to prepare your own Agent image and SandboxSet YAML.