You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ai_actions/ai_actions_guide.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ The possibilities are endless and you're not limited to a specific AI service, a
26
26
The AI Actions feature is an opt-in capability available as an LTS Update to the v4.6.x version of [[= product_name =]], regardless of its edition.
27
27
To begin using AI Actions, you must first install the required packages and perform initial configuration.
28
28
29
-
!!! "API Key
29
+
!!! note "API Key"
30
30
31
31
The Open AI connector requires that you first [get an API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key).
32
32
@@ -46,7 +46,7 @@ AI Actions can also be extended beyond the default setup by creating custom conn
46
46
47
47
### Core concepts
48
48
49
-
#### Actions
49
+
#### Action
50
50
51
51
Actions are tasks or functions that the AI is set to perform.
52
52
Each Action is a combination of an action type and an action configuration.
@@ -67,7 +67,7 @@ Action configurations are managed in the [Admin Panel](admin_panel.md), and allo
67
67
Such tuning might involve setting specific parameters used the AI service, setting an expense limit, or configuring how the output should be handled.
68
68
By making such adjustments, administrators can ensure that the actions are tailored to meet their requirements.
69
69
70
-
#### Handlers
70
+
#### Handler
71
71
72
72
Once an action is defined and configured, it must be executed, and this is where handlers come into play.
73
73
Handlers are pieces of PHP code that are responsible for resolving an action.
@@ -92,16 +92,18 @@ Procedures are straightforward and intuitive, ensuring that users can quickly ac
92
92
93
93
AI Actions add-on exposes a REST API interface that allows for programmatic execution of actions.
94
94
With the API, developers can automate tasks and execute actions on batches of content by integrating them into workflows.
95
-
By issuing commands through the API, developers can trigger actions based on external events:
96
-
...
95
+
<!---By issuing commands through the API, developers can trigger actions based on external events:
96
+
...--->
97
97
98
98
## Capabilities
99
99
100
100
### Management
101
101
102
102
The AI Actions allows you to control the lifecycle of action configurations.
103
103
Users with the appropriate permissions, governed by role-based [policies](policies.md#ai-actions), can create, edit, execute, and delete action configurations.
104
-
Additionally, configurations can be enabled or disabled depending on the organization's needs.
104
+
Additionally, configurations can be enabled or disabled depending on the organization's needs.
0 commit comments