Skip to content

Commit b6139d6

Browse files
waleedlatif1waleedlatif1
authored
improvement(docs): simplify docs and add examples/pictures of v5 (#1887)
* improvement(docs): added new platform ss * rename approval to human in the loop * cleanup * remove yml * removed other languages large sections * fix icons
1 parent c86f2a0 commit b6139d6

File tree

148 files changed

+869
-2976
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+869
-2976
lines changed

‎apps/docs/content/docs/de/blocks/api.mdx‎

Lines changed: 6 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,6 @@ Der API-Block ermöglicht es Ihnen, Ihren Workflow über API-Endpunkte mit exter
1919
/>
2020
</div>
2121

22-
## Überblick
23-
24-
Der API-Block ermöglicht Ihnen:
25-
26-
<Steps>
27-
<Step>
28-
<strong>Verbindung zu externen Diensten</strong>: HTTP-Anfragen an REST-APIs und Webdienste stellen
29-
</Step>
30-
<Step>
31-
<strong>Daten senden und empfangen</strong>: Antworten verarbeiten und Daten aus externen Quellen transformieren
32-
</Step>
33-
<Step>
34-
<strong>Integration von Drittanbieter-Plattformen</strong>: Verbindung mit Diensten wie Stripe, Slack oder benutzerdefinierten APIs
35-
</Step>
36-
<Step>
37-
<strong>Authentifizierung verwalten</strong>: Unterstützung verschiedener Authentifizierungsmethoden einschließlich Bearer-Tokens und API-Schlüssel
38-
</Step>
39-
</Steps>
40-
41-
## Funktionsweise
42-
43-
Der API-Block verarbeitet HTTP-Anfragen durch einen strukturierten Ansatz:
44-
45-
1. **Anfrage konfigurieren** - URL, Methode, Header und Body-Parameter festlegen
46-
2. **Anfrage ausführen** - HTTP-Anfrage an den angegebenen Endpunkt senden
47-
3. **Antwort verarbeiten** - Antwortdaten, Statuscodes und Header verarbeiten
48-
4. **Fehlerbehandlung** - Timeouts, Wiederholungsversuche und Fehlerbedingungen verwalten
49-
5022
## Konfigurationsoptionen
5123

5224
### URL
@@ -145,58 +117,12 @@ if (<api.status> === 200) {
145117
}
146118
```
147119

148-
## Eingaben und Ausgaben
149-
150-
<Tabs items={['Configuration', 'Variables', 'Results']}>
151-
<Tab>
152-
<ul className="list-disc space-y-2 pl-6">
153-
<li>
154-
<strong>URL</strong>: Der Endpunkt, an den die Anfrage gesendet werden soll
155-
</li>
156-
<li>
157-
<strong>Method</strong>: HTTP-Methode (GET, POST, PUT, DELETE, PATCH)
158-
</li>
159-
<li>
160-
<strong>Query Parameters</strong>: Schlüssel-Wert-Paare für URL-Parameter
161-
</li>
162-
<li>
163-
<strong>Headers</strong>: HTTP-Header für Authentifizierung und Inhaltstyp
164-
</li>
165-
<li>
166-
<strong>Body</strong>: Anfrage-Payload für POST/PUT/PATCH-Methoden
167-
</li>
168-
</ul>
169-
</Tab>
170-
<Tab>
171-
<ul className="list-disc space-y-2 pl-6">
172-
<li>
173-
<strong>api.data</strong>: Antwortdaten vom API-Aufruf
174-
</li>
175-
<li>
176-
<strong>api.status</strong>: Vom Server zurückgegebener HTTP-Statuscode
177-
</li>
178-
<li>
179-
<strong>api.headers</strong>: Antwort-Header vom Server
180-
</li>
181-
<li>
182-
<strong>api.error</strong>: Fehlerdetails, falls die Anfrage fehlgeschlagen ist
183-
</li>
184-
</ul>
185-
</Tab>
186-
<Tab>
187-
<ul className="list-disc space-y-2 pl-6">
188-
<li>
189-
<strong>Response Data</strong>: Primärer API-Antwortinhalt
190-
</li>
191-
<li>
192-
<strong>Status Information</strong>: HTTP-Status und Fehlerdetails
193-
</li>
194-
<li>
195-
<strong>Access</strong>: Verfügbar in Blöcken nach dem API-Aufruf
196-
</li>
197-
</ul>
198-
</Tab>
199-
</Tabs>
120+
## Ausgaben
121+
122+
- **`<api.data>`**: Antwortdaten vom API-Aufruf
123+
- **`<api.status>`**: HTTP-Statuscode
124+
- **`<api.headers>`**: Antwort-Header
125+
- **`<api.error>`**: Fehlerdetails, falls die Anfrage fehlgeschlagen ist
200126

201127
## Beispielanwendungsfälle
202128

‎apps/docs/content/docs/de/blocks/condition.mdx‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -20,39 +20,6 @@ Der Bedingungsblock ermöglicht es Ihnen, den Ausführungspfad Ihres Workflows b
2020
/>
2121
</div>
2222

23-
<Callout>
24-
Bedingungsblöcke ermöglichen deterministische Entscheidungsfindung ohne ein LLM zu benötigen, was sie ideal
25-
für unkomplizierte Verzweigungslogik macht.
26-
</Callout>
27-
28-
## Überblick
29-
30-
Der Bedingungsblock ermöglicht Ihnen:
31-
32-
<Steps>
33-
<Step>
34-
<strong>Verzweigungslogik erstellen</strong>: Workflows basierend auf booleschen Ausdrücken leiten
35-
</Step>
36-
<Step>
37-
<strong>Datengesteuerte Entscheidungen treffen</strong>: Bedingungen anhand von Ausgaben vorheriger Blöcke auswerten
38-
</Step>
39-
<Step>
40-
<strong>Mehrere Szenarien behandeln</strong>: Mehrere Bedingungen mit unterschiedlichen Pfaden definieren
41-
</Step>
42-
<Step>
43-
<strong>Deterministische Weiterleitung bieten</strong>: Entscheidungen ohne ein LLM treffen
44-
</Step>
45-
</Steps>
46-
47-
## Funktionsweise
48-
49-
Der Bedingungsblock arbeitet durch einen sequentiellen Auswertungsprozess:
50-
51-
1. **Ausdruck auswerten** - Verarbeitet den JavaScript/TypeScript-booleschen Ausdruck mit aktuellen Workflow-Daten
52-
2. **Ergebnis bestimmen** - Gibt basierend auf der Ausdrucksauswertung true oder false zurück
53-
3. **Workflow weiterleiten** - Leitet die Ausführung basierend auf dem Ergebnis an den entsprechenden Zielblock weiter
54-
4. **Kontext bereitstellen** - Generiert Metadaten über die Entscheidung für Debugging und Überwachung
55-
5623
## Konfigurationsoptionen
5724

5825
### Bedingungen

‎apps/docs/content/docs/de/blocks/response.mdx‎

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -23,54 +23,6 @@ Der Antwort-Block ist der letzte Schritt in deinem Workflow, der eine strukturie
2323
Antwort-Blöcke sind terminale Blöcke - sie beenden die Workflow-Ausführung und können nicht mit anderen Blöcken verbunden werden.
2424
</Callout>
2525

26-
## Überblick
27-
28-
Der Antwort-Block ermöglicht dir:
29-
30-
<Steps>
31-
<Step>
32-
<strong>API-Antworten formatieren</strong>: Strukturierung von Workflow-Ergebnissen in korrekte HTTP-Antworten
33-
</Step>
34-
<Step>
35-
<strong>Statuscodes festlegen</strong>: Konfiguration passender HTTP-Statuscodes basierend auf Workflow-Ergebnissen
36-
</Step>
37-
<Step>
38-
<strong>Header kontrollieren</strong>: Hinzufügen benutzerdefinierter Header für API-Antworten und Webhooks
39-
</Step>
40-
<Step>
41-
<strong>Daten transformieren</strong>: Umwandlung von Workflow-Variablen in client-freundliche Antwortformate
42-
</Step>
43-
</Steps>
44-
45-
## Wie es funktioniert
46-
47-
Der Antwort-Block schließt die Workflow-Ausführung ab:
48-
49-
1. **Daten sammeln** - Sammelt Variablen und Ausgaben von vorherigen Blöcken
50-
2. **Antwort formatieren** - Strukturiert Daten gemäß deiner Konfiguration
51-
3. **HTTP-Details festlegen** - Wendet Statuscodes und Header an
52-
4. **Antwort senden** - Gibt die formatierte Antwort an den API-Aufrufer zurück
53-
54-
## Wann du Antwort-Blöcke benötigst
55-
56-
- **API-Endpunkte**: Wenn dein Workflow über eine API aufgerufen wird, formatieren Antwort-Blöcke die Rückgabedaten
57-
- **Webhooks**: Rückgabe von Bestätigungen oder Daten an das aufrufende System
58-
- **Testen**: Anzeige formatierter Ergebnisse beim Testen deines Workflows
59-
60-
## Zwei Möglichkeiten zum Erstellen von Antworten
61-
62-
### Builder-Modus (Empfohlen)
63-
Visuelle Oberfläche zum Erstellen der Antwortstruktur:
64-
- Felder per Drag-and-Drop einfügen
65-
- Einfache Referenzierung von Workflow-Variablen
66-
- Visuelle Vorschau der Antwortstruktur
67-
68-
### Editor-Modus (Fortgeschritten)
69-
JSON direkt schreiben:
70-
- Volle Kontrolle über das Antwortformat
71-
- Unterstützung für komplexe verschachtelte Strukturen
72-
- Verwendung der `<variable.name>`Syntax für dynamische Werte
73-
7426
## Konfigurationsoptionen
7527

7628
### Antwortdaten

‎apps/docs/content/docs/de/blocks/router.mdx‎

Lines changed: 12 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -21,60 +21,17 @@ Der Router-Block nutzt KI, um intelligent zu entscheiden, welchen Pfad Ihr Workf
2121
/>
2222
</div>
2323

24-
## Überblick
25-
26-
Der Router-Block ermöglicht Ihnen:
27-
28-
<Steps>
29-
<Step>
30-
<strong>Intelligentes Content-Routing</strong>: Nutzung von KI zum Verständnis von Absicht und Kontext
31-
</Step>
32-
<Step>
33-
<strong>Dynamische Pfadauswahl</strong>: Routing von Workflows basierend auf unstrukturierter Inhaltsanalyse
34-
</Step>
35-
<Step>
36-
<strong>Kontextbewusste Entscheidungen</strong>: Treffen intelligenter Routing-Entscheidungen über einfache Regeln hinaus
37-
</Step>
38-
<Step>
39-
<strong>Multi-Pfad-Management</strong>: Verwaltung komplexer Workflows mit mehreren potenziellen Zielen
40-
</Step>
41-
</Steps>
42-
43-
## Router vs. Bedingungsblöcke
44-
45-
<Accordions>
46-
<Accordion title="Wann Router verwenden">
47-
- KI-gestützte Inhaltsanalyse erforderlich
48-
- Unstrukturierte oder variierende Inhaltstypen
49-
- Absichtsbasiertes Routing (z.B. "Support-Tickets an Abteilungen weiterleiten")
50-
- Kontextbewusste Entscheidungsfindung erforderlich
51-
</Accordion>
52-
<Accordion title="Wann Bedingung verwenden">
53-
- Einfache, regelbasierte Entscheidungen
54-
- Strukturierte Daten oder numerische Vergleiche
55-
- Schnelles, deterministisches Routing erforderlich
56-
- Boolesche Logik ausreichend
57-
</Accordion>
58-
</Accordions>
59-
60-
## Funktionsweise
61-
62-
Der Router-Block:
63-
64-
<Steps>
65-
<Step>
66-
<strong>Analysiert Inhalte</strong>: Verwendet ein LLM, um Eingabeinhalte und Kontext zu verstehen
67-
</Step>
68-
<Step>
69-
<strong>Bewertet Ziele</strong>: Vergleicht Inhalte mit verfügbaren Zielblöcken
70-
</Step>
71-
<Step>
72-
<strong>Wählt Ziel aus</strong>: Identifiziert den am besten geeigneten Pfad basierend auf der Absicht
73-
</Step>
74-
<Step>
75-
<strong>Leitet Ausführung</strong>: Dirigiert den Workflow zum ausgewählten Block
76-
</Step>
77-
</Steps>
24+
## Router vs. Bedingung
25+
26+
**Router verwenden wenn:**
27+
- KI-gestützte Inhaltsanalyse erforderlich ist
28+
- Mit unstrukturiertem oder variierendem Inhalt gearbeitet wird
29+
- Absichtsbasiertes Routing erforderlich ist (z.B. "Support-Tickets an Abteilungen weiterleiten")
30+
31+
**Bedingung verwenden wenn:**
32+
- Einfache regelbasierte Entscheidungen ausreichen
33+
- Mit strukturierten Daten oder numerischen Vergleichen gearbeitet wird
34+
- Schnelles, deterministisches Routing erforderlich ist
7835

7936
## Konfigurationsoptionen
8037

@@ -105,7 +62,7 @@ Wählen Sie ein KI-Modell für die Routing-Entscheidung:
10562
**Lokale Modelle**: Jedes Modell, das auf Ollama läuft
10663

10764
<div className="w-full max-w-2xl mx-auto overflow-hidden rounded-lg">
108-
<Video src="router-model-dropdown.mp4" width={500} height={350} />
65+
<Video src="models.mp4" width={500} height={350} />
10966
</div>
11067

11168
**Empfehlung**: Verwenden Sie Modelle mit starken Reasoning-Fähigkeiten wie GPT-4o oder Claude 3.7 Sonnet für genauere Routing-Entscheidungen.
@@ -124,58 +81,6 @@ Nachdem ein Router eine Entscheidung getroffen hat, können Sie auf seine Ausgab
12481
- **`<router.cost>`**: Kostenübersicht für den Routing-Aufruf (Eingabe, Ausgabe, Gesamt)
12582
- **`<router.model>`**: Das für die Entscheidungsfindung verwendete Modell
12683

127-
## Erweiterte Funktionen
128-
129-
### Benutzerdefinierte Routing-Kriterien
130-
131-
Definieren Sie spezifische Kriterien für jeden Zielblock:
132-
133-
```javascript
134-
// Example routing descriptions
135-
Target Block 1: "Technical support issues, API problems, integration questions"
136-
Target Block 2: "Billing inquiries, subscription changes, payment issues"
137-
Target Block 3: "General questions, feedback, feature requests"
138-
```
139-
140-
## Eingaben und Ausgaben
141-
142-
<Tabs items={['Konfiguration', 'Variablen']}>
143-
<Tab>
144-
<ul className="list-disc space-y-2 pl-6">
145-
<li>
146-
<strong>Inhalt/Prompt</strong>: Zu analysierender Text für Routing-Entscheidungen
147-
</li>
148-
<li>
149-
<strong>Zielblöcke</strong>: Verbundene Blöcke als potenzielle Ziele
150-
</li>
151-
<li>
152-
<strong>Modell</strong>: KI-Modell für Routing-Analyse
153-
</li>
154-
<li>
155-
<strong>API-Schlüssel</strong>: Authentifizierung für ausgewählten LLM-Anbieter
156-
</li>
157-
</ul>
158-
</Tab>
159-
<Tab>
160-
<ul className="list-disc space-y-2 pl-6">
161-
<li>
162-
<strong>router.prompt</strong>: Zusammenfassung des verwendeten Routing-Prompts
163-
</li>
164-
<li>
165-
<strong>router.selected_path</strong>: Details zum gewählten Ziel
166-
</li>
167-
<li>
168-
<strong>router.tokens</strong>: Token-Nutzungsstatistiken
169-
</li>
170-
<li>
171-
<strong>router.cost</strong>: Kostenübersicht für den Routing-Aufruf (Eingabe, Ausgabe, Gesamt)
172-
</li>
173-
<li>
174-
<strong>router.model</strong>: Für die Entscheidungsfindung verwendetes Modell
175-
</li>
176-
</ul>
177-
</Tab>
178-
</Tabs>
17984

18085
## Beispielanwendungsfälle
18186

‎apps/docs/content/docs/de/blocks/wait.mdx‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,6 @@ Der Warten-Block pausiert deinen Workflow für eine bestimmte Zeit, bevor er mit
1818
/>
1919
</div>
2020

21-
## Übersicht
22-
23-
Mit dem Warten-Block kannst du:
24-
25-
<Steps>
26-
<Step>
27-
<strong>Zeitverzögerungen hinzufügen</strong>: Ausführung zwischen Workflow-Schritten pausieren
28-
</Step>
29-
<Step>
30-
<strong>Ratenbegrenzungen einhalten</strong>: API-Aufrufe zeitlich verteilen, um innerhalb der Limits zu bleiben
31-
</Step>
32-
<Step>
33-
<strong>Sequenzen planen</strong>: Zeitgesteuerte Workflows mit Verzögerungen zwischen Aktionen erstellen
34-
</Step>
35-
</Steps>
36-
3721
## Konfiguration
3822

3923
### Wartezeit

‎apps/docs/content/docs/de/execution/basics.mdx‎

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -77,29 +77,6 @@ Sim bietet verschiedene Arten von Blöcken, die spezifische Zwecke in Ihren Work
7777

7878
Alle Blöcke werden automatisch basierend auf ihren Abhängigkeiten ausgeführt - Sie müssen die Ausführungsreihenfolge oder das Timing nicht manuell verwalten.
7979

80-
## Ausführungsauslöser
81-
82-
Workflows können auf verschiedene Weise ausgelöst werden, abhängig von Ihrem Anwendungsfall:
83-
84-
### Manuelles Testen
85-
Klicken Sie im Workflow-Editor auf "Ausführen", um Ihren Workflow während der Entwicklung zu testen. Perfekt für Debugging und Validierung.
86-
87-
### Geplante Ausführung
88-
Richten Sie wiederkehrende Ausführungen mit Cron-Ausdrücken ein. Ideal für regelmäßige Datenverarbeitung, Berichte oder Wartungsaufgaben.
89-
90-
### API-Bereitstellung
91-
Stellen Sie Workflows als HTTP-Endpunkte bereit, die programmatisch von Ihren Anwendungen aufgerufen werden können.
92-
93-
### Webhook-Integration
94-
Reagieren Sie in Echtzeit auf Ereignisse von externen Diensten wie GitHub, Stripe oder benutzerdefinierten Systemen.
95-
96-
### Chat-Schnittstelle
97-
Erstellen Sie Konversationsschnittstellen, die auf benutzerdefinierten Subdomains für benutzerorientierte KI-Anwendungen gehostet werden.
98-
99-
<Callout type="info">
100-
Erfahren Sie mehr über jeden Auslösertyp im [Abschnitt Auslöser](/triggers) der Dokumentation.
101-
</Callout>
102-
10380
## Ausführungsüberwachung
10481

10582
Wenn Workflows ausgeführt werden, bietet Sim Echtzeit-Einblick in den Ausführungsprozess:

‎apps/docs/content/docs/de/execution/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Alle öffentlichen Einstiegspunkte—API, Chat, Zeitplan, Webhook und manuelle A
9696

9797
<div className='flex justify-center my-6'>
9898
<Image
99-
src='/static/execution/deployment-versions-light.png'
99+
src='/static/execution/deployment-versions.png'
100100
alt='Tabelle mit Deployment-Versionen'
101101
width={500}
102102
height={280}

0 commit comments

Comments
 (0)