Skip to content

Commit a38a3b4

Browse files
authored
IBX-8963: AI Actions (#315)
* IBX-8689: AI Actions * Add ct article to navigation, fix small issues * Update AI doc following changes in the UI
1 parent 596f03f commit a38a3b4

File tree

15 files changed

+272
-46
lines changed

15 files changed

+272
-46
lines changed

docs/ai_actions/ai_actions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
description: Learn about generative AI and its capabilities.
3+
---
4+
5+
# AI Actions
6+
7+
AI Actions is a set of capabilities that enhance the efficiency and creativity of content editors.
8+
The feature is not included in [[= product_name =]] by default.
9+
It's an [LTS Update]([[= developer_doc =]]/release_notes/ibexa_dxp_v4.6/#lts-updates) that requires separate [installation and system configuration]([[= developer_doc =]]/ai_actions/install_ai_actions/).
10+
11+
Once AI Actions are installed and configured, content editors with `Action configuration/View` and `Action configuration/Execute` permissions have access to AI-driven tools.
12+
For example, they can [enhance or improve the text](create_edit_content_items.md#ai-assistant) that they have written, or [generate alternative text](upload_images.md#ai) for images.
13+
14+
If you have the right permissions, you can decide what capabilities are available to the editors by enabling AI actions.
15+
You can also modify the parameters of individual AI actions, to control the creativity of the AI or the cost involved with using it.
16+
17+
For more information, see [Work with AI actions](work_with_ai_actions.md#edit-existing-ai-actions).
68.4 KB
Loading
26.4 KB
Loading
161 KB
Loading
59.2 KB
Loading
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
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+
![AI actions in Admin Panel](img/ai_actions_list.png)
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+
![AI action details](img/ai_action_details.png)
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+
![AI action options](img/ai_action_options.png)
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+

docs/content_management/block_reference.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,13 @@ On the **Properties** tab, set values in the following fields:
345345
- **Content** — Enter a content, for example, text, images, or videos, with the online editor.
346346
For details, see [Editing Rich Text Fields](create_edit_content_items.md#edit-rich-text-fields).
347347

348+
!!! note "Use AI to improve text"
349+
350+
If the [AI Actions](ai_actions.md) LTS update has been installed and configured in your application, the **Improve text** button is visible.
351+
If you have necessary permissions, you can click it to request that the AI Assistant performs specific tasks with your text.
352+
353+
For more information, see [AI Assistant](create_edit_content_items.md#ai-assistant).
354+
348355
## Video block
349356

350357
Integrates a video into the page with standard playback controls.

docs/content_management/create_edit_content_items.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ To do it, choose one of the available elements:
118118
Each of these elements can have its own settings, such as text formatting.
119119
The option bar also lets you reorder or remove any elements in the Rich Text field.
120120

121+
122+
121123
#### Edit embedded content items
122124

123125
You can edit embedded content items without leaving current window.
@@ -191,6 +193,32 @@ In table options you can define the first row and/or column as headers, add or d
191193
Your installation can also have custom elements available in the Rich Text field.
192194
Contact your website administrator about the details of using them.
193195

196+
### AI Assistant
197+
198+
If the [AI Actions](ai_actions.md) LTS update has been installed and configured in your application, when writing content, the **Improve text** button is visible in the toolbox.
199+
If you have the required [permissions]([[= developer_doc =]]/permissions/policies/#ai-actions), you can request that the AI Assistant refines your text by using one of the defined actions.
200+
For example, you can highlight a passage and instruct the AI Assistant to extend the passage or adjust its tone to suit your needs.
201+
202+
The **Go to AI actions** button can also visible to users with access to the **Admin UI**.
203+
By clicking it, you can quickly navigate to [AI actions configuration](work_with_ai_actions.md).
204+
205+
![Improve text button and AI actions](ai_assistant.png)
206+
207+
After you select an action, the AI Assistant modal appears, where you can observe the results of AI service's work.
208+
When response is displayed on the screen, depending on whether you are satisfied with the result, you can select one of the options:
209+
210+
- **Replace** - replaces the source text with the output
211+
- **Insert below** - inserts the output text directly after the source passage
212+
- **Try again** - makes another attempt at generating the output
213+
214+
![AI Assistant](ai_assistant_options.png)
215+
216+
!!! note "Lengthy processing of complex requests"
217+
218+
Depending on the length of the source text and the complexity of request, processing may take a while.
219+
You may cancel the processing if it takes too long by clicking **Stop**.
220+
221+
194222
### SeenThis! streaming
195223

196224
!!! note
59.5 KB
Loading
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
description: Learn about the content tree.
3+
---
4+
5+
# Content tree
6+
7+
Content tree is the place where you can navigate through all the content items in your application.
8+
If you want to browse your application's content items, in the main menu, go to the **Content** -> **Content structure**.
9+
The **Content tree** area is an expandable content menu of your website.
10+
11+
![Content tree in the menu](../img/left_menu_tree.png "Content tree in the menu")
12+
13+
The same tree structure is used in other areas of the Content menu, such as **Media** or **Forms**.
14+
15+
Unique icons for each content type instantly show you what type of content you are selecting. To add custom icons to your content tree, follow the [configuration tutorial in developer documentation]([[= developer_doc =]]/administration/back_office/back_office_elements/custom_icons/#customize-content-type-icons).
16+
17+
For more information about custom configuration, go to [Content tree]([[= developer_doc =]]/administration/back_office/content_tree/) in developer documentation.
18+
19+
Within the content tree, hidden content is greyed out in the tree view.
20+
21+
To simplify the content tree, big lists are collapsed and include a **Show more** icon.
22+
Click it to expand the branches of the tree.
23+
**Collapse all** option, which is available in the context menu, closes all expanded sections.
24+
25+
### Add folders
26+
27+
You can organize the tree by creating additional folders and subfolders of the **Content structure**.
28+
A similar procedure applies to other areas of the system where the tree hierarchy is used.
29+
30+
1\. Go to **Content** -> **Content structure**.
31+
32+
2\. In the upper-right corner click **Create content**.
33+
34+
3\. From the available content types, select **Folder**, and click **Create**.
35+
36+
4\. Enter name for the new folder.
37+
38+
5\. (Optional) Add folder description.
39+
40+
6\. Click **Publish**.
41+
42+
The newly created folder is now visible in the content tree.

0 commit comments

Comments
 (0)