Skip to content

Commit e45c582

Browse files
committed
IBX-9621: Describe creating a Connect-based AI action configurations (#351)
* IBX-9621: Describe creating a Connect-based AI Action
1 parent 52e910c commit e45c582

File tree

3 files changed

+41
-3
lines changed

3 files changed

+41
-3
lines changed
24.6 KB
Loading
45.8 KB
Loading

docs/ai_actions/work_with_ai_actions.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ With the right permissions, you can view all AI actions configured in the applic
1414
![AI actions in Admin Panel](img/ai_actions_list.png)
1515

1616
You can narrow down the list of AI actions by filtering it by the status, either Enabled or Disabled, or by the type.
17-
Out of the box, there are two categories of AI Actions present in the system:
17+
Out of the box, there are two categories of AI actions present in the system:
1818

1919
- **Refine text** - used by default in [online editor](create_edit_content_items.md#ai-assistant) for refining text, for example: "Rewrite text in formal tone"
2020
- **Generate alternative 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"
2121

22-
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.
22+
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.
2323

2424
!!! note "Custom action types"
2525

@@ -88,7 +88,7 @@ You can create AI actions that perform actions of different types, using differe
8888

8989
- **Language** - sets the base language for the AI action
9090
- **Action type** - sets an action type to serve as a template for the AI action, for example, **Refine text**
91-
- **Model** - sets the AI model used to process the requests resulting from this AI action
91+
- **Action handler** - sets the AI model used to process the requests resulting from this AI action
9292

9393
1. In the **Global properties** section, set the name and identifier of the AI action.
9494

@@ -103,6 +103,44 @@ For a list of available settings, see [Edit existing AI actions](#edit-existing-
103103

104104
<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(51.27314814814815% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/4amA1EL6g3fFxSmQoFCp?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Work with AI actions" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" ></iframe></div><!--ARCADE EMBED END-->
105105

106+
## Create AI actions that use [[= product_name_connect =]]
107+
108+
If your organization uses [[= product_name_connect =]], you can build multi-step scenarios that define the logic needed to process your input data, for example, by merging the output of multiple AI services.
109+
One such example could be sending out a text for translation by one service, and then to another to make sure that the resulting translation is written in the right tone.
110+
111+
!!! note "[[= product_name_connect =]] configuration required"
112+
113+
To use AI actions that interface with [[= product_name_connect =]], you must first [configure and initiate the connection]([[= developer_doc =]]/ai_actions/install_ai_actions/#configure-access-to-ibexa-connect), and [define templates](https://doc.ibexa.co/projects/connect/en/latest/scenarios/scenario_templates/#creating-templates) and/or [scenarios](https://doc.ibexa.co/projects/connect/en/latest/scenarios/creating_a_scenario/) in [[= product_name_connect =]].
114+
115+
1\. Navigate to the Admin Panel and select **AI actions**.
116+
117+
2\. In the **AI actions** list, click **Create**.
118+
119+
3\. In the slide-out pane, make choices like in [Create new AI actions](#create-new-ai-actions) but in the **Action handler** field, select the model that uses an [[= product_name_connect =]] scenario to process the request, for example `connect-image-to-text`, and then click **Create**.
120+
121+
![[[= product_name_connect =]] handler](img/ai_action_connect_handler_selection.png)
122+
123+
4\. In the **Global properties** area, set the required properties.
124+
125+
5\. In the **Settings** area, select an existing scenario from a drop-down list.
126+
The list contains all scenarios that exist in [[= product_name_connect =]].
127+
They may be incompatible with the selected action type and require adjustments on the [[= product_name_connect =]] side.
128+
129+
6\. Optionally, if there are no scenarios for the selected action type, or you want to create a custom scenario, click **Create scenario based on template** and select a template from a drop-down list.
130+
131+
If you do so, when you save the new AI action, a new scenario is automatically created.
132+
You must then fine-tune its settings in [[= product_name_connect =]].
133+
134+
![Ibexa Connect scenario selection](img/ai_action_settings_connect.png)
135+
136+
!!! note "Link to [[= product_name_connect =]]"
137+
138+
Click **Go to Connect** to review all scenarios that exist in [[= product_name_connect =]].
139+
140+
7\. Click **Save and close** to apply the changes or **Discard** to discard them and close the window.
141+
142+
After you save the AI action, you can click its name in the AI actions list and see all the information, such as Scenario ID, webhook URL, or scenario label, which you may needed when working with scenarios in [[= product_name_connect =]].
143+
106144
## Duplicate AI actions
107145

108146
You can duplicate existing actions, for example, to create a variant version of an action with slightly different settings.

0 commit comments

Comments
 (0)