agent-sdk/typescript.md +28 −6
2386 kind: "task-notification";2386 kind: "task-notification";
2387 subkind?: "scheduled-trigger" | "peer-send-message";2387 subkind?: "scheduled-trigger" | "peer-send-message";
2388 fireReason?: string;2388 fireReason?: string;
2389 runId?: string;
2389 }2390 }
2390 | { kind: "coordinator" }2391 | { kind: "coordinator" }
2391 | { kind: "auto-continuation" }2392 | { kind: "auto-continuation" }
2415 2416
2416`fireReason` sagt, warum eine `scheduled-trigger`-Benachrichtigung ausgelöst wurde, als kurzes Kleinbuchstaben-Token wie `scheduled`, `manual`, `retry`, `catch_up` oder `api`. Anthropic-Server setzen es auf die Lieferungen einer [Routine](/docs/de/routines), und Ihre Anwendung setzt es, wenn sie eine geplante Ausführung erklärt. Es fehlt, wenn keiner von beiden einen gesendet hat. Erfordert TypeScript Agent SDK v0.3.280 oder später.2417`fireReason` sagt, warum eine `scheduled-trigger`-Benachrichtigung ausgelöst wurde, als kurzes Kleinbuchstaben-Token wie `scheduled`, `manual`, `retry`, `catch_up` oder `api`. Anthropic-Server setzen es auf die Lieferungen einer [Routine](/docs/de/routines), und Ihre Anwendung setzt es, wenn sie eine geplante Ausführung erklärt. Es fehlt, wenn keiner von beiden einen gesendet hat. Erfordert TypeScript Agent SDK v0.3.280 oder später.
2417 2418
2419Eine Hintergrundaufgabe kann mehr als einmal unter derselben `task_id` ausgeführt werden, etwa wenn Claude [einen Subagenten fortsetzt](/docs/de/agent-sdk/subagents#resume-subagents). Jeder Lauf hat seine eigene [`run_id`](#sdktaskstartedmessage). Wenn die Benachrichtigung eines Laufs Ihre Sitzung als Benutzernachricht erreicht, enthält `runId` im `task-notification`-Origin dieser Nachricht denselben Wert. Eine Benachrichtigung kann eintreffen, nachdem der nächste Lauf der Aufgabe bereits begonnen hat, und trägt dennoch die ID des früheren Laufs. Um festzustellen, zu welchem Lauf ein Turn gehört, vergleichen Sie `runId`, nicht `task_id`. Erfordert TypeScript Agent SDK v0.3.292 oder höher.
2420
2418<h4 id="declare-a-scheduled-run">2421<h4 id="declare-a-scheduled-run">
2419 Geplante Ausführung erklären2422 Geplante Ausführung erklären
2420</h4>2423</h4>
3261 Tool-Eingabetypen3264 Tool-Eingabetypen
3262</h2>3265</h2>
3263 3266
32643267Dokumentation von Eingabeschemas für alle integrierten Claude Code-Tools. Diese Typen werden aus `@anthropic-ai/claude-agent-sdk/sdk-tools` exportiert und können für typsichere Tool-Interaktionen verwendet werden.Dokumentation von Eingabeschemas für integrierte Claude Code-Tools. Diese Typen werden aus `@anthropic-ai/claude-agent-sdk/sdk-tools` exportiert und können für typsichere Tool-Interaktionen verwendet werden.
3265 3268
3266<h3 id="toolinputschemas">3269<h3 id="toolinputschemas">
3267 `ToolInputSchemas`3270 `ToolInputSchemas`
4077 Tool-Ausgabetypen4080 Tool-Ausgabetypen
4078</h2>4081</h2>
4079 4082
40804083Dokumentation von Ausgabeschemas für alle integrierten Claude Code-Tools. Diese Typen werden aus `@anthropic-ai/claude-agent-sdk/sdk-tools` exportiert und stellen die tatsächlichen Antwortdaten dar, die von jedem Tool zurückgegeben werden.Dokumentation von Ausgabeschemas für integrierte Claude Code-Tools. Diese Typen werden aus `@anthropic-ai/claude-agent-sdk/sdk-tools` exportiert und stellen die tatsächlichen Antwortdaten dar, die von jedem Tool zurückgegeben werden.
4081 4084
4082<h3 id="tooloutputschemas">4085<h3 id="tooloutputschemas">
4083 `ToolOutputSchemas`4086 `ToolOutputSchemas`
5730 `SDKTaskNotificationMessage`5733 `SDKTaskNotificationMessage`
5731</h3>5734</h3>
5732 5735
57335736Benachrichtigung, wenn eine Hintergrundaufgabe abgeschlossen, fehlgeschlagen oder gestoppt wird. Hintergrundaufgaben umfassen `run_in_background` Bash-Befehle, [Monitor](#monitor)-Watches und Hintergrund-Subagenten. Für das `ambient`-Feld siehe [`SDKTaskStartedMessage`](#sdktaskstartedmessage), das es und seine Versionsanforderung definiert.Benachrichtigung, wenn eine Hintergrundaufgabe abgeschlossen, fehlgeschlagen oder gestoppt wird. Hintergrundaufgaben umfassen `run_in_background` Bash-Befehle, [Monitor](#monitor)-Watches und Hintergrund-Subagenten. Für die Felder `run_id` und `ambient` siehe [`SDKTaskStartedMessage`](#sdktaskstartedmessage), das sie und ihre Versionsanforderungen definiert.
5734 5737
5735```typescript theme={null}5738```typescript theme={null}
5736type SDKTaskNotificationMessage = {5739type SDKTaskNotificationMessage = {
5737 type: "system";5740 type: "system";
5738 subtype: "task_notification";5741 subtype: "task_notification";
5739 task_id: string;5742 task_id: string;
5743 run_id?: string;
5740 tool_use_id?: string;5744 tool_use_id?: string;
5741 status: "completed" | "failed" | "stopped";5745 status: "completed" | "failed" | "stopped";
5742 reason?: "worker_restart";5746 reason?: "worker_restart";
5909 type: "system";5913 type: "system";
5910 subtype: "task_started";5914 subtype: "task_started";
5911 task_id: string;5915 task_id: string;
5916 run_id?: string;
5912 tool_use_id?: string;5917 tool_use_id?: string;
5913 description: string;5918 description: string;
5914 task_type?: string;5919 task_type?: string;
5921};5926};
5922```5927```
5923 5928
5929`run_id` identifiziert einen Lauf der Aufgabe. Wenn eine Aufgabe erneut unter derselben `task_id` läuft, z. B. ein [Subagent, den Claude fortsetzt](/docs/de/agent-sdk/subagents#resume-subagents), erhält der neue Lauf eine neue `run_id`. Das Feld erfordert Agent SDK v0.3.292 oder später. Verwenden Sie es, um die Läufe einer Aufgabe auseinanderzuhalten:
5930
5931* **Nachrichten einem Lauf zuordnen**: Die Nachrichten `task_started`, [`task_progress`](#sdktaskprogressmessage), [`task_updated`](#sdktaskupdatedmessage) und [`task_notification`](#sdktasknotificationmessage) eines Laufs tragen dieselbe `run_id`. Der Eintrag des Laufs in jeder [`SDKBackgroundTasksChangedMessage`](#sdkbackgroundtaskschangedmessage) trägt sie ebenfalls, ebenso die [`runId`](#task-notification-subkinds) im Origin der Benutzer-Nachricht, die die Benachrichtigung des Laufs liefert.
5932* **Eine verspätete Nachricht erkennen**: Als einfache Zeichenketten verglichen, sortieren sich die Lauf-IDs einer Aufgabe in der Reihenfolge, in der die Läufe gestartet wurden; eine Nachricht, deren `run_id` vor dem Lauf einsortiert wird, den Sie gerade anzeigen, stammt daher aus einem früheren Lauf. Behandeln Sie den Wert abgesehen von diesem Vergleich als opak.
5933* **Auf `task_id` zurückgreifen**: Wenn eine Nachricht keine `run_id` trägt, z. B. die `task_notification`, die eine fortgesetzte Sitzung ausgibt, um eine vom früheren Prozess gestartete Aufgabe abzuschließen, ordnen Sie sie über `task_id` zu.
5934
5935Zum Beispiel stammen diese drei Nachrichten, gekürzt auf ihre identifizierenden Felder, von einem Hintergrund-Subagenten, den Claude einmal fortgesetzt hat. Die beiden `task_started`-Nachrichten teilen sich eine `task_id`, und die Benachrichtigung, die den ersten Lauf beendet hat, trägt die ID des ersten Laufs:
5936
5937```json theme={null}
5938{"subtype": "task_started", "task_id": "a5c2e8f41b09d7a36", "run_id": "0mubbs7i8-6f0c2d41"}
5939{"subtype": "task_notification", "task_id": "a5c2e8f41b09d7a36", "run_id": "0mubbs7i8-6f0c2d41", "status": "completed"}
5940{"subtype": "task_started", "task_id": "a5c2e8f41b09d7a36", "run_id": "0mubc18m1-b7719e05"}
5941```
5942
5924`ambient` ist `true` für Aufgaben, die nicht Teil der Arbeit der Sitzung sind, z. B. Aufgaben, die Claude Code für seinen eigenen Betrieb ausführt. Live-Update-Watcher sind auch ambient, einschließlich Watcher, die der Benutzer angefordert hat. Schließen Sie ambient-Aufgaben aus Aktivitätsindikatoren aus. Das Feld erfordert Agent SDK v0.3.247 oder später.5943`ambient` ist `true` für Aufgaben, die nicht Teil der Arbeit der Sitzung sind, z. B. Aufgaben, die Claude Code für seinen eigenen Betrieb ausführt. Live-Update-Watcher sind auch ambient, einschließlich Watcher, die der Benutzer angefordert hat. Schließen Sie ambient-Aufgaben aus Aktivitätsindikatoren aus. Das Feld erfordert Agent SDK v0.3.247 oder später.
5925 5944
5926`ambient` erscheint auch auf [`SDKTaskNotificationMessage`](#sdktasknotificationmessage) und auf [`SDKBackgroundTasksChangedMessage`](#sdkbackgroundtaskschangedmessage)-Einträgen.5945`ambient` erscheint auch auf [`SDKTaskNotificationMessage`](#sdktasknotificationmessage) und auf [`SDKBackgroundTasksChangedMessage`](#sdkbackgroundtaskschangedmessage)-Einträgen.
5944 `SDKTaskProgressMessage`5963 `SDKTaskProgressMessage`
5945</h3>5964</h3>
5946 5965
59475966Wird regelmäßig ausgegeben, während ein Subagent oder eine Hintergrundaufgabe läuft.Wird regelmäßig ausgegeben, während ein Subagent oder eine Hintergrundaufgabe läuft. Für das `run_id`-Feld siehe [`SDKTaskStartedMessage`](#sdktaskstartedmessage), das es und seine Versionsanforderung definiert.
5948 5967
5949Für eine Subagenten-Aufgabe trägt das `summary`-Feld eine modellgenerierte Fortschritts-Zusammenfassung und wird nur ausgefüllt, wenn [`agentProgressSummaries`](#options) aktiviert ist. Für einen [in den Hintergrund verschobenen MCP-Tool-Aufruf](/docs/de/mcp#automatic-backgrounding-of-long-tool-calls) trägt `summary` den neuesten gemeldeten Fortschritt des MCP-Servers und hängt nicht von dieser Option ab.5968Für eine Subagenten-Aufgabe trägt das `summary`-Feld eine modellgenerierte Fortschritts-Zusammenfassung und wird nur ausgefüllt, wenn [`agentProgressSummaries`](#options) aktiviert ist. Für einen [in den Hintergrund verschobenen MCP-Tool-Aufruf](/docs/de/mcp#automatic-backgrounding-of-long-tool-calls) trägt `summary` den neuesten gemeldeten Fortschritt des MCP-Servers und hängt nicht von dieser Option ab.
5950 5969
5953 type: "system";5972 type: "system";
5954 subtype: "task_progress";5973 subtype: "task_progress";
5955 task_id: string;5974 task_id: string;
5975 run_id?: string;
5956 tool_use_id?: string;5976 tool_use_id?: string;
5957 description: string;5977 description: string;
5958 subagent_type?: string;5978 subagent_type?: string;
5972 `SDKTaskUpdatedMessage`5992 `SDKTaskUpdatedMessage`
5973</h3>5993</h3>
5974 5994
59755995Wird ausgegeben, wenn sich der Status einer Hintergrundaufgabe ändert, z. B. wenn sie von `running` zu `completed` übergeht. Führen Sie `patch` in Ihre lokale Aufgabenkarte zusammen, die nach `task_id` indiziert ist. Das `end_time`-Feld ist ein Unix-Epoch-Zeitstempel in Millisekunden, vergleichbar mit `Date.now()`.Wird ausgegeben, wenn sich der Status einer Hintergrundaufgabe ändert, z. B. wenn sie von `running` zu `completed` übergeht. Führen Sie `patch` in Ihre lokale Aufgabenkarte zusammen, die nach `task_id` indiziert ist. Das `end_time`-Feld ist ein Unix-Epoch-Zeitstempel in Millisekunden, vergleichbar mit `Date.now()`. Für das `run_id`-Feld siehe [`SDKTaskStartedMessage`](#sdktaskstartedmessage), das es und seine Versionsanforderung definiert.
5976 5996
5977```typescript theme={null}5997```typescript theme={null}
5978type SDKTaskUpdatedMessage = {5998type SDKTaskUpdatedMessage = {
5979 type: "system";5999 type: "system";
5980 subtype: "task_updated";6000 subtype: "task_updated";
5981 task_id: string;6001 task_id: string;
6002 run_id?: string;
5982 patch: {6003 patch: {
5983 status?: "pending" | "running" | "completed" | "failed" | "killed";6004 status?: "pending" | "running" | "completed" | "failed" | "killed";
5984 description?: string;6005 description?: string;
5996 `SDKBackgroundTasksChangedMessage`6017 `SDKBackgroundTasksChangedMessage`
5997</h3>6018</h3>
5998 6019
59996020Wird ausgegeben, wenn sich die Menge der aktiven Hintergrundaufgaben ändert: eine Aufgabe startet, wird abgeschlossen oder wird beendet; ein Vordergrund-Agent wird in den Hintergrund verschoben; oder das `description`-, `ambient`- oder `parent_task_id`-Feld einer Aufgabe ändert sich. Für das `parent_task_id`-Feld in jedem Eintrag siehe [`SDKTaskStartedMessage`](#sdktaskstartedmessage), das es und seine Versionsanforderung definiert.Wird ausgegeben, wenn sich die Menge der aktiven Hintergrundaufgaben ändert: eine Aufgabe startet, wird abgeschlossen oder wird beendet; ein Vordergrund-Agent wird in den Hintergrund verschoben; oder das `description`-, `ambient`- oder `parent_task_id`-Feld einer Aufgabe ändert sich. Für die Felder `run_id` und `parent_task_id` in jedem Eintrag siehe [`SDKTaskStartedMessage`](#sdktaskstartedmessage), das sie und ihre Versionsanforderungen definiert.
6000 6021
6001Das `tasks`-Array ist die vollständige aktive Menge. Ersetzen Sie alle zwischengespeicherten Mengen mit jeder Payload, anstatt `task_started`- und `task_notification`-Ereignisse zu koppeln, sodass die nächste Änderung der Mitgliedschaft alle verpassten Ereignisse korrigiert.6022Das `tasks`-Array ist die vollständige aktive Menge. Ersetzen Sie alle zwischengespeicherten Mengen mit jeder Payload, anstatt `task_started`- und `task_notification`-Ereignisse zu koppeln, sodass die nächste Änderung der Mitgliedschaft alle verpassten Ereignisse korrigiert.
6002 6023
6014 subtype: "background_tasks_changed";6035 subtype: "background_tasks_changed";
6015 tasks: {6036 tasks: {
6016 task_id: string;6037 task_id: string;
6038 run_id?: string;
6017 task_type: string;6039 task_type: string;
6018 subagent_type?: string;6040 subagent_type?: string;
6019 description: string;6041 description: string;