Work with AI actions¶
AI actions define what results are available to editors in AI-enabled areas, such as, for example, the AI Assistant.
If the AI Actions LTS update has been installed and configured in your application, and you have the required permissions, including Action configuration/Edit
and Action configuration/Create
, you can reconfigure the existing AI actions, and create new ones.
View AI actions¶
With the right permissions, you can view all AI actions configured in the application by navigating to the Admin Panel and selecting AI actions.
You can narrow down the list of AI actions by filtering it by the status, either Enabled or Disabled, or by the type. Out of the box, there are two categories of AI Actions present in the system:
- Text to text - used by default in online editor for refining text, for example: "Rewrite text in formal tone"
- Image to text - used by default in the image asset editing screen to generate alternative text, for example: "Generate short alternative description of an image"
It may happen that a set of sample AI actions has been installed with the AI Actions package, and there is a number of existing AI actions that you can modify and clone.
Custom action types
In your specific case, the types available can be different, and your organization's development team can create custom AI action types. For more information, see developer documentation.
View AI action details¶
Navigate to the Admin Panel and select AI actions. In the AI actions list, click the name of an AI action to review its details. For example, in the Properties tab, you can see specific settings that modify the prompt that is sent to an AI service.
Edit existing AI actions¶
You can modify the existing AI actions.
1. Navigate to the Admin Panel and select AI actions.
2. In the AI actions list, click the Edit icon next to a name of the AI action that you want to modify.
3. In the Global properties section, you can change the name and description of the AI action. You can also toggle the availability of the AI action between disabled and enabled.
4. In the Settings area, change the settings that modify the behavior of an AI service that executes an AI action, for example:
- Prompt - modifies the default request by passing a verbal command, for example, "Make it short and formal."
Default request
The default request can be seen at the top of the settings area, on a light blue background.
-
Max tokens - sets a maximum number of "words" or tokens that can be used in a single request by both the request and the response
-
Length of prompt output - sets a maximum number of words of the generated result
-
Temperature - controls the randomness of the response. Takes a value between 0 and 1. The higher the temperature, the more creative is the output
Action settings availability
Action settings differ depending on the AI service used, model implementation and actual action type. Therefore the settings visible in your installation may vary from the ones presented above.
5. Click Save and close to apply the changes or Discard to discard them and close the window.
Create new AI actions¶
You can create AI actions that perform actions of different types, using different models, or action handlers.
AI action models
Before you can work with AI actions, models must be configured and enabled by your organization's development team. If there are more AI service connectors available, you might be able to create AI actions that perform the same type of actions but use different models. For more information, see developer documentation.
-
Navigate to the Admin Panel and select AI actions.
-
In the AI actions list, click Create.
-
In the slide-out pane, make initial choices in the following fields, and click Create:
- Language - sets the base language for the AI action
- Action type - sets an action type to serve as a template for the AI action, for example, Refine action
- Model - sets the AI model used to process the requests resulting from this AI action
-
In the Global properties section, set the name and identifier of the AI action.
-
Optionally, provide a description of the AI action.
-
When ready, toggle the status of the AI action to enabled.
-
In the Settings area. For a list of available settings, see Edit existing AI actions.
-
Click Save and close to apply the changes or Discard to discard them and close the window.