Skip to content

Commit 5db48c2

Browse files
dabrtmnocon
andauthored
Change wording
Co-authored-by: Marek Nocoń <[email protected]>
1 parent 2188724 commit 5db48c2

File tree

5 files changed

+22
-22
lines changed

5 files changed

+22
-22
lines changed

docs/ai_actions/ai_actions_guide.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ description: AI Actions add-on helps editors by automating repetitive tasks.
99
In the evolving landscape of digital experience, artificial intelligence becomes more and more important by enhancing user interaction and automating complex tasks.
1010
To harness AI's potential, [[= product_name =]] introduces th AI Actions add-on, which you can install and use to automate various time-consuming tasks, for example, generating alt text for images.
1111

12-
Built upon the PHP framework, AI Actions offer an extensible solution for integrating services provided by AI engines into your workflows, all managed through a user-friendly interface.
12+
Built upon the PHP framework, AI Actions offer an extensible solution for integrating services provided by AI services into your workflows, all managed through a user-friendly interface.
1313

1414
You can extend the add-on and make it do different things, for example, transform text passages, or generate illustrations for your articles based on a prompt.
15-
The possibilities are endless.
15+
The possibilities are endless and you're not limited to a specific AI service, avoiding vendor lock-in.
1616

1717
## Availability
1818

19-
AI Actios are available as an add-on to the v.4.6.x version of [[= product_name =]], regardless of its edition.
19+
AI Actions are available as an add-on to the v4.6.x version of [[= product_name =]], regardless of its edition.
2020
To use it's capabilities you must install the package and perform initial configuration.
2121

2222
## How it works
@@ -32,8 +32,8 @@ This clear separation allows for a flexible system where actions can be easily c
3232

3333
#### Action types
3434

35-
Action types are predefined by developers within YAML configuration.
36-
Each action type defines the structure and nature of the task that the AI engine performs.
35+
Action types are predefined by developers.
36+
Each action type defines the structure and nature of the task that the AI service performs.
3737
Action types could be designed to generate alt text for images, summarize a passage of text, or even translate content into another language.
3838
By defining action types in YAML, developers can create a wide range of functionalities that can be easily deployed within the application.
3939

@@ -48,9 +48,9 @@ By adjusting these configurations, administrators can ensure that the actions ar
4848

4949
Once an action is defined and configured, it must be executed, and this is where handlers come into play.
5050
Handlers are pieces of PHP code that are responsible for resolving an action.
51-
Each handler is designed to work with a specific AI engine and action type pair.
52-
Handlers may include hardcoded prompts for conversational AI engines like ChatGPT, or they may operate without prompts for other types of AI.
53-
Handlers take configurations defined in the action type and action configuration, combine it with user input and any predefined settings or prompts, and pass this information to the AI engine for processing.
51+
Each handler is designed to work with a specific AI service and action type pair.
52+
Handlers may include hardcoded prompts for conversational AI services like ChatGPT, or they may operate without prompts for other types of AI.
53+
Handlers take configurations defined in the action type and action configuration, combine it with user input and any predefined settings or prompts, and pass this information to the AI service for processing.
5454

5555
### Triggering actions from the UI
5656

@@ -76,9 +76,9 @@ By issuing commands through the API, developers can trigger actions based on ext
7676

7777
Built-in action types offer a good starting point, but the real power of AI Actions lies in extensibility.
7878
Extending AI Actions opens up new possibilities for content management and editing.
79-
Developers can extend the feature by adding new action types that use existing AI engines or even integrating additional AI services.
80-
This involves defining a new action type in YAML, writing a handler that communicates with the new service or engine, and creating a form for configuring the options that extends the action configuration form shown in the Admin Panel.
81-
For example, a developer could write a handler that uses an AI service to shorten or expand text passages, or generate illustrations based on a body of an article.
79+
Developers can extend the feature by adding new action types that use existing AI services or even integrating additional ones.
80+
This involves defining a new action type in YAML, writing a handler that communicates with the new service, and creating a form for configuring the options that extends the action configuration form shown in the Admin Panel.
81+
For example, a developer could write a handler that uses an AI service to generate complete articles based on a short description, or illustrations based on a body of an article.
8282

8383
### Use cases
8484

@@ -89,4 +89,4 @@ For example, a developer could write a handler that uses an AI service to shorte
8989
Out of the box, the [[= product_name_base =]] AI Actions add-on comes with the generating alt text for images capability.
9090
Organizations can benefit from it's use by improving accessibility and SEO.
9191
Once the feature is configured, editors can generate alt text for images they upload to the system by clicking one button, while administrators can use the API to run a batch process against a larger collection of illustrations.
92-
Before you can start generating alt text, some preliminary setup is required, which includes configuring access to an AI engine.
92+
Before you can start generating alt text, some preliminary setup is required, which includes configuring access to an AI service.

docs/ai_actions/alt_text/customize_alt_text_generation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Add custom features to alternative text generation for images.
44

55
# Customize alternative text generation
66

7-
If you need more control over the alt text generation feature, you can customize, for example, by integrating a different AI engine, and modifying the default behavior.
7+
If you need more control over the alt text generation feature, you can customize, for example, by integrating a different AI service, and modifying the default behavior.
88

99
## Add custom glossaries
1010

@@ -13,9 +13,9 @@ One way to do it is by creating lists of specific keywords or phrases that shoul
1313

1414
...
1515

16-
## Integrate a different AI engine
16+
## Integrate a different AI service
1717

18-
If the default AI engine doesn’t meet your requirements, you can connect to a different AI service.
19-
To do it, you must configure API endpoints, input formats, and authentication details for the new engine.
18+
If the default AI service doesn’t meet your requirements, you can connect to a different one.
19+
To do it, you must configure API endpoints, input formats, and authentication details for the new service.
2020

2121
...

docs/ai_actions/alt_text/enable_alt_text_generation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ In the root folder of your project, edit the `<ADD FILE NAME>` file by adding th
2525
...
2626
```
2727

28-
!!! note "Configuring user credentials for different engines"
28+
!!! note "Configuring user credentials for different servces"
2929

30-
If your installation supports [multiple AI engines](extend_ai_actions.md) that perform the same AI action, you must provide credentials for each of these engines.
30+
If your installation supports [multiple AI services](extend_ai_actions.md) that perform the same AI action, you must provide credentials for each of these services.
3131
Otherwise some of the AI Actions will remain inactive.
3232

3333
## ...
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
description: Extend AI Actions by connecting to other engines and adding new capabilities.
2+
description: Extend AI Actions by connecting to other services and adding new capabilities.
33
---
44

55
# Extend AI Actions
66

77
By extending AI Actions you can enhance the attractiveness of mundane content management and editing tasks and make them less burdensome.
8-
You can start from adding new action types that use the existing AI engine, and evolve to integrating additional AI services with completely new areas of application.
8+
You can start from adding new action types that use the existing AI service, and evolve to integrating additional ones with completely new areas of application.
99
For example, you could write a handler that connects to a translation model and use it to translate your website on-the-fly, or generate illustrations based on a body of an article.
1010

1111
## ...

docs/ai_actions/install_ai_actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ description: Install the AI Actions add-on.
44

55
# Install AI Actions
66

7-
AI Actions are available as an add-on to the v.4.6.x version of [[= product_name =]] or higher, regardless of its edition.
7+
AI Actions are available as an add-on to the v4.6.x version of [[= product_name =]] or higher, regardless of its edition.
88
To use this feature you must first install the add-on and then configure it YAML configuration.
99

1010
## Install AI Actions
1111

12-
Ibexa Engage is available from v4.6.x of [[= product_name =]].
12+
AI Actions are available from v4.6.x of [[= product_name =]].
1313
Run the following command to install the bundle:
1414

1515
`composer require ibexa/connector-ai`

0 commit comments

Comments
 (0)