Skip to content

Commit 341e838

Browse files
dabrtmnocon
andauthored
Apply suggestions from code review
Co-authored-by: Marek Nocoń <[email protected]>
1 parent 938fa1e commit 341e838

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/ai_actions/ai_actions_guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ AI Actions is an extensible solution for integrating features provided by AI ser
1313
Out-of-the-box, AI Actions includes two essential components: a framework package and an OpenAI connector package.
1414
It comes pre-configured with the following action types:
1515

16-
- [Refine text](#refining-text): Rewrite existing text according to parameters set in a prompt
17-
- [Generate alternative text](#generating-alternative-text): Generate alt text for accessibility purposes
16+
- [Refine text](#refining-text): Rewrite existing text according to instructions set in a prompt
17+
- [Generate alternative text](#generating-alternative-text): Generate alt text for images for accessibility purposes
1818

1919
![AI Actions schematic](img/guide_ai_actions.png)
2020

@@ -33,7 +33,7 @@ To begin using AI Actions, you must first [install the required packages and per
3333

3434
## How it works
3535

36-
AI Actions LTS update is built upon the PHP framework.
36+
AI Actions LTS update relies on an extensible AI framework written in PHP.
3737
The framework package 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.
3838
This data can then be combined with user input.
3939
It's then passed to a service connector, such as the default OpenAI connector, for final processing on [[= product_name =]] side.
@@ -116,7 +116,7 @@ Built-in AI action types offer a good starting point, but the real power of the
116116
Extending AI Actions opens up new possibilities for content management and editing.
117117
Developers can define new models and AI action types that use the existing AI service or even integrate additional services.
118118
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.
119-
For example, if this is your organization's requirement, a developer could write a handler that uses an AI service to <insert_a description and link to Marek's use case> generate complete articles based on a short description, or illustrations based on a body of an article.
119+
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.
120120

121121
## Use cases
122122

docs/ai_actions/install_ai_actions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To use this feature you must first install the packages and configure them.
99

1010
## Install packages
1111

12-
Run the following command to install the bundle:
12+
Run the following commands to install the packages:
1313

1414
``` bash
1515
composer require ibexa/connector-ai
@@ -27,7 +27,7 @@ Once the packages are installed, before you can start using AI Actions, you must
2727

2828
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).
2929

30-
Then, in the root folder of your project, modify the `.env` file: find the `OPENAI_API_KEY` key and replace a placeholder value with the API key that you got from the AI service.
30+
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.
3131

3232
```bash
3333
###> ibexa/connector-openai ###

0 commit comments

Comments
 (0)