You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ai_actions/ai_actions_guide.md
+11-13Lines changed: 11 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
---
2
-
description: AI Actions LTS update helps editors by automating repetitive tasks.
3
-
edition: lts-update
2
+
description: AI Actions help editors by automating repetitive tasks.
4
3
month_change: true
5
4
---
6
5
@@ -9,12 +8,12 @@ month_change: true
9
8
## What are AI Actions
10
9
11
10
Wherever you look, artificial intelligence becomes more and more important by enhancing user interaction and automating complex processes.
12
-
[[= product_name =]]can be equipped with the AI Actions [LTS update](editions.md#lts-updates), which harnesses AI's potential to automate time-consuming editorial tasks.
11
+
[[= product_name =]]is equipped with the AI Actions feature, which harnesses AI's potential to automate time-consuming editorial tasks.
13
12
AI Actions is an extensible solution for integrating features provided by AI services into your workflows, all managed through a user-friendly interface.
14
13
15
14
Out-of-the-box, AI Actions solution includes two essential components: a framework package and an OpenAI connector package.
16
15
17
-
As of version v4.6.19, AI Actions can integrate with [[[= product_name_connect =]]]([[= connect_doc =]]/general/ibexa_connect/), to give you an opportunity to build complex data transformation workflows without having to rely on custom code.
16
+
AI Actions can integrate with [[[= product_name_connect =]]]([[= connect_doc =]]/general/ibexa_connect/), to give you an opportunity to build complex data transformation workflows without having to rely on custom code.
18
17
From the developer's perspective, the integration removes the burden of maintaining third-party AI handlers, and accelerates the deployment of AI-based solutions.
19
18
20
19
AI Actions solution comes pre-configured with the following action types:
@@ -30,15 +29,14 @@ The possibilities are endless and you're not limited to a specific AI service, a
30
29
31
30
## Availability
32
31
33
-
AI Actions are an opt-in capability available as an [LTS update](editions.md#lts-updates) starting with the v4.6.12 version of [[= product_name =]], regardless of its edition.
34
-
[[= product_name_connect =]] integration is available starting with v4.6.19.
35
-
To begin using AI Actions, you must first [install the required packages and perform initial configuration](install_ai_actions.md).
32
+
[[= product_name_cloud =]] is available in all [[= product_name =]] editions.
33
+
To begin using AI Actions, you must first [perform the initial configuration](configure_ai_actions.md).
36
34
37
35
### Prerequisites
38
36
39
37
The OpenAI connector requires that you first [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key) and make sure that you [set up a billing method](https://help.openai.com/en/articles/9038407-how-can-i-set-up-billing-for-my-account).
40
38
41
-
Integration with [[= product_name_connect =]] requires that you first [get the credentials]([[= connect_doc =]]/general/ibexa_connect/#access-ibexa-connect) to your account, and the [API token](install_ai_actions.md#create-token).
39
+
Integration with [[= product_name_connect =]] requires that you first [get the credentials]([[= connect_doc =]]/general/ibexa_connect/#access-ibexa-connect) to your account, and the [API token](configure_ai_actions.md#create-token).
@@ -47,7 +45,7 @@ Integration with [[= product_name_connect =]] requires that you first [get the c
47
45
48
46
## How it works
49
47
50
-
AI Actions LTS update relies on an extensible AI framework, which is responsible for gathering information from various sources, such as AI action types, AI action configurations, and contextual details like SiteAccess, user details, locale settings, and more.
48
+
AI Actions rely on an extensible AI framework, which is responsible for gathering information from various sources, such as AI action types, AI action configurations, and contextual details like SiteAccess, user details, locale settings, and more.
51
49
This data can then be combined with user input.
52
50
It's then passed to a service connector, such as the default OpenAI connector or the [[= product_name_connect =]] connector, for final processing on [[= product_name =]] side.
53
51
The service connector wraps all data into a prompt or another suitable format and sends it to an external service.
@@ -101,7 +99,7 @@ Handlers take parameters defined in the AI action type and configuration, combin
101
99
102
100
### Triggering actions from the UI
103
101
104
-
Among other elements, AI Actions LTS update includes UI components that are used in:
102
+
Among other elements, AI Actions include UI components that are used in:
105
103
106
104
- AI action management in the **Admin** panel
107
105
- text modification in online editor
@@ -113,7 +111,7 @@ Procedures are straightforward and intuitive, ensuring that users can quickly ac
113
111
114
112
### Triggering actions programmatically
115
113
116
-
AI Actions LTS update exposes a REST API interface that allows for programmatic execution of AI actions.
114
+
AI Actions feature exposes a REST API interface that allows for programmatic execution of AI actions.
117
115
With the API, developers can automate tasks and execute actions on batches of content by integrating them into workflows.
118
116
For more information, see the [AI actions section in the REST API Reference](../api/rest_api/rest_api_reference/rest_api_reference.html#ai-actions-execute-ai-action).
119
117
@@ -132,15 +130,15 @@ By accessing the detailed view of individual AI actions, you can quickly review
132
130
133
131
### Extensibility
134
132
135
-
Built-in AI action types offer a good starting point, but the real power of the AI Actions LTS update lies in extensibility.
133
+
Built-in AI action types offer a good starting point, but the real power of AI Actions lies in extensibility.
136
134
Extending AI Actions opens up new possibilities for content management and editing.
137
135
Developers can define new models and AI action types that use the existing AI service or even integrate additional services.
138
136
The latter involves developing a new service connector, writing a handler that communicates with the new service, defining a new AI action type, and creating a form for configuring options, which extends the default action configuration form shown in the **Admin** panel.
139
137
For example, if this is your organization's requirement, a developer could write a handler that uses an AI service available internally, without exposing your data to a third-party service.
140
138
141
139
## Use cases
142
140
143
-
Out of the box, after you configure access to the OpenAI service, the [[= product_name_base =]] AI Actions LTS update comes with two action types that can help your organization with the following tasks.
141
+
Out of the box, after you configure access to the OpenAI service, the [[= product_name_base =]] AI Actions come with two action types that can help your organization with the following tasks.
Run the following command, where `<database_name>` is the same name that you defined when you [installed [[= product_name =]]](../getting_started/install_ibexa_dxp.md#change-installation-parameters).
41
-
42
-
=== "MySQL"
43
-
44
-
```bash
45
-
mysql -u <username> -p <password> <database_name> < add_ai_actions.sql
46
-
```
47
-
48
-
=== "PostgreSQL"
49
-
50
-
```bash
51
-
psql <database_name> < add_ai_actions.sql
52
-
```
53
-
54
-
This command modifies the existing database schema by adding database configuration required for using AI Actions.
8
+
AI Actions are available in [[= product_name =]] regardless of its edition.
9
+
To use this feature you must first configure the built-in service connectors or build your own ones.
55
10
56
11
!!! note "Next steps"
57
12
58
-
Once the framework is installed and configured, before you can start using AI Actions, you can configure access to [[= product_name_base =]]-made service connectors by following the instructions below, or [create your own](extend_ai_actions.md#create-custom-action-handler).
13
+
Once the framework is configured, before you can start using AI Actions, you can configure access to [[= product_name_base =]]-made service connectors by following the instructions below, or [create your own](extend_ai_actions.md#create-custom-action-handler).
59
14
60
15
Only then you can restart you application and start [working with the AI Actions feature]([[= user_doc =]]/ai_actions/work_with_ai_actions/).
61
16
62
-
## Configure access to OpenAI
17
+
## Configure access to OpenAI (optional)
63
18
64
-
Run the following command to install the service connector with the OpenAI service:
65
-
66
-
```bash
67
-
composer require ibexa/connector-openai
68
-
```
69
-
70
-
Create an OpenAI account, [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key), and make sure that you [set up a billing method](https://help.openai.com/en/articles/9038407-how-can-i-set-up-billing-for-my-account).
19
+
To use the built-in connector with the OpenAI service, you need to create an OpenAI account, [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key), and make sure that you [set up a billing method](https://help.openai.com/en/articles/9038407-how-can-i-set-up-billing-for-my-account).
71
20
72
21
Then, in the root folder of your project, modify the `.env` file: find the `OPENAI_API_KEY` variable and replace a placeholder value with the API key that you got from the AI service.
The [`language` attribute](https://developers.make.com/api-documentation/api-reference/templates#templates-1) determines the language in which template details such as module names will be displayed in [[= product_name_connect =]]'s UI.
163
106
164
-
### Customize templates
107
+
### Customize templates
165
108
166
109
Return to the [[= product_name_connect =]] dashboard and modify the **Template for connect...handler**[templates]([[= connect_doc =]]/scenarios/scenario_templates/) by defining the logic needed to process the data.
@@ -60,7 +62,12 @@ Compare all features available in [[= product_name_headless =]], [[= product_nam
60
62
LTS Updates are opt-in packages that bring additional features to the [LTS releases](release_process_and_roadmap.md#long-term-support-releases) that they enhance.
61
63
The features brought by LTS Updates become standard parts of the next LTS release.
0 commit comments