-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
Check warning on line 1 in docs/ai/ai_actions.md GitHub Actions / vale[vale] docs/ai/ai_actions.md#L1
Raw output
|
||
description: Learn about generative AI and its capabilities. | ||
--- | ||
|
||
# AI Actions | ||
|
||
AI Actions is a powerful set of capabilities designed to enhance the efficiency and creativity of content editors. | ||
With AI Actions, editors can streamline their workflow, making content creation faster while enabling new levels of creativity. | ||
Check warning on line 8 in docs/ai/ai_actions.md GitHub Actions / vale[vale] docs/ai/ai_actions.md#L8
Raw output
|
||
AI Actions are not included by default in [[= product_name =]]. | ||
It's an add-on to the product and requires separate installation and configuration by the system administrator. | ||
For more information about installing and configuring AI Actions, see [developer documentation]([[= developer_doc =]]/generative_ai/ai_actions/). | ||
|
||
Once AI Actions are installed and configured, content editors gain access to a variety of AI-driven tools. | ||
Depending on the options selected during configuration, the AI Assistant can assist editors in multiple ways. | ||
For example, editors can use the AI to [enhance or improve the text](create_edit_content_items.md#ai-assistant) that they have written. | ||
AI can also [generate alternative text](upload_images.md#ai) for images. | ||
This alternative text is later used by screen readers and other assistive technologies to provide descriptions of images to users who cannot see. | ||
|
||
![AI Assistant](ai_assistant.png) | ||
|
||
If you have sufficient permissions, you can control which specific AI Actions capabilities are made available to content editors. | ||
If you have sufficient permissions, you can decide what capabilities are available to the editors by [configuring AI actions](work_with_ai_actions.md). | ||
You do it by configuring the settings of individual AI actions, where you can enable or disable certain features based on the needs of your editorial team. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
--- | ||
Check warning on line 1 in docs/ai/work_with_ai_actions.md GitHub Actions / vale[vale] docs/ai/work_with_ai_actions.md#L1
Raw output
|
||
description: Create new AI actions of modify existing ones to work faster and increase creativity. | ||
--- | ||
|
||
# Work with AI actions | ||
|
||
AI actions define what actions are available in AI-enabled areas, such as, for example, the AI Assistant. | ||
If the AI Actions add-on has been installed and configured in your application, and you have sufficient permissions, you can reconfigure the existing AI actions, and create new ones. | ||
|
||
For more information about the AI-related capabilities, see [AI Actions](ai_actions.md). | ||
|
||
## View AI actions | ||
|
||
If you have Administrator permissions, you can view all AI actions configured in the application by navigating to the Admin Panel and selecting **AI actions**. | ||
List entries are ordered by creation date. | ||
|
||
![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 Available or Unavailable, or by the type. | ||
Out of the box, there are two types of AI Actions present in the system: | ||
|
||
- **Refine text** - used primarily in [online editor](create_edit_content_items.md#ai-assistant) for performing text-to-text actions, for example: "Rewrite text in formal tone" | ||
- **Generate alternative text** - used in the [image asset editing screen](upload_images.md#ai) to perform image-to-text actions, for example: "Generate short alternative description of an image" | ||
|
||
!!! 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 **Action type options** tab, you can see specific parameters that modify the prompt that is sent to an AI service. | ||
|
||
![AI action details](img/ai_action_details.png) | ||
|
||
## Edit existing AI action | ||
|
||
To suit your specific needs, you can modify the default 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 **Action options** area, change the settings that modify the behavior of an AI service that responds to an AI action, for example: | ||
|
||
- **Prompt** - modifies the default request by passing a verbal command, for example, "Make it short and formal." | ||
- **Max tokens** - sets a maximum number of "[words](https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them)" that can be processed in a single request | ||
- **Temperature** - controls the randomness of the response. The higher the temperature, the more creative is the output | ||
|
||
![AI action options](img/ai_action_options.png) | ||
|
||
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. | ||
You can also create AI actions that perform the same type of actions but use different models. | ||
|
||
!!! note "AI action models" | ||
|
||
Before you can work with AI actions, models must be configured and enabled by your organization's development team. | ||
For more information, see [developer documentation]([[= developer_doc =]]/ai_actions/). | ||
|
||
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, you set the name and identifier of the AI action. | ||
|
||
1. Optionally, provide a description of the AI action. | ||
|
||
1. When ready, set the status of the AI action to enabled. | ||
|
||
1. In the **Action options** area, change the settings that control the behavior of an AI service that responds to an AI action, for example: | ||
|
||
- **Length** - in AI actions of text-to-text type, it can sets a maximum length of the output | ||
Check warning on line 86 in docs/ai/work_with_ai_actions.md GitHub Actions / vale[vale] docs/ai/work_with_ai_actions.md#L86
Raw output
|
||
- **Prompt** - modifies the default request by passing a verbal command, for example, "Make it sound funny." | ||
- **Max tokens** - sets a maximum number of "[words](https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them)" that can be processed in a single request | ||
- **Temperature** - controls the randomness of the response. The lower the temperature, the less creative is the output | ||
|
||
1. Click **Save and close** to apply the changes or **Discard** to discard them and close the window. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
Check warning on line 1 in docs/getting_started/content_tree/content_tree.md GitHub Actions / vale[vale] docs/getting_started/content_tree/content_tree.md#L1
Raw output
|
||
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. | ||
Check warning on line 7 in docs/getting_started/content_tree/content_tree.md GitHub Actions / vale[vale] docs/getting_started/content_tree/content_tree.md#L7
Raw output
|
||
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") | ||
|
||
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 [configuration tutorial in developer documentation]([[= developer_doc =]]/administration/back_office/back_office_elements/custom_icons/#customize-content-type-icons). | ||
Check warning on line 13 in docs/getting_started/content_tree/content_tree.md GitHub Actions / vale[vale] docs/getting_started/content_tree/content_tree.md#L13
Raw output
|
||
|
||
For more information about custom configuration, go to [Content Tree]([[= developer_doc =]]/administration/back_office/content_tree/) in developer documentation. | ||
|
||
Win the Content Tree, hidden content is greyed out in the tree view. | ||
Check warning on line 17 in docs/getting_started/content_tree/content_tree.md GitHub Actions / vale[vale] docs/getting_started/content_tree/content_tree.md#L17
Raw output
|
||
|
||
To simplify the Content Tree, big lists are collapsed and include a **Show more** icon. | ||
Check warning on line 19 in docs/getting_started/content_tree/content_tree.md GitHub Actions / vale[vale] docs/getting_started/content_tree/content_tree.md#L19
Raw output
Check warning on line 19 in docs/getting_started/content_tree/content_tree.md GitHub Actions / vale[vale] docs/getting_started/content_tree/content_tree.md#L19
Raw output
|
||
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**. | ||
The same procedure applies to other areas of the Content menu, such as **Media** or **Forms**. | ||
|
||
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. | ||
Check warning on line 40 in docs/getting_started/content_tree/content_tree.md GitHub Actions / vale[vale] docs/getting_started/content_tree/content_tree.md#L40
Raw output
|