IBX-8689: AI Actions documentation #2473
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mnocon
reviewed
Sep 13, 2024
| 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. | ||
|
|
||
| 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. | ||
| The possibilities are endless. |
There was a problem hiding this comment.
Suggested change
| The possibilities are endless. | |
| The possibilities are endless and you're not limited to a specific AI service, avoiding vendor lock-in. |
| In the evolving landscape of digital experience, artificial intelligence becomes more and more important by enhancing user interaction and automating complex tasks. | ||
| 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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
|
|
||
| ## Availability | ||
|
|
||
| AI Actios are available as an add-on to the v.4.6.x version of [[= product_name =]], regardless of its edition. |
There was a problem hiding this comment.
Suggested change
| AI Actios are available as an add-on to the v.4.6.x version of [[= product_name =]], regardless of its edition. | |
| AI Actions are available as an add-on to the v4.6.x version of [[= product_name =]], regardless of its edition. |
|
|
||
| #### Action types | ||
|
|
||
| Action types are predefined by developers within YAML configuration. |
There was a problem hiding this comment.
Suggested change
| Action types are predefined by developers within YAML configuration. | |
| Action types are predefined by developers. |
It's YAML, but not YAML configuration - it's part of the Symfony Container definitions.
I mean: https://github.com/ibexa/connector-ai/blob/main/src/bundle/Resources/config/services/action_types.yaml is closer to "code" than "configuration" (and it's possible to define Action Type s using PHP code)
Comment on lines
+19
to
+21
| To check for the presence of AI Actions in your application, run the following command: | ||
|
|
||
| `composer show | grep "ibexa/connector-ai"` |
| Ibexa Engage is available from v4.6.x of [[= product_name =]]. | ||
| Run the following command to install the bundle: | ||
|
|
||
| `composer require ibexa/connector-ai` |
There was a problem hiding this comment.
This is just the framework. To get the out of the box OpenAI integration you also need ibexa/connector-openai (a second package).
|
|
||
| ## Prepare configuration files | ||
|
|
||
| When you install AI Actions add-on, it modifies the YAML configuration files by adding configuration keys similar to this example: |
There was a problem hiding this comment.
To configure the default actions (alt text, possibly refine text) only the OpenAPI token needs to be specified in env variables
|
|
||
| ## Install AI Actions | ||
|
|
||
| Ibexa Engage is available from v4.6.x of [[= product_name =]]. |
There was a problem hiding this comment.
Suggested change
| Ibexa Engage is available from v4.6.x of [[= product_name =]]. | |
| AI feature is available from v4.6.x of [[= product_name =]]. |
😛
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prepare a foundation for the documentation of AI Actions add-on.
Checklist