|
| 1 | +--- |
| 2 | +title: Start |
| 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 | + |
| 9 | +Der Start-Block ist der Standard-Auslöser für Workflows, die in Sim erstellt werden. Er sammelt strukturierte Eingaben und verteilt sie an den Rest deines Graphen für Editor-Tests, API-Bereitstellungen und Chat-Erlebnisse. |
| 10 | + |
| 11 | +<div className="flex justify-center"> |
| 12 | + <Image |
| 13 | + src="/static/start.png" |
| 14 | + alt="Start-Block mit Eingabeformat-Feldern" |
| 15 | + width={360} |
| 16 | + height={380} |
| 17 | + className="my-6" |
| 18 | + /> |
| 19 | +</div> |
| 20 | + |
| 21 | +<Callout type="info"> |
| 22 | +Der Start-Block befindet sich in der Startposition, wenn du einen Workflow erstellst. Behalte ihn dort, wenn du denselben Einstiegspunkt für Editor-Ausführungen, Deploy-to-API-Anfragen und Chat-Sitzungen verwenden möchtest. Tausche ihn mit Webhook- oder Schedule-Triggern aus, wenn du nur ereignisgesteuerte Ausführung benötigst. |
| 23 | +</Callout> |
| 24 | + |
| 25 | +## Von Start bereitgestellte Felder |
| 26 | + |
| 27 | +Der Start-Block gibt je nach Ausführungsumgebung unterschiedliche Daten aus: |
| 28 | + |
| 29 | +- **Eingabeformat-Felder** — Jedes Feld, das du hinzufügst, wird als `<start.fieldName>` verfügbar. Zum Beispiel erscheint ein `customerId`Feld als `<start.customerId>` in nachgelagerten Blöcken und Vorlagen. |
| 30 | +- **Nur-Chat-Felder** — Wenn der Workflow über das Chat-Seitenfeld oder ein bereitgestelltes Chat-Erlebnis ausgeführt wird, stellt Sim auch `<start.input>` (neueste Benutzernachricht), `<start.conversationId>` (aktive Sitzungs-ID) und `<start.files>` (Chat-Anhänge) bereit. |
| 31 | + |
| 32 | +Halte die Eingabeformat-Felder auf die Namen beschränkt, auf die du später verweisen möchtest – diese Werte sind die einzigen strukturierten Felder, die über Editor-, API- und Chat-Ausführungen hinweg geteilt werden. |
| 33 | + |
| 34 | +## Konfiguriere das Eingabeformat |
| 35 | + |
| 36 | +Verwende den Eingabeformat-Unterblock, um das Schema zu definieren, das für alle Ausführungsmodi gilt: |
| 37 | + |
| 38 | +1. Füge ein Feld für jeden Wert hinzu, den du sammeln möchtest. |
| 39 | +2. Wähle einen Typ (`string`, `number`, `boolean`, `object`, `array` oder `files`). Dateifelder akzeptieren Uploads von Chat- und API-Aufrufern. |
| 40 | +3. Gib Standardwerte an, wenn du möchtest, dass das manuelle Ausführungsmodal automatisch Testdaten einfügt. Diese Standardwerte werden für bereitgestellte Ausführungen ignoriert. |
| 41 | +4. Ordne Felder neu an, um zu steuern, wie sie im Editor-Formular erscheinen. |
| 42 | + |
| 43 | +Referenzieren Sie strukturierte Werte nachgelagert mit Ausdrücken wie `<start.customerId>` abhängig vom Block, den Sie verbinden. |
| 44 | + |
| 45 | +## Wie es sich je nach Einstiegspunkt verhält |
| 46 | + |
| 47 | +<Tabs items={['Editor-Ausführung', 'Bereitstellung als API', 'Bereitstellung für Chat']}> |
| 48 | + <Tab> |
| 49 | + <div className="space-y-3"> |
| 50 | + <p> |
| 51 | + Wenn Sie im Editor auf <strong>Ausführen</strong> klicken, rendert der Start-Block das Eingabeformat als Formular. Standardwerte erleichtern das erneute Testen ohne erneute Dateneingabe. Durch das Absenden des Formulars wird der Workflow sofort ausgelöst und die Werte werden unter <code><start.feldName></code> (zum Beispiel <code><start.sampleField></code>) verfügbar. |
| 52 | + </p> |
| 53 | + <p> |
| 54 | + Dateifelder im Formular werden direkt in die entsprechenden `<start.fieldName>` hochgeladen; verwenden Sie diese Werte, um nachgelagerte Tools oder Speicherschritte zu versorgen. |
| 55 | + </p> |
| 56 | + </div> |
| 57 | + </Tab> |
| 58 | + <Tab> |
| 59 | + <div className="space-y-3"> |
| 60 | + <p> |
| 61 | + Die Bereitstellung als API verwandelt das Eingabeformat in einen JSON-Vertrag für Clients. Jedes Feld wird Teil des Anforderungskörpers, und Sim erzwingt primitive Typen bei der Aufnahme. Dateifelder erwarten Objekte, die auf hochgeladene Dateien verweisen; verwenden Sie den Ausführungs-Datei-Upload-Endpunkt, bevor Sie den Workflow aufrufen. |
| 62 | + </p> |
| 63 | + <p> |
| 64 | + API-Aufrufer können zusätzliche optionale Eigenschaften einbeziehen. Diese werden in den `<start.fieldName>`Ausgaben beibehalten, sodass Sie experimentieren können, ohne sofort neu bereitzustellen. |
| 65 | + </p> |
| 66 | + </div> |
| 67 | + </Tab> |
| 68 | + <Tab> |
| 69 | + <div className="space-y-3"> |
| 70 | + <p> |
| 71 | + Bei Chat-Bereitstellungen bindet sich der Start-Block an die aktive Konversation. Die neueste Nachricht füllt <code><start.input></code>, die Sitzungskennung ist unter <code><start.conversationId></code> verfügbar, und Benutzeranhänge erscheinen unter <code><start.files></code>, zusammen mit allen Eingabeformatfeldern, die als <code><start.fieldName></code> definiert sind. |
| 72 | + </p> |
| 73 | + <p> |
| 74 | + Wenn Sie den Chat mit zusätzlichem strukturiertem Kontext starten (zum Beispiel aus einer Einbettung), wird dieser mit den entsprechenden `<start.fieldName>`Ausgaben zusammengeführt, wodurch nachgelagerte Blöcke konsistent mit API- und manuellen Ausführungen bleiben. |
| 75 | + </p> |
| 76 | + </div> |
| 77 | + </Tab> |
| 78 | +</Tabs> |
| 79 | + |
| 80 | +## Referenzierung von Start-Daten in nachgelagerten Komponenten |
| 81 | + |
| 82 | +- Verbinde `<start.fieldName>` direkt mit Agenten, Tools oder Funktionen, die strukturierte Daten erwarten. |
| 83 | +- Verwende Template-Syntax wie `<start.sampleField>` oder `<start.files[0].url>` (nur für Chat) in Prompt-Feldern. |
| 84 | +- Halte `<start.conversationId>` bereit, wenn du Ausgaben gruppieren, den Gesprächsverlauf aktualisieren oder die Chat-API erneut aufrufen musst. |
| 85 | + |
| 86 | +## Best Practices |
| 87 | + |
| 88 | +- Behandle den Start-Block als einzigen Einstiegspunkt, wenn du sowohl API- als auch Chat-Aufrufer unterstützen möchtest. |
| 89 | +- Bevorzuge benannte Eingabeformat-Felder gegenüber dem Parsen von rohem JSON in nachgelagerten Knoten; Typumwandlung erfolgt automatisch. |
| 90 | +- Füge unmittelbar nach dem Start Validierung oder Routing hinzu, wenn bestimmte Felder für den Erfolg deines Workflows erforderlich sind. |
0 commit comments