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
+25-6Lines changed: 25 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,11 @@ Wherever you look, artificial intelligence becomes more and more important by en
12
12
AI Actions is an extensible solution for integrating features provided by AI services into your workflows, all managed through a user-friendly interface.
13
13
14
14
Out-of-the-box, AI Actions solution includes two essential components: a framework package and an OpenAI connector package.
15
-
It comes pre-configured with the following action types:
15
+
16
+
As of version v4.6.19, AI Actions can integrate with [[[= product_name_connect =]]](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_connect/), to give you an opportunity to build complex data transformation workflows without having to rely on custom code.
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.
18
+
19
+
AI Actions solution comes pre-configured with the following action types:
16
20
17
21
-[Refine text](#refining-text): Rewrite existing text according to instructions set in a prompt
18
22
-[Generate alternative text](#generating-alternative-text): Generate alt text for images for accessibility purposes
@@ -26,20 +30,28 @@ The possibilities are endless and you're not limited to a specific AI service, a
26
30
## Availability
27
31
28
32
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.
33
+
[[= product_name_connect =]] integration is available starting with v4.6.19.
29
34
To begin using AI Actions, you must first [install the required packages and perform initial configuration](install_ai_actions.md).
30
35
31
-
!!! note "API Key"
36
+
### Prerequisites
37
+
38
+
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).
39
+
40
+
Integration with [[= product_name_connect =]] requires that you first [get the credentials](https://doc.ibexa.co/projects/connect/en/latest/general/ibexa_connect/#access-ibexa-connect) to your account, and the [API token](install_ai_actions.md#token).
32
41
33
-
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).
[[= product_name_connect =]] comes with all contracts signed from 2023.
45
+
If you signed your contract earlier, contact your customer success manager to use [[= product_name_connect =]].
34
46
35
47
## How it works
36
48
37
49
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.
38
50
This data can then be combined with user input.
39
-
It's then passed to a service connector, such as the default OpenAI connector, for final processing on [[= product_name =]] side.
40
-
The service connector wraps all data into a prompt or another suitable format and sends it to an external AI service.
51
+
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.
52
+
The service connector wraps all data into a prompt or another suitable format and sends it to an external service.
41
53
42
-
When the AI Service returns a response, the response goes back through the service connector and passes to the framework.
54
+
When the external service returns a response, the response goes back through the service connector and passes to the framework.
43
55
It can then be presented to the user in any way necessary.
44
56
45
57
### Core concepts
@@ -147,3 +159,10 @@ Once the feature is configured, editors can generate alt text for images they up
147
159

148
160
149
161
With some customization, administrators could use the API to run a batch process against a larger collection of illustrations.
162
+
163
+
### Performing advanced image to text analysis
164
+
165
+
With some additional customization, store managers could benefit from automating part of product management by integrating their [[= product_name =]] with Google Cloud Vision and [PIM](pim_guide.md) by using [[= product_name_connect =]].
166
+
Instead of manually selecting and linking images stored in a [DAM](add_image_asset_from_dam.md) solution to their products, they could use of a no-code workflow where an AI service, for example, Google Cloud Vision, extracts text and attributes from product images, which are then matched with existing items in a product catalog.
167
+
168
+
This would enable automatic product identification, tagging, and catalog updates, resulting in less manual work and more efficient product management.
### Configure access to [[= product_name_connect =]]
40
+
41
+
First, get the credentials by contacting [Ibexa Support](https://support.ibexa.co).
42
+
43
+
In [[= product_name_connect =]], set up the account, and [create a team](https://doc.ibexa.co/projects/connect/en/latest/access_management/teams/#creating-teams).
44
+
Navigate to the team details page and note down the numerical value of the **Team id** variable.
45
+
46
+
Creating a team matters, because [scenarios](https://doc.ibexa.co/projects/connect/en/latest/scenarios/creating_a_scenario/) that process data coming from your AI action are associated with a team.
47
+
This way, if your organization has more than one application, each application can be linked to a different team and so can be scenarios coming from those applications.
48
+
49
+
#### Create token
50
+
51
+
Navigate to your [[= product_name_connect =]] user's profile, and on the **API ACCESS** tab, create a new token.
52
+
Copy the token code that appears next to the label.
53
+
54
+

55
+
56
+
#### Set up credentials
57
+
58
+
In the root folder of your project, modify the `.env` file.
59
+
Replace a placeholder value of the `IBEXA_CONNECT_TOKEN` variable with the token that you got from [[= product_name_connect =]] and provide a value of the `IBEXA_CONNECT_TEAM_ID` variable.
60
+
61
+
```bash
62
+
###> ibexa/connect ###
63
+
IBEXA_CONNECT_HOST=https://connect.ibexa.co
64
+
IBEXA_CONNECT_API_PATH=/api/v2/
65
+
# Token can be created in the user's profile in Ibexa Connect, under the 'API ACCESS' section.
Initiate each of the models provided by the handler by issuing the `php bin/console ibexa:connect:init-connect-ai <team_id> <language> <model>` command.
76
+
77
+
For example:
78
+
79
+
`php bin/console ibexa:connect:init-connect-ai 2 en connect-image-to-text`
You repeat this step for each of the languages that you want to be supported.
88
+
89
+
#### Customize templates
90
+
91
+
Return to the [[= product_name_connect =]] dashboard and modify the **Template for connect...handler**[templates](https://doc.ibexa.co/projects/connect/en/latest/scenarios/scenario_templates/) by defining the logic needed to process the data.
92
+
93
+
Once the templates are ready, you can build scenarios from them, either directly in [[= product_name_connect =]] or in [[[= product_name =]]'s user interface]([[= user_doc =]]/ai_actions/work_with_ai_actions/#create-new-ai-actions).
94
+
39
95
### Modify the database schema
40
96
41
97
Create the `add_ai_actions.sql` file that contains the following code.
0 commit comments