Skip to content

Commit a843776

Browse files
waleedlatif1waleedlatif1
authored
feat(i18n): update translations
1 parent f147eae commit a843776

File tree

258 files changed

+4245
-924
lines changed

Some content is hidden

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

258 files changed

+4245
-924
lines changed

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

Lines changed: 317 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,317 @@
1+
---
2+
title: Guardrails
3+
---
4+
5+
import { Callout } from 'fumadocs-ui/components/callout'
6+
import { Step, Steps } from 'fumadocs-ui/components/steps'
7+
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
8+
import { Image } from '@/components/ui/image'
9+
import { Video } from '@/components/ui/video'
10+
11+
Der Guardrails-Block validiert und schützt Ihre KI-Workflows, indem er Inhalte anhand mehrerer Validierungstypen überprüft. Stellen Sie die Datenqualität sicher, verhindern Sie Halluzinationen, erkennen Sie personenbezogene Daten und setzen Sie Formatanforderungen durch, bevor Inhalte durch Ihren Workflow fließen.
12+
13+
<div className="flex justify-center">
14+
<Image
15+
src="/static/blocks/guardrails.png"
16+
alt="Guardrails-Block"
17+
width={500}
18+
height={350}
19+
className="my-6"
20+
/>
21+
</div>
22+
23+
## Übersicht
24+
25+
Mit dem Guardrails-Block können Sie:
26+
27+
<Steps>
28+
<Step>
29+
<strong>JSON-Struktur validieren</strong>: Stellen Sie sicher, dass LLM-Ausgaben gültiges JSON sind, bevor sie geparst werden
30+
</Step>
31+
<Step>
32+
<strong>Regex-Muster abgleichen</strong>: Überprüfen Sie, ob Inhalte bestimmten Formaten entsprechen (E-Mails, Telefonnummern, URLs usw.)
33+
</Step>
34+
<Step>
35+
<strong>Halluzinationen erkennen</strong>: Verwenden Sie RAG + LLM-Scoring, um KI-Ausgaben anhand von Wissensdatenbankinhalten zu validieren
36+
</Step>
37+
<Step>
38+
<strong>PII erkennen</strong>: Identifizieren und optional maskieren Sie personenbezogene Daten über 40+ Entitätstypen hinweg
39+
</Step>
40+
</Steps>
41+
42+
## Validierungstypen
43+
44+
### JSON-Validierung
45+
46+
Überprüft, ob Inhalte korrekt formatiertes JSON sind. Perfekt, um sicherzustellen, dass strukturierte LLM-Ausgaben sicher geparst werden können.
47+
48+
**Anwendungsfälle:**
49+
- Validieren von JSON-Antworten aus Agent-Blöcken vor dem Parsen
50+
- Sicherstellen, dass API-Payloads korrekt formatiert sind
51+
- Überprüfen der Integrität strukturierter Daten
52+
53+
**Ausgabe:**
54+
- `passed`: `true` bei gültigem JSON, sonst `false`
55+
- `error`: Fehlermeldung bei fehlgeschlagener Validierung (z.B. "Ungültiges JSON: Unerwartetes Token...")
56+
57+
### Regex-Validierung
58+
59+
Prüft, ob Inhalte einem bestimmten regulären Ausdrucksmuster entsprechen.
60+
61+
**Anwendungsfälle:**
62+
- Validieren von E-Mail-Adressen
63+
- Überprüfen von Telefonnummernformaten
64+
- Verifizieren von URLs oder benutzerdefinierten Kennungen
65+
- Durchsetzen spezifischer Textmuster
66+
67+
**Konfiguration:**
68+
- **Regex-Muster**: Der reguläre Ausdruck, der abgeglichen werden soll (z.B. `^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}---
69+
title: Guardrails
70+
---
71+
72+
import { Callout } from 'fumadocs-ui/components/callout'
73+
import { Step, Steps } from 'fumadocs-ui/components/steps'
74+
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
75+
import { Image } from '@/components/ui/image'
76+
import { Video } from '@/components/ui/video'
77+
78+
Der Guardrails-Block validiert und schützt Ihre KI-Workflows, indem er Inhalte anhand mehrerer Validierungstypen überprüft. Stellen Sie die Datenqualität sicher, verhindern Sie Halluzinationen, erkennen Sie personenbezogene Daten und setzen Sie Formatanforderungen durch, bevor Inhalte durch Ihren Workflow fließen.
79+
80+
<div className="flex justify-center">
81+
<Image
82+
src="/static/blocks/guardrails.png"
83+
alt="Guardrails-Block"
84+
width={500}
85+
height={350}
86+
className="my-6"
87+
/>
88+
</div>
89+
90+
## Übersicht
91+
92+
Mit dem Guardrails-Block können Sie:
93+
94+
<Steps>
95+
<Step>
96+
<strong>JSON-Struktur validieren</strong>: Stellen Sie sicher, dass LLM-Ausgaben gültiges JSON sind, bevor sie geparst werden
97+
</Step>
98+
<Step>
99+
<strong>Regex-Muster abgleichen</strong>: Überprüfen Sie, ob Inhalte bestimmten Formaten entsprechen (E-Mails, Telefonnummern, URLs usw.)
100+
</Step>
101+
<Step>
102+
<strong>Halluzinationen erkennen</strong>: Verwenden Sie RAG + LLM-Scoring, um KI-Ausgaben anhand von Wissensdatenbankinhalten zu validieren
103+
</Step>
104+
<Step>
105+
<strong>PII erkennen</strong>: Identifizieren und optional maskieren Sie personenbezogene Daten über 40+ Entitätstypen hinweg
106+
</Step>
107+
</Steps>
108+
109+
## Validierungstypen
110+
111+
### JSON-Validierung
112+
113+
Überprüft, ob Inhalte korrekt formatiertes JSON sind. Perfekt, um sicherzustellen, dass strukturierte LLM-Ausgaben sicher geparst werden können.
114+
115+
**Anwendungsfälle:**
116+
- Validieren von JSON-Antworten aus Agent-Blöcken vor dem Parsen
117+
- Sicherstellen, dass API-Payloads korrekt formatiert sind
118+
- Überprüfen der Integrität strukturierter Daten
119+
120+
**Ausgabe:**
121+
- `passed`: `true` bei gültigem JSON, sonst `false`
122+
- `error`: Fehlermeldung bei fehlgeschlagener Validierung (z.B. "Ungültiges JSON: Unerwartetes Token...")
123+
124+
### Regex-Validierung
125+
126+
Prüft, ob Inhalte einem bestimmten regulären Ausdrucksmuster entsprechen.
127+
128+
**Anwendungsfälle:**
129+
- Validieren von E-Mail-Adressen
130+
- Überprüfen von Telefonnummernformaten
131+
- Verifizieren von URLs oder benutzerdefinierten Kennungen
132+
- Durchsetzen spezifischer Textmuster
133+
134+
**Konfiguration:**
135+
- **Regex-Muster**: Der reguläre Ausdruck, der abgeglichen werden soll (z.B. für E-Mails)
136+
137+
**Ausgabe:**
138+
- `passed`: `true` wenn der Inhalt dem Muster entspricht, `false` andernfalls
139+
- `error`: Fehlermeldung, wenn die Validierung fehlschlägt
140+
141+
### Halluzinationserkennung
142+
143+
Verwendet Retrieval-Augmented Generation (RAG) mit LLM-Bewertung, um zu erkennen, wann KI-generierte Inhalte im Widerspruch zu Ihrer Wissensdatenbank stehen oder nicht darin begründet sind.
144+
145+
**Funktionsweise:**
146+
1. Durchsucht Ihre Wissensdatenbank nach relevantem Kontext
147+
2. Sendet sowohl die KI-Ausgabe als auch den abgerufenen Kontext an ein LLM
148+
3. LLM weist einen Konfidenzwert zu (Skala 0-10)
149+
- **0** = Vollständige Halluzination (völlig unbegründet)
150+
- **10** = Vollständig begründet (komplett durch die Wissensdatenbank gestützt)
151+
4. Validierung besteht, wenn der Wert ≥ Schwellenwert (Standard: 3)
152+
153+
**Konfiguration:**
154+
- **Wissensdatenbank**: Auswahl aus Ihren vorhandenen Wissensdatenbanken
155+
- **Modell**: LLM für die Bewertung auswählen (erfordert starke Argumentationsfähigkeit - GPT-4o, Claude 3.7 Sonnet empfohlen)
156+
- **API-Schlüssel**: Authentifizierung für den ausgewählten LLM-Anbieter (automatisch ausgeblendet für gehostete/Ollama-Modelle)
157+
- **Konfidenz-Schwellenwert**: Mindestwert zum Bestehen (0-10, Standard: 3)
158+
- **Top K** (Erweitert): Anzahl der abzurufenden Wissensdatenbank-Chunks (Standard: 10)
159+
160+
**Ausgabe:**
161+
- `passed`: `true` wenn der Konfidenzwert ≥ Schwellenwert
162+
- `score`: Konfidenzwert (0-10)
163+
- `reasoning`: Erklärung des LLM für den Wert
164+
- `error`: Fehlermeldung, wenn die Validierung fehlschlägt
165+
166+
**Anwendungsfälle:**
167+
- Validierung von Agent-Antworten anhand der Dokumentation
168+
- Sicherstellung der faktischen Richtigkeit von Kundendienstantworten
169+
- Überprüfung, ob generierte Inhalte mit dem Quellmaterial übereinstimmen
170+
- Qualitätskontrolle für RAG-Anwendungen
171+
172+
### PII-Erkennung
173+
174+
Erkennt personenbezogene Daten mit Microsoft Presidio. Unterstützt über 40 Entitätstypen in mehreren Ländern und Sprachen.
175+
176+
<div className="mx-auto w-3/5 overflow-hidden rounded-lg">
177+
<Video src="guardrails.mp4" width={500} height={350} />
178+
</div>
179+
180+
**Funktionsweise:**
181+
1. Scannt Inhalte nach PII-Entitäten mittels Mustererkennung und NLP
182+
2. Gibt erkannte Entitäten mit Positionen und Konfidenzwerten zurück
183+
3. Maskiert optional erkannte PII in der Ausgabe
184+
185+
**Konfiguration:**
186+
- **Zu erkennende PII-Typen**: Auswahl aus gruppierten Kategorien über Modal-Selektor
187+
- **Allgemein**: Personenname, E-Mail, Telefon, Kreditkarte, IP-Adresse usw.
188+
- **USA**: SSN, Führerschein, Reisepass usw.
189+
- **UK**: NHS-Nummer, Sozialversicherungsnummer
190+
- **Spanien**: NIF, NIE, CIF
191+
- **Italien**: Steuernummer, Führerschein, Umsatzsteuer-ID
192+
- **Polen**: PESEL, NIP, REGON
193+
- **Singapur**: NRIC/FIN, UEN
194+
- **Australien**: ABN, ACN, TFN, Medicare
195+
- **Indien**: Aadhaar, PAN, Reisepass, Wählernummer
196+
- **Modus**:
197+
- **Erkennen**: Nur PII identifizieren (Standard)
198+
- **Maskieren**: Erkannte PII durch maskierte Werte ersetzen
199+
- **Sprache**: Erkennungssprache (Standard: Englisch)
200+
201+
**Ausgabe:**
202+
- `passed`: `false` wenn ausgewählte PII-Typen erkannt werden
203+
- `detectedEntities`: Array erkannter PII mit Typ, Position und Konfidenz
204+
- `maskedText`: Inhalt mit maskierter PII (nur wenn Modus = "Maskieren")
205+
- `error`: Fehlermeldung bei fehlgeschlagener Validierung
206+
207+
**Anwendungsfälle:**
208+
- Blockieren von Inhalten mit sensiblen persönlichen Informationen
209+
- Maskieren von PII vor der Protokollierung oder Speicherung von Daten
210+
- Einhaltung von DSGVO, HIPAA und anderen Datenschutzbestimmungen
211+
- Bereinigung von Benutzereingaben vor der Verarbeitung
212+
213+
## Konfiguration
214+
215+
### Zu validierender Inhalt
216+
217+
Der zu validierende Eingabeinhalt. Dieser stammt typischerweise aus:
218+
- Ausgaben von Agent-Blöcken: `<agent.content>`
219+
- Ergebnisse von Funktionsblöcken: `<function.output>`
220+
- API-Antworten: `<api.output>`
221+
- Jede andere Blockausgabe
222+
223+
### Validierungstyp
224+
225+
Wählen Sie aus vier Validierungstypen:
226+
- **Gültiges JSON**: Prüfen, ob der Inhalt korrekt formatiertes JSON ist
227+
- **Regex-Übereinstimmung**: Überprüfen, ob der Inhalt einem Regex-Muster entspricht
228+
- **Halluzinationsprüfung**: Validierung gegen Wissensdatenbank mit LLM-Bewertung
229+
- **PII-Erkennung**: Erkennen und optional Maskieren personenbezogener Daten
230+
231+
## Ausgaben
232+
233+
Alle Validierungstypen liefern:
234+
235+
- **`<guardrails.passed>`**: Boolean, der angibt, ob die Validierung erfolgreich war
236+
- **`<guardrails.validationType>`**: Die Art der durchgeführten Validierung
237+
- **`<guardrails.input>`**: Die ursprüngliche Eingabe, die validiert wurde
238+
- **`<guardrails.error>`**: Fehlermeldung, wenn die Validierung fehlgeschlagen ist (optional)
239+
240+
Zusätzliche Ausgaben nach Typ:
241+
242+
**Halluzinationsprüfung:**
243+
- **`<guardrails.score>`**: Konfidenzwert (0-10)
244+
- **`<guardrails.reasoning>`**: Erklärung des LLM
245+
246+
**PII-Erkennung:**
247+
- **`<guardrails.detectedEntities>`**: Array erkannter PII-Entitäten
248+
- **`<guardrails.maskedText>`**: Inhalt mit maskierter PII (wenn Modus = "Mask")
249+
250+
## Beispielanwendungsfälle
251+
252+
### JSON vor dem Parsen validieren
253+
254+
<div className="mb-4 rounded-md border p-4">
255+
<h4 className="font-medium">Szenario: Sicherstellen, dass die Agent-Ausgabe gültiges JSON ist</h4>
256+
<ol className="list-decimal pl-5 text-sm">
257+
<li>Agent generiert strukturierte JSON-Antwort</li>
258+
<li>Guardrails validiert das JSON-Format</li>
259+
<li>Bedingungsblock prüft `<guardrails.passed>`</li>
260+
<li>Bei Erfolg → Daten parsen und verwenden, Bei Misserfolg → Wiederholen oder Fehler behandeln</li>
261+
</ol>
262+
</div>
263+
264+
### Halluzinationen verhindern
265+
266+
<div className="mb-4 rounded-md border p-4">
267+
<h4 className="font-medium">Szenario: Validierung von Kundendienstantworten</h4>
268+
<ol className="list-decimal pl-5 text-sm">
269+
<li>Agent generiert Antwort auf Kundenfrage</li>
270+
<li>Guardrails prüft anhand der Support-Dokumentationswissensbasis</li>
271+
<li>Wenn Konfidenzwert ≥ 3 → Antwort senden</li>
272+
<li>Wenn Konfidenzwert \< 3 → Für manuelle Überprüfung markieren</li>
273+
</ol>
274+
</div>
275+
276+
### PII in Benutzereingaben blockieren
277+
278+
<div className="mb-4 rounded-md border p-4">
279+
<h4 className="font-medium">Szenario: Bereinigung von benutzerübermittelten Inhalten</h4>
280+
<ol className="list-decimal pl-5 text-sm">
281+
<li>Benutzer reicht Formular mit Textinhalt ein</li>
282+
<li>Guardrails erkennt PII (E-Mails, Telefonnummern, Sozialversicherungsnummern usw.)</li>
283+
<li>Bei erkannter PII → Einreichung ablehnen oder sensible Daten maskieren</li>
284+
<li>Ohne PII → Normal verarbeiten</li>
285+
</ol>
286+
</div>
287+
288+
<div className="mx-auto w-3/5 overflow-hidden rounded-lg">
289+
<Video src="guardrails-example.mp4" width={500} height={350} />
290+
</div>
291+
292+
### E-Mail-Format validieren
293+
294+
<div className="mb-4 rounded-md border p-4">
295+
<h4 className="font-medium">Szenario: E-Mail-Adressformat prüfen</h4>
296+
<ol className="list-decimal pl-5 text-sm">
297+
<li>Agent extrahiert E-Mail aus Text</li>
298+
<li>Guardrails validiert mit Regex-Muster</li>
299+
<li>Bei Gültigkeit → E-Mail für Benachrichtigung verwenden</li>
300+
<li>Bei Ungültigkeit → Korrektur anfordern</li>
301+
</ol>
302+
</div>
303+
304+
## Best Practices
305+
306+
- **Verkettung mit Condition-Blöcken**: Verwende `<guardrails.passed>` um Workflow-Logik basierend auf Validierungsergebnissen zu verzweigen
307+
- **JSON-Validierung vor dem Parsen verwenden**: Validiere immer die JSON-Struktur, bevor du versuchst, LLM-Ausgaben zu parsen
308+
- **Passende PII-Typen auswählen**: Wähle nur die PII-Entitätstypen aus, die für deinen Anwendungsfall relevant sind, um bessere Leistung zu erzielen
309+
- **Vernünftige Konfidenz-Schwellenwerte festlegen**: Passe für die Halluzinationserkennung den Schwellenwert basierend auf deinen Genauigkeitsanforderungen an (höher = strenger)
310+
- **Starke Modelle für Halluzinationserkennung verwenden**: GPT-4o oder Claude 3.7 Sonnet bieten genauere Konfidenz-Bewertungen
311+
- **PII für Logging maskieren**: Verwende den "Mask"-Modus, wenn du Inhalte protokollieren oder speichern musst, die PII enthalten könnten
312+
- **Regex-Muster testen**: Validiere deine Regex-Muster gründlich, bevor du sie in der Produktion einsetzt
313+
- **Validierungsfehler überwachen**: Verfolge `<guardrails.error>` Nachrichten, um häufige Validierungsprobleme zu identifizieren
314+
315+
<Callout type="info">
316+
Guardrails-Validierung erfolgt synchron in deinem Workflow. Für die Halluzinationserkennung solltest du schnellere Modelle (wie GPT-4o-mini) wählen, wenn Latenz kritisch ist.
317+
</Callout>

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

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,17 +170,49 @@ Verschiedene Abonnementpläne haben unterschiedliche Nutzungslimits:
170170
| **Team** | $500 (gepoolt) | 50 sync, 100 async |
171171
| **Enterprise** | Individuell | Individuell |
172172

173+
## Abrechnungsmodell
174+
175+
Sim verwendet ein **Basisabonnement + Mehrverbrauch** Abrechnungsmodell:
176+
177+
### Wie es funktioniert
178+
179+
**Pro-Plan (20 $/Monat):**
180+
- Monatliches Abonnement beinhaltet 20 $ Nutzung
181+
- Nutzung unter 20 $ → Keine zusätzlichen Kosten
182+
- Nutzung über 20 $ → Zahlung des Mehrverbrauchs am Monatsende
183+
- Beispiel: 35 $ Nutzung = 20 $ (Abonnement) + 15 $ (Mehrverbrauch)
184+
185+
**Team-Plan (40 $/Nutzer/Monat):**
186+
- Gemeinsame Nutzung für alle Teammitglieder
187+
- Mehrverbrauch wird aus der Gesamtnutzung des Teams berechnet
188+
- Organisationsinhaber erhält eine Rechnung
189+
190+
**Enterprise-Pläne:**
191+
- Fester monatlicher Preis, kein Mehrverbrauch
192+
- Individuelle Nutzungslimits gemäß Vereinbarung
193+
194+
### Schwellenwertabrechnung
195+
196+
Wenn der nicht abgerechnete Mehrverbrauch 50 $ erreicht, berechnet Sim automatisch den gesamten nicht abgerechneten Betrag.
197+
198+
**Beispiel:**
199+
- Tag 10: 70 $ Mehrverbrauch → Sofortige Abrechnung von 70 $
200+
- Tag 15: Zusätzliche 35 $ Nutzung (insgesamt 105 $) → Bereits abgerechnet, keine Aktion
201+
- Tag 20: Weitere 50 $ Nutzung (insgesamt 155 $, 85 $ nicht abgerechnet) → Sofortige Abrechnung von 85 $
202+
203+
Dies verteilt hohe Mehrverbrauchskosten über den Monat, anstatt eine große Rechnung am Periodenende zu stellen.
204+
173205
## Best Practices für Kostenmanagement
174206

175-
1. **Regelmäßig überwachen**: Prüfen Sie Ihr Nutzungs-Dashboard häufig, um Überraschungen zu vermeiden
207+
1. **Regelmäßige Überwachung**: Prüfen Sie Ihr Nutzungs-Dashboard häufig, um Überraschungen zu vermeiden
176208
2. **Budgets festlegen**: Nutzen Sie Planlimits als Leitplanken für Ihre Ausgaben
177209
3. **Workflows optimieren**: Überprüfen Sie kostenintensive Ausführungen und optimieren Sie Prompts oder Modellauswahl
178-
4. **Passende Modelle verwenden**: Stimmen Sie die Modellkomplexität auf die Aufgabenanforderungen ab
210+
4. **Passende Modelle verwenden**: Passen Sie die Modellkomplexität an die Aufgabenanforderungen an
179211
5. **Ähnliche Aufgaben bündeln**: Kombinieren Sie wenn möglich mehrere Anfragen, um den Overhead zu reduzieren
180212

181213
## Nächste Schritte
182214

183215
- Überprüfen Sie Ihre aktuelle Nutzung unter [Einstellungen → Abonnement](https://sim.ai/settings/subscription)
184216
- Erfahren Sie mehr über [Logging](/execution/logging), um Ausführungsdetails zu verfolgen
185217
- Erkunden Sie die [Externe API](/execution/api) für programmatische Kostenüberwachung
186-
- Sehen Sie sich [Workflow-Optimierungstechniken](/blocks) an, um Kosten zu reduzieren
218+
- Sehen Sie sich [Workflow-Optimierungstechniken](/blocks) zur Kostenreduzierung an

‎apps/docs/content/docs/de/sdks/python.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ Behandeln Sie verschiedene Fehlertypen, die während der Workflow-Ausführung au
387387
from simstudio import SimStudioClient, SimStudioError
388388
import os
389389

390-
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
390+
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
391391

392392
def execute_with_error_handling():
393393
try:
@@ -600,7 +600,7 @@ Führe Workflows mit Echtzeit-Streaming-Antworten aus:
600600
from simstudio import SimStudioClient
601601
import os
602602

603-
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
603+
client = SimStudioClient(api_key=os.getenv("SIM_API_KEY"))
604604

605605
def execute_with_streaming():
606606
"""Execute workflow with streaming enabled."""

0 commit comments

Comments
 (0)