Skip to content

Commit 5f3dde3

Browse files
committed
Update guide diagram
1 parent af41b70 commit 5f3dde3

File tree

7 files changed

+10
-63
lines changed

7 files changed

+10
-63
lines changed

docs/ai_actions/ai_actions_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ It comes pre-configured with the following action types:
1616
- [Refine text](#refining-text): Rewrite existing text according to parameters set in a prompt
1717
- [Generate alternative text](#generating-alternative-text): Generate alt text for accessibility purposes
1818

19-
![AI Actions schematic](img/guide_AI Actions.png)
19+
![AI Actions schematic](img/guide_ai_actions.png)
2020

2121
You can extend its capabilities beyond the default setup by creating custom connector modules, allowing users to integrate additional AI services or customize the way data is processed and interpreted.
2222
For example, it could transform images, or generate illustrations for your articles based on their contents.

docs/ai_actions/alt_text/customize_alt_text_generation.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/ai_actions/alt_text/enable_alt_text_generation.md

Lines changed: 0 additions & 33 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile host="Electron" modified="2024-10-23T18:29:03.021Z" agent="5.0 (Macintosh; Intel Mac OS X 14_7_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="6gPmGrvR6C0PY14pvC51" version="14.6.13" type="device"><diagram id="kEppTf-Kki688EfmVOyB" name="Page-1">7VvZlqrIEv2aetQFyfwIAg6ooOL40guZFcECFPHrOymxFKG6POfq6br36osQmckQO2LHzgTesMbm0Ay1rdMLDNN7A4hxeMP4NwAAgwP4l1nSk6WGYtTJYoeucbKhF8PIPZq5EcmtO9cwo0LHOAi82N0WjXrg+6YeF2xaGAZJsZsVeMWzbjXbLBlGuuaVrVPXiJ2TlUCQi71luraTnxknyVPDRjv3zXtGjmYEyZUJE96wRhgE8Wlrc2iYXua8s1tO48QvWj+vKzT9+J4B2wEmTzbyX8lSt/i/4n68e9/W0Pwwe83b5TecX22cnj1gh8FuWz7beaQZxuahCgpteT7C5XZhnJjBxozDFPbLR9UAjhCnkXmQUEzus+TicYBjdSrv5lw5nKHqFM58/mgmhz6H3f483cU1cCP3zi94iig5iu2q0KAKM7XkMoj1NtuMEjfW4Q1wiePG5mir6Zk1gakCbU68gVfAo3AzDGItdgMf7iJwN4rDYG02Ai8IocUPfDMznuMnG2C5nndufwOYAERCyOxlmP4Z9lvwyiDdAQFGfZof7nam5PahILb7wv+B5/NkwO7PhWcCcebjKyQa45Eq96CtJ/NC9+dAEcBTuHHmPgJ5JjIEU2eufjRN/gikQJmqvsQm8913uBR87mlL0+M0fZ1VBd+4gccK/Dgv4SgoI2RZFtD1O6G2Q81wIWTF8fB31ca7ISw0pwMlZhRXon0/rpeCdE66HGkSLSchTdYZtIwsTmB1knoWtNgTobU9LYrugjlamx8Z/QHeN5gblMlYLLRroZ53+8jKrNsov+oo8LLbvg6LGkr/xMhAGeQ2MkD9fJyr4EDPAVMMDbSOPyDrVf5Aa1zK7WradDl8R4KZitRAmZ/fAOllNx5tNR9u29m2rAh92IttnxuX4bmpIff7QkOVh+WmswVe2fXBSrEHrxPqcvP7wNOi7UmsW+7BNG4jsRL1+wvvbyQ81Jx1mi6KUBwvw0pful0je21/fOW9P+fvLbUl9z9RBv0GGgh5AwVF1CmqhAaD1UFFbUUBXsfwJ6UZSpfQyHIJYRtqW+6PyqkjDtmeMJWH0rOS5SskKjF8DDw3HEhBkYPSV0qonDcQKhKrgOrK/p9AtQOzldbtBWFTHOO8M7cFcl4jf48Qv+M46Kb4RriakXvMZ7tZ9mi7OIjyipjteq6dJZYOfW5mRTnztatrHps3bFzDyAZz28D14w83ENwbwd+Ae07DKlw/qnQWG3y14v0dDYSSdQIvAg2wguItA01WlL1zZXq8Gvq65GWipAAb+b4Lzg21Ezgs7ICC7eHSeMb8Yz4zugqI0+HuDoj7Eb8NnXIE3ARTdWm8SDDmUfBjKF1HsSL8RCUNU0/CnF9Ne40lv1qBnTpZSUwNV70aqKqG5axuc8Isw5efKa+8LipYmr5hb1DWOfSfTGOsKo0r1yCLMwQSuZ2KfNZFpOS6y5oA/mue/I3lTBRDCx5m0DJRAgLA9EI+fxUzSVhSoagsdXk8jZbX2J4qMHPg/vDyzmeU3Z0qKCgmSg374xK0Gq+yBK2iwPPq3P/INO9mhvLHgqCogDCsrG2/nBMyD5kTErW9M2js2hY20klanwxVxblnTvj8xzYYit1KBJohP2/6G4mAPWAlpNI34Mv0MNz9bai7GztzW6gXVKKhxRoUiO4mezgIxK1vZ3miRSYJw6HhTjh5mCBS0w5Y+OuPxo4wtuEWN8j2Jw12nu00UZ3MOjTGgicMJgNcZaZjbEyr4yEvHkGK+UzDbXI0ogRs4A7WnabtJ/BskGW4ABkYK7TJIuOhNOEaI2fa38Yxtmv1MjUKdcgYHFUKx9cIiNEDsDJr79hZDwkdTmTEmdK22OOUJ52VDfe597nYnkjOLBLb3oy1opgOdws+Dug+0QoHDNueG6mwoyElcCHa88IB3JAoa22s51JfTlWTm7SnEUeO/IHSVpsdZDCS7CU38ob8fDWz+wEfKPhgGiJWd8Ul/BZpqBMfeCRrDRSmC3qWr3D7ZDHYL8RI7m3WPNoKmkogAX/Q7B2lzrK9PzRZwkmgctMEhscFXHEUubNnXf94SHDXgSqdi1ntEM/BaIb0MlTc5mRCBny4OfZVBFsr+FwZLVuy1ncWK8Vq4Rt+SIMJDBcxMcfUZC/wLru2vVQVoZe5wXKUhRng7K4w5bvidjKVvRHOotiyg6X82NC7bUURetKMajq2Pl5gXqiPpPeuRPAmvP8um+zTZiu0Gd0azHub1rGfpAgnihpDDwbJvLMjVuL7sREwqTNK27Ml346X1j6SpXmyn3P00V2NJaDFbQ+ZocL2HV5JuksjZ8V7RoNf7Vr7WFJbSiiPRN9LKTNieBi8nGLvjShUJb5rNOdwhgsDmVt0HSpZxKJngdZE8jsMYA0aiFILhJJzukkKWSp0gr0TtNRabMP1ZC/6eK+n+gHn8S2D12G3ceYVdh6vxoIVcE07kfayEa3FlZL2ozXswFLxcet1Nv13SrXo4WJm7bqyFS4NKCA4fq7jcYNabGweXbpLMZVNAuyhd2eJPDgEy3BKL/YbhB5zobyIwKS5YjTQIjW1b7ipCZZEx229az3Q1vhevzfVV7gymEw9YiN0kvRAEcNADFV1CJroIc2yjOU6wzEhhOuObdtZ8l7nb0VBK+R+tfT/ppiVufQfqfmXHq1iVc+InkWQVQ8RXgT5IsgXQb4I8kcR5PktsvLDV6xKUD5ggaLygvEXX7748sWXL778L+FL/F/myzveP3r64gTKoMXVOxRFym75o+sSXz+PfJWRVxl5lZFXGXlqGSG+4Nafsy5BvQjyRZAvgnwR5E8nyB+yLvH1c+AXX7748sWXL778WXz5b69L3PGe073fy2TvnDzoe5l//MSl4jOWO76juXmHRvz4Per9QYoBhYUVEiXq53fTrpDFy8DixK/PHODu5RPpj7arD80x4W8=</diagram></mxfile>
-75.3 KB
Binary file not shown.
73.1 KB
Loading

docs/ai_actions/install_ai_actions.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ Create an OpenAI account, [get an API key](https://help.openai.com/en/articles/4
2929

3030
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.
3131

32+
```
33+
###> ibexa/connector-openai ###
34+
OPENAI_API_KEY=sk-svcacct-AFCrCt1h2s3i4s5i6s7t8h9e0a1p2i3c4o5d6e
35+
###< ibexa/connector-openai ###
36+
```
37+
3238
### Modify the database schema
3339

3440
Create the `add_ai_actions.sql` file that contains the following code:
@@ -37,14 +43,12 @@ Create the `add_ai_actions.sql` file that contains the following code:
3743
[[= include_file('code_samples/ai_actions/config/add_ai_actions.sql') =]]
3844
```
3945

40-
Run the following command:
46+
Run the following command. where `<database_name>` is the same name that you defined when you [installed [[= product_name =]]](install_ibexa_dxp.md#change-installation-parameters).
4147

4248
```bash
43-
mysql -u root <database_name> < <path_to_file>/add_ai_actions.sql
49+
mysql -u root <database_name> < add_ai_actions.sql
4450
```
4551

46-
https://doc.ibexa.co/en/master/getting_started/install_ibexa_dxp/#change-installation-parameters
47-
4852
This command modifies the existing database schema by adding database configuration required for using AI Actions.
4953

5054
You can now restart you application and start [working with the AI Actions feature]([[= user_doc =]]/ai_actions/work_with_ai_actions//).

0 commit comments

Comments
 (0)