|
| 1 | +--- |
| 2 | +description: Create new AI actions or modify existing ones to work faster and increase creativity. |
| 3 | +--- |
| 4 | + |
| 5 | +# Work with AI actions |
| 6 | + |
| 7 | +AI actions define what results are available to editors in AI-enabled areas, such as, for example, the AI Assistant. |
| 8 | +If the AI Actions LTS update has been installed and configured in your application, and you have the required [permissions]([[= developer_doc =]]/permissions/policies/#ai-actions), including `Action configuration/Edit` and `Action configuration/Create`, you can reconfigure the existing AI actions, and create new ones. |
| 9 | + |
| 10 | +## View AI actions |
| 11 | + |
| 12 | +With the right permissions, you can view all AI actions configured in the application by navigating to the Admin Panel and selecting **AI actions**. |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +You can narrow down the list of AI actions by filtering it by the status, either Enabled or Disabled, or by the type. |
| 17 | +Out of the box, there are two categories of AI Actions present in the system: |
| 18 | + |
| 19 | +- **Text to text** - used by default in [online editor](create_edit_content_items.md#ai-assistant) for refining text, for example: "Rewrite text in formal tone" |
| 20 | +- **Image to text** - used by default in the [image asset editing screen](upload_images.md#ai) to generate alternative text, for example: "Generate short alternative description of an image" |
| 21 | + |
| 22 | +It may happen that a set of sample AI actions has been [installed with the AI Actions package]([[= developer_doc =]]/ai_actions/install_ai_actions/#install-sample-ai-action-configurations-optional), and there is a number of existing AI actions that you can modify and clone. |
| 23 | + |
| 24 | +!!! note "Custom action types" |
| 25 | + |
| 26 | + In your specific case, the types available can be different, and your organization's development team can create custom AI action types. |
| 27 | + For more information, see [developer documentation]([[= developer_doc =]]/ai_actions/). |
| 28 | + |
| 29 | +### View AI action details |
| 30 | + |
| 31 | +Navigate to the Admin Panel and select **AI actions**. |
| 32 | +In the **AI actions** list, click the name of an AI action to review its details. |
| 33 | +For example, in the **Properties** tab, you can see specific settings that modify the prompt that is sent to an AI service. |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +## Edit existing AI actions |
| 38 | + |
| 39 | +You can modify the existing AI actions. |
| 40 | + |
| 41 | +1\. Navigate to the Admin Panel and select **AI actions**. |
| 42 | + |
| 43 | +2\. In the **AI actions** list, click the **Edit** icon next to a name of the AI action that you want to modify. |
| 44 | + |
| 45 | +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. |
| 46 | + |
| 47 | +4\. In the **Settings** area, change the settings that modify the behavior of an AI service that executes an AI action, for example: |
| 48 | + |
| 49 | +- **Prompt** - modifies the default request by passing a verbal command, for example, "Make it short and formal." |
| 50 | + |
| 51 | +!!! note "Default request" |
| 52 | + |
| 53 | + The default request can be seen at the top of the settings area, on a light blue background. |
| 54 | + |
| 55 | +- **Max tokens** - sets a maximum number of "[words](https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them)" or tokens that can be used in a single request by both the request and the response |
| 56 | + |
| 57 | +- **Length of prompt output** - sets a maximum number of words of the generated result |
| 58 | + |
| 59 | +- **Temperature** - controls the randomness of the response. |
| 60 | +Takes a value between 0 and 1. |
| 61 | +The higher the temperature, the more creative is the output |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | +!!! note "Action settings availability" |
| 66 | + |
| 67 | + Action settings differ depending on the AI service used, model implementation and actual action type. |
| 68 | + Therefore the settings visible in your installation may vary from the ones presented above. |
| 69 | + |
| 70 | +5\. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. |
| 71 | + |
| 72 | +## Create new AI actions |
| 73 | + |
| 74 | +You can create AI actions that perform actions of different types, using different models, or action handlers. |
| 75 | + |
| 76 | +!!! note "AI action models" |
| 77 | + |
| 78 | + Before you can work with AI actions, models must be configured and enabled by your organization's development team. |
| 79 | + 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. |
| 80 | + For more information, see [developer documentation]([[= developer_doc =]]/ai_actions/ai_actions_guide/#model). |
| 81 | + |
| 82 | +1. Navigate to the Admin Panel and select **AI actions**. |
| 83 | + |
| 84 | +1. In the **AI actions** list, click **Create**. |
| 85 | + |
| 86 | +1. In the slide-out pane, make initial choices in the following fields, and click **Create**: |
| 87 | + |
| 88 | + - **Language** - sets the base language for the AI action |
| 89 | + - **Action type** - sets an action type to serve as a template for the AI action, for example, **Refine action** |
| 90 | + - **Model** - sets the AI model used to process the requests resulting from this AI action |
| 91 | + |
| 92 | +1. In the **Global properties** section, set the name and identifier of the AI action. |
| 93 | + |
| 94 | +1. Optionally, provide a description of the AI action. |
| 95 | + |
| 96 | +1. When ready, toggle the status of the AI action to enabled. |
| 97 | + |
| 98 | +1. In the **Settings** area. |
| 99 | +For a list of available settings, see [Edit existing AI actions](#edit-existing-ai-actions). |
| 100 | + |
| 101 | +1. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. |
| 102 | + |
0 commit comments