-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f245edc
commit 4255995
Showing
14 changed files
with
397 additions
and
9 deletions.
There are no files selected for viewing
8 changes: 8 additions & 0 deletions
8
apps/docusaurus/zeusfyi/docs/mockingbird/actions/_category_.json
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Actions", | ||
"position": 4, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "How to build a manage mockingbird triggered actions." | ||
} | ||
} |
78 changes: 78 additions & 0 deletions
78
apps/docusaurus/zeusfyi/docs/mockingbird/actions/actions.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
sidebar_position: 2 | ||
displayed_sidebar: mockingbird | ||
--- | ||
|
||
# API Approvals | ||
|
||
## Overview | ||
|
||
The Actions tab is an essential feature for overseeing and managing API trigger calls within your workflow. | ||
It serves as a control panel where users can approve or reject pending actions, as well as view the historical | ||
results and responses of past actions. This ensures that all external communications via API calls are vetted by human | ||
oversight. | ||
|
||
## Approving and Rejecting API Triggers | ||
|
||
### Action Approval Process | ||
|
||
#### Review Request Summary: | ||
|
||
Examine the details of the API call request, including the Workflow Result ID, Approval ID, and the Request Summary. | ||
|
||
#### Approve or Reject: | ||
|
||
Make an informed decision to approve or reject the trigger action. Approving an action will execute the API call, while | ||
rejecting it will prevent the call from being made. | ||
|
||
### Update Status: | ||
|
||
Once an action is approved or rejected, its status is updated to reflect the new state. | ||
|
||
## Action Buttons | ||
|
||
### Approve: | ||
|
||
Click this button to authorize the API call. | ||
|
||
### Reject: | ||
|
||
Click this button to decline the API call. | ||
|
||
## Historical Actions | ||
|
||
### Viewing Past Actions | ||
|
||
### Access Historical Data: | ||
|
||
The lower section of the Actions tab displays a history of all API trigger actions that have been taken. | ||
|
||
Analyse Past Decisions: Review the Approval ID, Request Summary, Final State, Updated At, and the full list of requests | ||
and responses to understand the outcome of past decisions. | ||
|
||
### Historical Insights | ||
|
||
Gain insights into the decision-making process over time. | ||
Assess the consistency and accuracy of past approvals or rejections. | ||
|
||
### Example of the Actions Tab | ||
|
||
Trigger Name: social-media | ||
Trigger Group: social-media-approvals | ||
Trigger Env: social-media-engagement | ||
|
||
Action Details: | ||
|
||
- Workflow Result ID: 170665375241213000 | ||
- Approval ID: 1706653756335363475 | ||
- Approval State: Pending | ||
- Request Summary: Requesting approval for trigger action [...] | ||
|
||
Historical Actions: | ||
|
||
- Approval ID: 170664805335778953 | ||
- Request Summary: Finished approval for trigger action | ||
- Final State: Finished | ||
- Updated At: 1/30/2024, 10:00:05 PM | ||
|
||
![Scre](https://github.com/zeus-fyi/zeus/assets/17446735/c1451545-4ea7-4c32-9415-01d079b43b39) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "API", | ||
"position": 5, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "How to use the mockingbird API." | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
sidebar_position: 2 | ||
displayed_sidebar: mockingbird | ||
--- | ||
|
||
# Docs | ||
|
||
### Coming Soon (Expected Mid-Feb 2024) | ||
|
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
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
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
2 changes: 1 addition & 1 deletion
2
apps/docusaurus/zeusfyi/docs/mockingbird/builder/json_schemas.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 7 | ||
sidebar_position: 8 | ||
displayed_sidebar: mockingbird | ||
--- | ||
|
||
|
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
66 changes: 66 additions & 0 deletions
66
apps/docusaurus/zeusfyi/docs/mockingbird/builder/triggers.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
--- | ||
sidebar_position: 7 | ||
displayed_sidebar: mockingbird | ||
--- | ||
|
||
# Triggers and Actions | ||
|
||
## Intro | ||
|
||
The Triggers and Actions system is a critical component of our automation framework. | ||
It links evaluation functions to API triggers to streamline the execution of AI-driven workflows. | ||
Upon evaluation, this system generates a request payload for user approval or rejection. | ||
If approved, the corresponding API call is executed. Rejected requests are archived and not executed. | ||
This mechanism ensures that automated decisions are overseen and validated by human judgment when necessary. | ||
|
||
![Scr](https://github.com/zeus-fyi/zeus/assets/17446735/893cb682-b82d-4cbc-9cdf-742e41f7142b) | ||
|
||
## Trigger Action Procedures | ||
|
||
![ScreensM](https://github.com/zeus-fyi/zeus/assets/17446735/f8011006-e92c-413a-9267-ea69165b91e9) | ||
|
||
### Setting Up Triggers | ||
|
||
- **Define a New Trigger**: Assign a name and group to a new trigger, identify the trigger source, and specify the | ||
trigger action. | ||
- **Link to Eval Function**: Connect the trigger to an eval function that will analyze AI outputs to decide on API call | ||
initiation. | ||
|
||
### API Trigger Settings | ||
|
||
- **Retry Mechanisms**: Configure the maximum retry attempts for API calls and set up backoff coefficients for retry | ||
intervals. | ||
- **Save Trigger**: Save the configured trigger so it can start listening for outputs from the linked eval function. | ||
|
||
## Evaluation Functions and API Calls | ||
|
||
![ScreensM](https://github.com/zeus-fyi/zeus/assets/17446735/f8011006-e92c-413a-9267-ea69165b91e9) | ||
|
||
### Connecting Eval Functions | ||
|
||
- **Select the Eval Function**: Pick the appropriate evaluation function that will provide criteria for API call | ||
triggers. | ||
|
||
### Automated Payload Creation | ||
|
||
- **Payload Generation**: Once the eval function criteria are met, the system automatically generates an API call | ||
request payload. | ||
|
||
## Actions Menu | ||
|
||
![Scree](https://github.com/zeus-fyi/zeus/assets/17446735/8f340b39-5c42-4813-9ca2-7e94334cafdf) | ||
|
||
### Review and Decision | ||
|
||
- **Approve/Reject Payloads**: Use the actions menu to review generated payloads and make decisions to approve or reject | ||
them. | ||
|
||
### Historical Tracking | ||
|
||
- **Action Records**: The system maintains a log of all actions taken, which can be accessed for review or auditing | ||
purposes. | ||
|
||
## Conclusion | ||
|
||
This triggers and actions framework empowers users to have final control over automated processes, ensuring that every | ||
action taken by the AI is deliberate and in line with organizational standards. |
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
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
8 changes: 8 additions & 0 deletions
8
apps/docusaurus/zeusfyi/docs/mockingbird/setup/_category_.json
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Setup", | ||
"position": 1, | ||
"link": { | ||
"type": "generated-index", | ||
"description": "How to manage mockingbird setup options." | ||
} | ||
} |
Oops, something went wrong.