Skip to content

Commit 0c1876d

Browse files
committed
IBX-9621: Document AI / Connect integration
1 parent 34462b7 commit 0c1876d

File tree

4 files changed

+82
-7
lines changed

4 files changed

+82
-7
lines changed

docs/ai_actions/ai_actions_guide.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ Wherever you look, artificial intelligence becomes more and more important by en
1212
AI Actions is an extensible solution for integrating features provided by AI services into your workflows, all managed through a user-friendly interface.
1313

1414
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:
1620

1721
- [Refine text](#refining-text): Rewrite existing text according to instructions set in a prompt
1822
- [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
2630
## Availability
2731

2832
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.
2934
To begin using AI Actions, you must first [install the required packages and perform initial configuration](install_ai_actions.md).
3035

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).
3241

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).
42+
!!! note "[[= product_name_connect =]] Availability"
43+
44+
[[= 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 =]].
3446

3547
## How it works
3648

3749
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.
3850
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.
4153

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.
4355
It can then be presented to the user in any way necessary.
4456

4557
### Core concepts
@@ -147,3 +159,10 @@ Once the feature is configured, editors can generate alt text for images they up
147159
![Alt text generation](img/alt_text_use_ai.png)
148160

149161
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.
129 KB
Loading

docs/ai_actions/install_ai_actions.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,62 @@ OPENAI_API_KEY=sk-svcacct-AFCrCt1h2s3i4s5i6s7t8h9e0a1p2i3c4o5d6e
3636
###< ibexa/connector-openai ###
3737
```
3838

39+
### 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+
![Creating an API token](img/connect_api_token.png)
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.
66+
IBEXA_CONNECT_TOKEN=0eeecdef-4499-4ce5-bac2-a0p8i5k7e8y3
67+
# Use the URL below to read more on Ibexa Connect teams.
68+
# https://doc.ibexa.co/projects/connect/en/latest/access_management/teams/
69+
IBEXA_CONNECT_TEAM_ID=2
70+
###< ibexa/connect ###
71+
```
72+
73+
#### Initiate integration
74+
75+
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`
80+
81+
or
82+
83+
`php bin/console ibexa:connect:init-connect-ai 2 fr connect-text-to-text`
84+
85+
!!! note "Support for multiple languages"
86+
87+
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+
3995
### Modify the database schema
4096

4197
Create the `add_ai_actions.sql` file that contains the following code.

docs/content_management/images/add_image_asset_from_dam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The configuration for each connector depends on the requirements of the specific
2222
2323
You can create your own connectors, or use the provided example DAM connector for [Unsplash](https://unsplash.com/).
2424
25-
To add the Unsplash connector to your system add the `ibexa/connector-unsplash` bundle to your installation.
25+
To add the Unsplash connector to your system, add the `ibexa/connector-unsplash` bundle to your installation.
2626

2727
## Add Image Asset in Page Builder [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
2828

0 commit comments

Comments
 (0)