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.md
+53-23Lines changed: 53 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,9 @@
1
1
# AI at Shuffle
2
-
3
-
With AI becoming a larger part of the Automation space, the goal with AI at Shuffle is provide it in a controllable and responsible way. We do not intend to implement chat systems - just to make certain mechanisms in Shuffle easier to use over time.
2
+
With AI becoming a larger part of the Automation space, the goal with AI at Shuffle is provide it in a deterministic, controllable and responsible way. We do not intend to implement chat systems - just to make certain mechanisms in Shuffle easier to use over time.
4
3
5
4
## Using LLMs
6
5
Shuffle by default provides LLM credits using the OpenAI GPT-5-mini model. This is available to a certain level to those who use our Cloud or Hybrid offerings. [Read about self-hosted models](#how-to-set-up-a-self-hosted-ai-model-with-shuffle).
7
6
8
-
## Singul
9
-
Singul works against vendor-locking with our translator for different providers of the same tools, such as Slack vs Teams vs Discord, or Splunk vs Elastic vs QRadar). It uses LLMs to understand the context of what you are trying to perform, and makes a determinsitic translation to use a standard such as OCSF or STIX. This is a powerful way to avoid vendor lock-in, and to make your automation more future-proof. Made by the Shuffle team.
10
-
11
-
Read the [usage Shuffle Docs here](https://github.com/Shuffle/openapi-apps/blob/master/docs/singul.md)
12
-
Website: [https://singul.io](https://singul.io)
13
-
14
7
## AI Agents
15
8
Agents are a way to have an AI model interact with the world. In Shuffle, this means using tools (playbooks) to perform actions. We intend to provide controllable, deterministic Agents that can be used to perform tasks.
16
9
@@ -24,19 +17,53 @@ They can additionally talk to each other and be published for third party use.
24
17
25
18
**This is in private Beta and is not generally available yet. If you would like to try it, please reach out to [email protected] and ask about AI Agents.**
26
19
27
-
## How to Generate Your First Workflow with AI
28
-
This guide will walk you through creating a complete, functional Shuffle workflow in seconds, just by describing what you want to do in plain English.
20
+
## Singul
21
+
Singul works against vendor-locking with our translator for different providers of the same tools, such as Slack vs Teams vs Discord, or Splunk vs Elastic vs QRadar). It uses LLMs to understand the context of what you are trying to perform, and makes a determinsitic translation to use a standard such as OCSF or STIX. This is a powerful way to avoid vendor lock-in, and to make your automation more future-proof. Made by the Shuffle team.
22
+
23
+
Read the [usage Shuffle Docs here](https://github.com/Shuffle/openapi-apps/blob/master/docs/singul.md)
24
+
Website: [https://singul.io](https://singul.io)
25
+
26
+
## MCP
27
+
TBA: Any app in Shuffle is an MCP
28
+
29
+
## App generation
30
+
App generation is a system built to generate Rest API apps from documentation URLs. It works by emulating a browser with which it crawls the documentation.
This guide will walk you through creating a complete, functional Shuffle workflow in seconds, just by describing what you want to do in plain English.
57
+
58
+
### 1: Navigate to the Workflow Page
32
59
* In the navigation sidebar on the left, click on "Workflows". This will take you to the `/workflows` page where you'll see your list of existing workflows.
33
60
34
-
**Step 2: Start a New Workflow**
61
+
###2: Click "Create Workflow"
35
62
* In the top right corner of the Workflows page, click the "Create Workflow" button.
* At the top of the canvas, you will see a text box that says "Describe your workflow in natural language...". This is where the magic happens.
51
77
* Click inside this box and type out the process you want to automate.
52
78
@@ -82,12 +108,12 @@ This flowchart shows our phishing response process. The goal is to automate the
82
108
The ability to process images depends entirely on your AI model. This feature is fully supported when using Shuffle Cloud's default model. If you are using a self-hosted model (like Ollama), you must ensure it is a multimodal model (one that can understand both text and images) for this feature to work correctly.
83
109
84
110
85
-
**Step 4: Generate the Workflow**
111
+
###4: Generate the Workflow
86
112
87
113
* Once you are satisfied with your description or uploaded flowchart, click the 'AI Generate' button.
88
114
* Wait a few moments. The AI will analyze your request and automatically build the workflow on the canvas, complete with the right apps and connections.
89
115
90
-
**Step 5: Review and Customize**
116
+
###5: Review and Customize
91
117
* The AI-generated workflow is a powerful starting point. You can now:
92
118
93
119
* Click on each app to configure its specific settings (e.g., authenticating with your Jira account).
@@ -98,7 +124,10 @@ The ability to process images depends entirely on your AI model. This feature is
98
124
99
125
**Congratulations! You've just built an automation workflow using AI.**
100
126
101
-
## How to set up a Self-Hosted AI Model with Shuffle
127
+
## Editing a Workflow
128
+
This is a work in progress. Currently in Alpha. Contact [email protected] if you would like to be a tester.
129
+
130
+
## Using self-hosted AI models
102
131
103
132
While Shuffle's Cloud platform provides AI credits to get you started, connecting your own self-hosted AI model gives you ultimate control and flexibility. This guide will walk you through the process.
104
133
@@ -129,13 +158,13 @@ You will need the following information from your self-hosted AI server:
129
158
130
159
**Step 2: Set the Environment Variables**
131
160
132
-
`OPENAI_API_URL` (Required)
161
+
`AI_API_URL` (Required)
133
162
134
163
* What it is: The full URL to your AI server's API endpoint.
135
164
136
165
Example:
137
166
```bash
138
-
OPENAI_API_URL=http://localhost:11434/v1
167
+
AI_API_URL=http://localhost:11434/v1
139
168
```
140
169
141
170
`AI_MODEL` (Required)
@@ -147,25 +176,26 @@ Example:
147
176
AI_MODEL=llama3
148
177
```
149
178
150
-
OPENAI_API_KEY (Optional)
179
+
AI_API_KEY (Optional)
151
180
152
181
* What it is: The API key or token if your server requires authentication.
153
182
154
183
Example:
155
184
```bash
156
-
OPENAI_API_KEY=sk-mysecretkey123
185
+
AI_API_KEY=sk-mysecretkey123
157
186
```
158
187
159
-
160
188
Shuffle can support any self-hosted model that implements the OpenAI API interface. Examples include Ollama, local LLMs wrapped with OpenAI-compatible endpoints, or any other model that exposes the same API.
161
189
162
190
Once these are set, there is no need to restart your Shuffle backend server as the checks happen in real-time. The AI features will be automatically enabled, allowing you to use them immediately.
163
191
164
192
**Note: You need to refresh the Shuffle UI page in your browser for the new AI features to appear.**
165
193
166
194
167
-
###Troubleshooting
195
+
## Troubleshooting
168
196
169
197
* Ensure your AI server is running and reachable at the URL you provided.
170
198
* If using authentication, double-check the API key.
171
199
* Use the exact model name available on your self-hosted AI instance.
0 commit comments