-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* IBX-8689: AI Actions * Add ct article to navigation, fix small issues * Update AI doc following changes in the UI
- Loading branch information
Showing
15 changed files
with
272 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
description: Learn about generative AI and its capabilities. | ||
--- | ||
|
||
# AI Actions | ||
|
||
AI Actions is a set of capabilities that enhance the efficiency and creativity of content editors. | ||
The feature is not included in [[= product_name =]] by default. | ||
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/). | ||
|
||
Once AI Actions are installed and configured, content editors with `Action configuration/View` and `Action configuration/Execute` permissions have access to AI-driven tools. | ||
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. | ||
|
||
If you have the right permissions, you can decide what capabilities are available to the editors by enabling AI actions. | ||
You can also modify the parameters of individual AI actions, to control the creativity of the AI or the cost involved with using it. | ||
|
||
For more information, see [Work with AI actions](work_with_ai_actions.md#edit-existing-ai-actions). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
--- | ||
description: Create new AI actions or modify existing ones to work faster and increase creativity. | ||
--- | ||
|
||
# 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]([[= 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. | ||
|
||
## 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**. | ||
|
||
![AI actions in Admin Panel](img/ai_actions_list.png) | ||
|
||
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](create_edit_content_items.md#ai-assistant) for refining text, for example: "Rewrite text in formal tone" | ||
- **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" | ||
|
||
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. | ||
|
||
!!! note "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]([[= developer_doc =]]/ai_actions/). | ||
|
||
### 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. | ||
|
||
![AI action details](img/ai_action_details.png) | ||
|
||
## 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." | ||
|
||
!!! note "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](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 | ||
|
||
- **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 | ||
|
||
![AI action options](img/ai_action_options.png) | ||
|
||
!!! note "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. | ||
|
||
!!! note "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]([[= developer_doc =]]/ai_actions/ai_actions_guide/#model). | ||
|
||
1. Navigate to the Admin Panel and select **AI actions**. | ||
|
||
1. In the **AI actions** list, click **Create**. | ||
|
||
1. 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 | ||
|
||
1. In the **Global properties** section, set the name and identifier of the AI action. | ||
|
||
1. Optionally, provide a description of the AI action. | ||
|
||
1. When ready, toggle the status of the AI action to enabled. | ||
|
||
1. In the **Settings** area. | ||
For a list of available settings, see [Edit existing AI actions](#edit-existing-ai-actions). | ||
|
||
1. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
description: Learn about the content tree. | ||
--- | ||
|
||
# Content tree | ||
|
||
Content tree is the place where you can navigate through all the content items in your application. | ||
If you want to browse your application's content items, in the main menu, go to the **Content** -> **Content structure**. | ||
The **Content tree** area is an expandable content menu of your website. | ||
|
||
![Content tree in the menu](../img/left_menu_tree.png "Content tree in the menu") | ||
|
||
The same tree structure is used in other areas of the Content menu, such as **Media** or **Forms**. | ||
|
||
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). | ||
|
||
For more information about custom configuration, go to [Content tree]([[= developer_doc =]]/administration/back_office/content_tree/) in developer documentation. | ||
|
||
Within the content tree, hidden content is greyed out in the tree view. | ||
|
||
To simplify the content tree, big lists are collapsed and include a **Show more** icon. | ||
Click it to expand the branches of the tree. | ||
**Collapse all** option, which is available in the context menu, closes all expanded sections. | ||
|
||
### Add folders | ||
|
||
You can organize the tree by creating additional folders and subfolders of the **Content structure**. | ||
A similar procedure applies to other areas of the system where the tree hierarchy is used. | ||
|
||
1\. Go to **Content** -> **Content structure**. | ||
|
||
2\. In the upper-right corner click **Create content**. | ||
|
||
3\. From the available content types, select **Folder**, and click **Create**. | ||
|
||
4\. Enter name for the new folder. | ||
|
||
5\. (Optional) Add folder description. | ||
|
||
6\. Click **Publish**. | ||
|
||
The newly created folder is now visible in the content tree. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.