Follow the Insider's icon to the "EToolbox Authoring Insider - Settings" page. You will see several tabs in the page.
The Dialog tools tab is the list of present tools. The tools can be dragged up and down. This will, naturally, change their order in a tool dropdown in an AEM dialog.
You can deactivate or delete a tool by clicking the "Delete" button. If a tool is a variation of common template (e.g., "Expand text" which is a variation of "Text-modifying command"), this variation is removed completely. But if a tool is singular (e.g., "Image caption"), it is essentially disabled and can be brought back later on."
Every tool can be modified by clicking the "Properties" button which opens a properties dialog. Usually the dialog allows altering the title and icon of the tool as well as its enabled status. For AI-powered tools, there is also the possibility to modify prompts and other parameters.
New tools are added by clicking the "Add tool" button. A dialog will open showing templates of tool variations that you can initialize plus the previously disabled tools that you can restore. After you select an option, the property dialog will appear on the screen for the new addition. After submitting the dialog, drag the newly created item to a desired position in the list.
Many tools offer the way to control "Field selection," that is, to what dialog fields in what areas the tool will attach. This setting is a multifield. Every entry is a sort of "rule" that defines the "visibility" of a tool.
A "rule" can be simply a CSS-style selector. Else it can contain one or more key-value pairs optionally preceded by a "required" flag and optionally followed by a selector.
@ name=title|description attribute="data-attribute" .my-title
│ └────────────────key-value pairs────────────────┘ └selector┘
│
└─ an optional flag that says the rule is a requrement
A key-value pair must start with one of the keys enumerated below, followed by one of the equals/includes operators and a value. A value containing spaces must be enclosed in quotes. You can specify several alternative values separated with |.
Between the key and the value in a key-value pair, the following operators can be used:
- = exactly equals;
- ^= starts with;
- $= ends with;
- *= contains (case-insensitive);
- != does not contain (and, subsequently, not equal; case-insensitive).
We process the following keys:
- attribute (alias attr) - an arbitrary attribute of the dialog field, taken by its name (not by value). This is useful for matching numerous fields that all share the same attribute. Using a tool like EToolbox Authoring Kit you can automatically mark all the fields of interest with an attribute like
data-ai-mediatedand then set up all the tools uniformly to match only those fields. Note: this key is only used with the=operator. - component - the name of the component for which this dialog is shown.
- container (alias parent) - the CSS-style selector that would match an arbitrary DOM container in which the current field is located. Note: this key is only used with the
=operator. - href (aliases url, path) - matches the address of the current page. Therefore, you can make some tools be available only in particular pages of your website.
- label - the label of the dialog field.
- name - the value of the
nameattribute of the dialog field. You don't need to precede it with./. Either "regular" text fields or RTE fields will be matched despite the latter having complex structure with the real name-bearing element nested somewhere inside the structure. - selector - a CSS-style selector the current field must match. Note: a selector can just be put after all the key-values pairs without this "introductory" key. The "selector=" key only serves for better readability.
- tab - the name of the tab in the dialog.
- ui - the type of interface the current field is in. Valid options are "dialog", "properties" ("page properties"), and "inplace" ("in-place"). Note: this key is only used with
=and!=operators.
Usually, rules are grouped by the logical OR. That is, if there are several rules, the tool will be attached to a field if at least one of the rules is satisfied. However, if a rule is basically a negation (= it contains only key-value pair(s) with the != operator), it is perceived as a requirement and is considered before the rest of the rules.
You can make any other rule behave as a requirement by prepending @. Multiple requirement rules are combined by the logical AND.
Example: consider the following group of rules:
- component != "Anchor"
- @ ui = dialog
- name="title",
- name=description,
- name = keywords.
This group of rules contains two requirements: one saying that the component name should not contain the word "Anchor", and another saying that the UI must be a component dialog. Also, the group contains three alternative options, each saying about a possible field name. Insider will attach the current tool to all dialog fields with the name "title" or "description", or "keywords" except those in the dialogs of "Anchor", "New Anchor" or "Anchor Nav" components.
Here are some valid examples of "Field selection" rules:
.my-field // Simple CSS-style selectors.
[type="text"]:not(.my-field)
ui=properties field="jcr:description" // Will match only fields with name "jcr:description" in page properties.
component *= "Anchor" field=title // Will match a field with name "title" or "./title" in a dialog
// of a component whose name contains "Anchor".
ui = dialog href *= "/we-retail/"|"/wknd" // Will match all fields in dialogs of components located within pages
// under "/we-retail/" or "/wknd/" section of the site.
// But NOT in page properties, and NOT in an in-place editor.
If the "Field selection" multifield is left empty, the tool is attached to all available text fields and RTEs.
Some tools would allow modifying the LLM prompt. If the label for the prompt textbox says that it supports user input templates, you can make Insider ask for more info before prompting an LLM. An input template is a string enclosed in {{ }} brackets. Inside the template, you put the title of dialog and, optionally, the variants to select from. E.g., the prompt Modify the text to {{ How do you want your text to be modified? }} will make Insider display an input dialog entitled "How you want your text to be modified?" If a user then enters a text like "comply with standards", the actual prompt sent to an LLM will be "Modify the text to comply with standards".
There is a way to display a select list instead of a text input. To do this, you need to put inside the brackets several variants separated by |. E.g., the prompt Modify the text to {{ How do you want your text to be modified? | comply with standards | be more concise | be more engaging }} will make Insider display a select list with three options.
If a prompt supports user-input templates, it may contain any number of templates. Multiple input windows will be displayed sequentially.
The "Image caption" tool fetches an appropriate image rendition from the local AEM storage, encodes it and passes to a provider bound to a multimodal LLM. Apart from prompts, the tool allows setting up a filter for image renditions and the level of detail. Rendition filter is important to select a variant of images with enough visual details and yet not too big to reduce the processing time and token expenditure.
You can specify the filter and a pair of "min width and height - max width and height" separated with a dash or a colon. E.g., 100x100 - 600x600 (this is system's default) or 200x100:500x500. You can also provide only a lower or a higher boundary using one of the >, >=, <, <= tokens in their usual meaning. E.g., >= 200x200 or <800x800.
If there are several image renditions that fall into the filter, Insider will select the one with the smallest byte size.
Since not all image formats are currently supported by OpenAI and similar LLMs, Insider will try to convert an incompatible format (that is, not one of "jpeg", "png", "gif", or "webp") to PNG. The conversion is done by the AEM instance itself. It might fail if a required image codec is not installed on the server.
The Providers tab allows creating, modifying, and deleting/cleaning up providers. Working with this tab follows the same principle as described above.
Speaking about AI integrations, Insider distinguishes templates for external and own providers. External providers are accessed via AEM instance and, therefore, allow extensive access control and/or keeping access tokens. A connection to ChatGPT can serve as an example. "Own" providers are to be accessed directly from the user's browser. They are usually used for testing purposes or for the cases when the user has access a private AI model.
Most important is the possibility to reorder providers. Because a tool can consume different providers, there must be a default ("first-choice") provider. This is the one that is situated in the lost above other providers for the same tool.
Some providers will offer int their properties dialogs a multifield with the name like "Support constraints". It allows setting up matching between the tools and providers. A tool may have its feature requirements declared in the requirements: [...] section of the tool registration statement. Usually, requirements include a mere ID of a tool. Depending on the tool, there can be more requirements.
If a provider's support setting is empty, it will match any requirement. Otherwise, the "Support constraints" multifield can contain some lines like "image" or "!text". The former is a positive match: the provider will match a requirement if it has a support setting that equals to the line, or else starts with the line. The latter is a negative match: the provider will match a requirement if it does NOT equal or starts with the given line. See the examples below:
| Requirement | Support setting | Result |
|---|---|---|
| image | image | match |
| image.create | image | match |
| text | image | no match |
| text.expand | !image | match |
Note: the !-starting settings take precedence over the positive ones: if you, e.g., set up a provider to match !image, it will match any requirements such as text, audio, etc., because they are "no images".
Also, a provider always matches a requirement which is the name of a method declared in the registered provider model.
If a tool introduces multiple requirements, a provider must match all of them to be available for the tool.
Click the "Add provider" button to add a new provider. Select the provider type (or a previously deactivated singular provider instance: same as with tools) in the dialog that opens. Wait for the provider properties dialog to appear. After submitting the dialog, drag the newly created provider to a desired position in the list.