Skip to content

Commit ac2510e

Browse files
chore: updated content
1 parent 79a8e02 commit ac2510e

Some content is hidden

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

50 files changed

+2502
-643
lines changed

apps/docs/content/docs/de/blocks/index.mdx

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: Die Bausteine deiner KI-Workflows
66
import { Card, Cards } from 'fumadocs-ui/components/card'
77
import { Step, Steps } from 'fumadocs-ui/components/steps'
88
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
9+
import { Callout } from 'fumadocs-ui/components/callout'
910
import { Video } from '@/components/ui/video'
11+
import { FAQ } from '@/components/ui/faq'
1012

1113
Blöcke sind die Bausteine, die du miteinander verbindest, um KI-Workflows zu erstellen. Betrachte sie als spezialisierte Module, die jeweils eine bestimmte Aufgabe übernehmen – vom Chatten mit KI-Modellen über API-Aufrufe bis hin zur Datenverarbeitung.
1214

@@ -22,6 +24,7 @@ Sim bietet wesentliche Blocktypen, die die Kernfunktionen von KI-Workflows abdec
2224
- **[Agent](/blocks/agent)** - Chatte mit KI-Modellen (OpenAI, Anthropic, Google, lokale Modelle)
2325
- **[Function](/blocks/function)** - Führe benutzerdefinierten JavaScript/TypeScript-Code aus
2426
- **[API](/blocks/api)** - Verbinde dich mit externen Diensten über HTTP-Anfragen
27+
- **[Memory](/blocks/memory)** - Speichere und rufe Gesprächsgedächtnisse für KI-Agenten ab
2528

2629
### Logikblöcke
2730
- **[Condition](/blocks/condition)** - Verzweige Workflow-Pfade basierend auf booleschen Ausdrücken
@@ -35,6 +38,38 @@ Sim bietet wesentliche Blocktypen, die die Kernfunktionen von KI-Workflows abdec
3538

3639
### Ausgabeblöcke
3740
- **[Antwort](/blocks/response)** - Formatieren und Zurückgeben der endgültigen Ergebnisse aus Ihrem Workflow
41+
- **[Webhook (ausgehend)](/blocks/webhook-request)** - HTTP POST-Anfragen an externe Webhooks mit optionaler HMAC-Signatur versenden
42+
43+
### Dokumentations- & Utility-Blöcke
44+
- **[Notiz](/blocks/note)** - Kontextbezogene Anmerkungen und Anweisungen direkt auf der Workflow-Leinwand hinzufügen
45+
46+
## Den richtigen Block auswählen
47+
48+
| Ich möchte... | Verwende diesen Block |
49+
|---|---|
50+
| Mit einem KI-Modell chatten oder LLM-Antworten erhalten | [Agent](/blocks/agent) |
51+
| Benutzerdefinierten JavaScript- oder Python-Code ausführen | [Function](/blocks/function) |
52+
| Eine externe REST-API aufrufen | [API](/blocks/api) |
53+
| Verzweigungen basierend auf Wahr/Falsch-Bedingungen erstellen | [Condition](/blocks/condition) |
54+
| Anfragen mit KI-Urteil weiterleiten | [Router](/blocks/router) |
55+
| Inhalt bewerten oder Qualität beurteilen | [Evaluator](/blocks/evaluator) |
56+
| Menschliche Genehmigung vor dem Fortfahren erfordern | [Human in the Loop](/blocks/human-in-the-loop) |
57+
| Eine Zeitverzögerung zwischen Schritten hinzufügen | [Wait](/blocks/wait) |
58+
| Workflow-Variablen setzen oder aktualisieren | [Variables](/blocks/variables) |
59+
| Endgültige Ausgabe aus einem Workflow zurückgeben | [Response](/blocks/response) |
60+
| HTTP POST-Anfrage an Webhook versenden | [Webhook](/blocks/webhook-request) |
61+
| Einen anderen Workflow als untergeordnetes Element ausführen | [Workflow](/blocks/workflow) |
62+
| Gesprächsgedächtnis speichern/abrufen | [Memory](/blocks/memory) |
63+
| Anmerkungen oder Dokumentation auf der Leinwand hinzufügen | [Note](/blocks/note) |
64+
| Inhalt auf Sicherheit oder PII validieren | [Guardrails](/blocks/guardrails) |
65+
| Blöcke in einer Schleife ausführen | [Loop](/blocks/loop) |
66+
| Blöcke parallel ausführen | [Parallel](/blocks/parallel) |
67+
68+
<Callout type="info">
69+
Für Third-Party-Service-Integrationen (Gmail, Slack, GitHub usw.) durchsuchen Sie den [Tools & Integrations](/tools)-Katalog. Jede Integration hat ihren eigenen dedizierten Block.
70+
71+
Der [Thinking](/blocks/thinking)-Block ist für fortgeschrittene Reasoning-Workflows verfügbar, ist aber in der Standardblock-Symbolleiste verborgen.
72+
</Callout>
3873

3974
## Wie Blöcke funktionieren
4075

@@ -141,3 +176,33 @@ Jeder Blocktyp hat spezifische Konfigurationsoptionen:
141176
Workflow-Ausführung für bestimmte Zeitverzögerungen pausieren
142177
</Card>
143178
</Cards>
179+
180+
## Block-Versionen
181+
182+
Während sich Sim weiterentwickelt, erhalten Blöcke Updates und Verbesserungen. Um die Rückwärtskompatibilität zu gewährleisten, werden bedeutende Updates neue Versionen von Blöcken (v2, v3 usw.) anstelle von Ersetzungen erstellen.
183+
184+
### Wie Versionierung funktioniert
185+
186+
Wenn ein Block größere Feature-Updates oder API-Änderungen erhält, wird eine neue Version mit einem Versionsufffix erstellt (z. B. wird `file` zu `file_v2`). Die ursprüngliche Version bleibt für bestehende Workflows verfügbar.
187+
188+
### Welche Version sollte verwendet werden
189+
190+
- **Neue Workflows**: Copilot wählt automatisch die neueste Version beim Aufbau von Workflows aus
191+
- **Bestehende Workflows**: Verwenden Sie weiterhin die Version, mit der sie erstellt wurden – es sind keine Änderungen erforderlich, es sei denn, Sie aktualisieren explizit
192+
- **Manuelle Upgrades**: Sie können einen Block auf eine neuere Version aktualisieren, indem Sie die Workflow-Konfiguration bearbeiten
193+
194+
### Versionierte Blöcke
195+
196+
Die folgenden Blöcke haben mehrere verfügbare Versionen:
197+
198+
Confluence (v2) · Cursor (v2) · File (v2, v3) · Fireflies (v2) · GitHub (v2) · Gmail (v2) · Google Calendar (v2) · Google Sheets (v2) · Google Slides (v2) · Intercom (v2) · Kalshi (v2) · Microsoft Excel (v2) · Mistral Parse (v2, v3) · Notion (v2) · Pulse (v2) · Reducto (v2) · Router (v2) · Speech-to-Text (v2) · Textract (v2) · Video Generator (v2) · Vision (v2)
199+
200+
<FAQ items={[
201+
{ question: "Wie viele Block-Typen sind in Sim verfügbar?", answer: "Sim hat über 190 Blöcke in seiner Registry, die Kern-Workflow-Blöcke (Agent, Function, Condition, Router usw.), Integrations-Blöcke für Third-Party-Dienste (Gmail, Slack, GitHub, Notion und viele weitere) sowie Trigger-Blöcke umfassen, die Workflows von externen Ereignissen wie Webhooks oder Zeitplänen starten. Loop und Parallel-Ausführung sind als Container-Konstrukte auf der Leinwand in die Ausführungs-Engine integriert, anstatt eigenständige Registry-Blöcke zu sein." },
202+
{ question: "Kann die Ausgabe eines Blocks mit mehreren nachgelagerten Blöcken verbunden werden?", answer: "Ja. Ein einzelner Ausgabeport kann mit mehreren Eingabeports auf verschiedenen Blöcken verbunden werden. Dies ermöglicht es Ihnen, Daten von einem Verarbeitungsschritt auf mehrere parallele Pfade zu verteilen, ohne den Block duplizieren zu müssen." },
203+
{ question: "Was passiert, wenn ein Block in der Mitte eines Workflows fehlschlägt?", answer: "Wenn ein Block auf einen Fehler trifft, stoppt der Workflow die Ausführung entlang dieses Pfads. Blöcke, die Fehlerbehandlung unterstützen (wie der Router), können zu einem Fehlerpfad weiterleiten, damit Sie Fehler elegant behandeln können, anstatt den gesamten Workflow zu unterbrechen." },
204+
{ question: "Was ist der Unterschied zwischen Verarbeitungs- und Logikblöcken?", answer: "Verarbeitungsblöcke (Agent, Function, API) transformieren oder generieren Daten – sie führen die eigentliche Arbeit aus. Logikblöcke (Condition, Router, Evaluator) treffen Entscheidungen darüber, welchen Pfad der Workflow basierend auf den Daten einschlagen sollte, ohne die Daten selbst zu verändern." },
205+
{ question: "Kann ich Blöcke aus verschiedenen Kategorien zusammen in einem Workflow verwenden?", answer: "Absolut. Ein typischer Workflow kombiniert Blöcke aus mehreren Kategorien. Sie könnten beispielsweise einen Trigger-Block verwenden, um den Workflow zu starten, einen Agent-Block zur Verarbeitung von Eingaben, einen Condition-Block zur Verzweigung der Logik und einen Integrations-Block wie Gmail, um Ergebnisse zu senden." },
206+
{ question: "Gibt es Container-Blöcke, die andere Blöcke darin halten können?", answer: "Ja. Loop und Parallel sind Ausführungs-Engine-Konstrukte, die als Container-Bereiche auf der Leinwand erscheinen. Sie ziehen andere Blöcke darin ein. Loop-Container führen ihre enthaltenen Blöcke wiederholt aus, während Parallel-Container ihre enthaltenen Blöcke gleichzeitig über mehrere Branches ausführen. Im Gegensatz zu Registry-Blöcken werden diese direkt von der Ausführungs-Engine behandelt." },
207+
]} />
208+
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: Memory
3+
---
4+
5+
import { Callout } from 'fumadocs-ui/components/callout'
6+
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
7+
import { Image } from '@/components/ui/image'
8+
import { FAQ } from '@/components/ui/faq'
9+
10+
Der Memory-Block speichert und ruft Gesprächsgedächtnisse für KI-Agenten ab. Er ermöglicht es dir, Gesprächseinträge hinzuzufügen, abzurufen, zu aktualisieren und zu löschen, was statushafte Multi-Turn-Interaktionen über die integrierten Speichermodi des Agent-Blocks hinaus ermöglicht.
11+
12+
<div className="flex justify-center">
13+
<Image
14+
src="/static/blocks/memory.png"
15+
alt="Memory Block Configuration"
16+
width={500}
17+
height={400}
18+
className="my-6"
19+
/>
20+
</div>
21+
22+
<Callout type="warning">
23+
Verwende den Memory-Block nicht, es sei denn, er wird explizit benötigt. Für natürliche Gespräche verwendest du die integrierten Speichermodi des Agent-Blocks (Conversation, Sliding Window by messages oder Sliding Window by tokens). Der Memory-Block ist für das Einfügen von künstlichem Gedächtnis in Workflows gedacht, wenn die native Speicherbehandlung des Agent-Blocks unzureichend ist.
24+
</Callout>
25+
26+
## Konfigurationsoptionen
27+
28+
### Operation
29+
30+
Wählen Sie die Memory-Operation aus, die ausgeführt werden soll:
31+
32+
- **Add Memory**: Füge eine neue Nachricht zum Gesprächsgedächtnis hinzu
33+
- **Get Memory**: Rufe einen bestimmten Memory-Eintrag nach seiner ID ab
34+
- **Get All Memories**: Rufe alle Memories für ein Gespräch ab
35+
- **Delete Memory**: Entferne einen Memory-Eintrag aus dem Speicher
36+
37+
### Conversation ID
38+
39+
Der eindeutige Bezeichner für das Gespräch. Dieser Schlüssel behält das Gedächtnis über Workflow-Ausführungen bei und ermöglicht die Kontextfreigabe zwischen mehreren Ausführungen.
40+
41+
- **Erforderlich**: Ja
42+
- **Typ**: String
43+
- **Beispiel**: `chat-session-123`, `user-456`, `conversation-abc`
44+
45+
### Role (nur Add Memory)
46+
47+
Gibt die Sprecherrolle für den Memory-Eintrag an, wenn du die Operation "Add Memory" verwendest:
48+
49+
- **user**: Nachricht vom Endbenutzer
50+
- **assistant**: Nachricht vom KI-Modell
51+
- **system**: System-Level-Anweisung oder Kontext
52+
53+
### Content (nur Add Memory)
54+
55+
Der Nachrichteninhalt, der gespeichert werden soll, wenn du die Operation "Add Memory" verwendest:
56+
57+
- **Typ**: String (Markdown unterstützt)
58+
- **Maximale Länge**: Keine harte Grenze, aber halten Sie es angemessen groß für die Leistung
59+
60+
## Outputs
61+
62+
- **`<memory.memories>`**: JSON-Array aller Memories im Gespräch (für Get All Memories)
63+
- **`<memory.memory>`**: Der spezifische Memory-Eintrag, der abgerufen wurde (für Get Memory)
64+
- **`<memory.success>`**: Boolean, der anzeigt, ob die Operation erfolgreich abgeschlossen wurde
65+
- **`<memory.id>`**: Die Gesprächs-ID, die für die Operation verwendet wurde
66+
67+
## Beispiel-Anwendungsfälle
68+
69+
**Multi-Turn-Gespräch mit Kontextsicherung**
70+
```
71+
User Input → Memory (Get All) → Agent (w/ history) → Memory (Add user msg) → Agent → Memory (Add assistant msg) → Response
72+
```
73+
74+
**Aufbau persistenter Benutzerprofile**
75+
```
76+
API (User Data) → Memory (Add) → Agent (Enhanced w/ user context) → API (Update Profile)
77+
```
78+
79+
**Gesprächsanalyse**
80+
```
81+
Trigger (Scheduled) → Memory (Get All, conversationId) → Function (Analyze sentiment) → API (Log analytics)
82+
```
83+
84+
## Best Practices
85+
86+
- **Verwende zuerst das Agent-Gedächtnis**: Die integrierten Speichermodi des Agent-Blocks handhaben die meisten Gesprächsszenarien ohne den Memory-Block
87+
- **Verwalte das Gedächtnis-Wachstum**: Bereinige regelmäßig alte Memories, um übermäßigen Speicher und langsame Abrufe zu vermeiden
88+
- **Konsistente Gesprächs-IDs**: Verwende aussagekräftige, konsistente IDs, um sicherzustellen, dass Memories richtig gruppiert und abrufbar sind
89+
- **Kombiniere mit Agent-Block**: Für beste Ergebnisse verwendest du Memory neben dem Agent-Block, um vollständigen Gesprächskontext zu erstellen
90+
91+
<FAQ items={[
92+
{ question: "Wann sollte ich den Memory-Block verwenden, wenn dem Agent-Gedächtnis Modus vorziehen?", answer: "Verwende die integrierten Speichermodi des Agent-Blocks (Conversation, Sliding Window by messages, Sliding Window by tokens) für standardmäßige Multi-Turn-Gespräche – sie sind einfacher und handhaben die meisten Fälle. Verwende den Memory-Block nur, wenn du explizite Kontrolle über Memory-Operationen benötigst, wie das Einfügen von künstlicher Gesprächshistorie, das Verwalten von Memories außerhalb von Agent-Aufrufen oder das Erstellen von benutzerdefinierter Gesprächslogik." },
93+
{ question: "Kann ich Memories zwischen verschiedenen Agenten teilen?", answer: "Ja. Durch die Verwendung derselben Gesprächs-ID über mehrere Agent- und Memory-Blöcke hinweg kannst du Gesprächshistorie und Kontext zwischen verschiedenen Agenten im selben Workflow teilen." },
94+
{ question: "Was passiert, wenn ich Memory mit demselben Inhalt zweimal hinzufüge?", answer: "Doppelte Einträge sind zulässig. Jeder Aufruf zu Add Memory erstellt einen neuen Eintrag, auch wenn der Inhalt identisch ist. Wenn du Duplikate verhindern möchtest, füge Deduplizierungslogik in vorgelagerten Blöcken hinzu (z. B. einen Function-Block)." },
95+
{ question: "Bleiben Memories über Workflow-Ausführungen hinweg erhalten?", answer: "Ja. Memories werden im Backend gespeichert und bleiben über mehrere Workflow-Ausführungen bestehen, solange du dieselbe Gesprächs-ID verwendest. Dies ermöglicht statushafte Interaktionen im Laufe der Zeit." },
96+
{ question: "Kann ich einen spezifischen Memory-Eintrag löschen?", answer: "Ja. Verwende die Delete Memory-Operation mit der Gesprächs-ID. Wenn du bestimmte Einträge löschen möchtest, musst du möglicherweise alle Memories abrufen, sie in einem Function-Block filtern und Einträge selektiv löschen." },
97+
{ question: "Wie incluye ich Gesprächshistorie in einen Agent-Prompt?", answer: "Verwende Memory (Get All), um alle Memories für das Gespräch abzurufen, dann übergibe die Ergebnisse an den Agent-Block. Du kannst die Memories im System-Prompt oder Benutzer-Prompt als Kontext für den Agenten einfügen, den er berücksichtigen sollte." },
98+
]} />
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Notiz
3+
---
4+
5+
import { Callout } from 'fumadocs-ui/components/callout'
6+
import { Image } from '@/components/ui/image'
7+
import { FAQ } from '@/components/ui/faq'
8+
9+
Der Notiz-Block fügt kontextbezogene Anmerkungen direkt auf deine Workflow-Leinwand ein. Verwende ihn, um Entscheidungen zu dokumentieren, Anweisungen zu teilen oder kolaborativen Kontext zu hinterlassen, ohne die Workflow-Ausführung zu beeinflussen.
10+
11+
<div className="flex justify-center">
12+
<Image
13+
src="/static/blocks/note.png"
14+
alt="Note Block Configuration"
15+
width={500}
16+
height={400}
17+
className="my-6"
18+
/>
19+
</div>
20+
21+
<Callout type="info">
22+
Notiz-Blöcke sind ausschließlich für Dokumentation und Zusammenarbeit – sie werden nicht während Workflow-Ausführungen ausgeführt und beeinflussen nicht die Workflow-Logik oder Ausgabe.
23+
</Callout>
24+
25+
## Konfigurationsoptionen
26+
27+
### Content
28+
29+
Der Notizeninhalt, der auf der Leinwand angezeigt wird. Notizen unterstützen vollständiges Markdown-Rendering, einschließlich:
30+
31+
- **Textformatierung**: Fett, Kursiv, Links, Inline-Code
32+
- **Listen**: Aufzählungspunkte und nummerierte Listen
33+
- **Code-Blöcke**: Syntaxhervorgehobene Code-Beispiele
34+
- **Überschriften**: Mehrere Überschriftsebenen für Organisation
35+
- **YouTube-Einbettungen**: Embed-Videos direkt mit Standard-Embed-Syntax
36+
- **Block-Referenzen**: Verlinke andere Blöcke im Workflow mit Blocknamen
37+
38+
### Markdown-Beispiel
39+
40+
```markdown
41+
## Verarbeitungsstrategie
42+
43+
Dieser Workflow behandelt Kundenservice-Tickets mit:
44+
1. Route nach Absicht (FAQ vs. Eskalation)
45+
2. Generiere Antwort mit Agent
46+
3. Protokolliere in Datenbank für Analytik
47+
48+
**Wichtig**: Ticketnummer immer in Antwort einschließen.
49+
50+
[Mehr Informationen](https://docs.example.com)
51+
```
52+
53+
## Anwendungsfälle
54+
55+
**Dokumentation von Workflow-Entscheidungen**
56+
```
57+
Füge eine Notiz hinzu, die erklärt, warum spezifische Routing-Logik verwendet wird, Geschäftsregeln oder Entscheidungspunkte, die andere Teamkollegen verstehen sollten
58+
```
59+
60+
**Anweisungen für Mitarbeiter**
61+
```
62+
Hinterlasse Notizen mit Setup-Anweisungen, Konfigurationsanforderungen oder Voraussetzungen vor bestimmten Blöcken
63+
```
64+
65+
**Eingebettete Lernressourcen**
66+
```
67+
Füge Links zu Dokumentation, YouTube-Tutorials oder Beispielen ein, die neuen Teamkollegen helfen, den Workflow zu verstehen
68+
```
69+
70+
## Best Practices
71+
72+
- **Halte Notizen prägnant**: Verwende Notizen zur Ergänzung, nicht zum Ersetzen klarer Workflow-Gestaltung. Wenn du umfangreiche Dokumentation schreibst, ziehe externe Ressourcen in Betracht
73+
- **Aktualisiere bei Workflow-Änderungen**: Wenn du Workflow-Logik änderst, aktualisiere zugehörige Notizen, um die Änderungen widerzuspiegeln
74+
- **Verwende zur Team-Kommunikation**: Notizen sind für alle Mitarbeiter sichtbar – verwende sie, um nicht-offensichtliche Designentscheidungen zu erklären
75+
- **Verlinke zu Ressourcen**: Füge Links zu externer Dokumentation, FAQs oder Entscheidungsprotokollen für mehr Kontext ein
76+
77+
<FAQ items={[
78+
{ question: "Beeinflussen Notiz-Blöcke die Workflow-Ausführung?", answer: "Nein. Notiz-Blöcke sind ausschließlich für Dokumentation und Visualisierung auf der Leinwand. Sie werden nicht ausgeführt, beeinflussen die Workflow-Logik nicht und produzieren keine Ausgaben." },
79+
{ question: "Kann ich Text in einem Notiz-Block formatieren?", answer: "Ja. Notiz-Blöcke unterstützen vollständige Markdown-Syntax einschließlich Fett, Kursiv, Listen, Code-Blöcke, Überschriften, Links und Bilder. Du kannst auch YouTube-Videos mit Standard-Embed-Syntax einbetten." },
80+
{ question: "Kann ich Referenzen zu anderen Blöcken in einer Notiz einfügen?", answer: "Ja. Du kannst Blöcke nach Namen in deinem Markdown referenzieren. Du kannst auch auf externe Ressourcen mit Standard-Markdown-Link-Syntax verlinken." },
81+
{ question: "Sind Notizen für alle Mitarbeiter sichtbar?", answer: "Ja. Notizen sind Teil der Workflow-Leinwand und sind für alle sichtbar, die Zugriff auf den Workflow haben." },
82+
{ question: "Kann ich Notizen in Loop- oder Parallel-Blöcke verschachteln?", answer: "Ja. Notizen können überall auf der Leinwand platziert werden, einschließlich innerhalb von Container-Blöcken wie Loop und Parallel, um Kontext für diese Bereiche zu geben." },
83+
{ question: "Wie lang darf eine Notiz maximal sein?", answer: "Es gibt keine strikte Maximallänge. Für Lesbarkeit und Leistung halte Notizen jedoch angemessen groß. Wenn du umfangreich dokumentieren musst, erwäge die Verwendung externer Dokumentation, auf die von der Notiz verlinkt wird." },
84+
]} />

0 commit comments

Comments
 (0)