Skip to main content
Standardmäßig liefert das Agent SDK eine vollständige AssistantMessage für jeden nicht leeren Inhaltsblock, wie einen Textblock oder einen Tool-Aufruf, nachdem Claude die Generierung dieses Blocks abgeschlossen hat. Um inkrementelle Aktualisierungen zu erhalten, während Text und Tool-Aufrufe generiert werden, aktivieren Sie das Streaming von Teillmeldungen.
Diese Seite behandelt das Ausgabe-Streaming (Empfangen von Token in Echtzeit). Informationen zu Eingabemodi (wie Sie Nachrichten senden), finden Sie unter Nachrichten an Agenten senden. Sie können auch Antworten mit dem Agent SDK über die CLI streamen.

Ausgabe-Streaming aktivieren

Um Streaming zu aktivieren, setzen Sie include_partial_messages (Python) oder includePartialMessages (TypeScript) in Ihren Optionen auf true. Dies führt dazu, dass das SDK StreamEvent-Nachrichten mit rohen API-Ereignissen liefert, die ankommen, zusätzlich zu den üblichen AssistantMessage- und ResultMessage-Objekten. Ihr Code muss dann:
  1. Den Typ jeder Nachricht überprüfen, um StreamEvent von anderen Nachrichtentypen zu unterscheiden
  2. Für StreamEvent das Feld event extrahieren und seinen type überprüfen
  3. Nach content_block_delta-Ereignissen suchen, bei denen delta.type gleich text_delta ist, die die tatsächlichen Text-Chunks enthalten
Das folgende Beispiel aktiviert Streaming und gibt Text-Chunks aus, während sie ankommen. Beachten Sie die verschachtelten Typüberprüfungen: zuerst für StreamEvent, dann für content_block_delta, dann für text_delta:

StreamEvent-Referenz

Wenn Teillmeldungen aktiviert sind, erhalten Sie rohe Claude-API-Streaming-Ereignisse, die in einem Objekt verpackt sind. Der Typ hat in jedem SDK unterschiedliche Namen: Beide enthalten rohe Claude-API-Ereignisse, nicht angesammelte Text. Sie müssen Text-Deltas selbst extrahieren und ansammeln. Das Feld parent_tool_use_id ist in Python immer None und in TypeScript immer null. Streaming-Ereignisse werden nur für die Hauptsitzung ausgegeben; Token-Level-Deltas von Subagenten werden nicht weitergeleitet. Um die Ausgabe einem Subagenten zuzuordnen, verwenden Sie vollständige Nachrichten, die parent_tool_use_id enthalten. Siehe Subagenten-Aufruf erkennen. Claude Code setzt user_message_uuid beim ersten Nicht-Ping-Streaming-Ereignis des Durchlaufs und erneut, wenn sich die Nachricht ändert, auf die der Durchlauf antwortet, unter den Bedingungen in user_message_uuid. Der Python StreamEvent macht dieses Feld nicht verfügbar. Das Feld event enthält das rohe Streaming-Ereignis aus der Claude API. Häufige Ereignistypen sind:

Nachrichtenfluss

Claude Code gibt eine AssistantMessage aus, sobald jeder nicht-leere Inhaltsblock abgeschlossen ist. Eine Antwort mit einem Textblock und einem Werkzeugaufruf ergibt also zwei AssistantMessage-Objekte. Jedes trägt nur seinen eigenen Inhaltsblock, und beide teilen sich dieselbe Nachrichten-ID, die Sie in TypeScript als message.message.id und in Python als message.message_id lesen. Mit aktivierten Teilnachrichten kommt jede AssistantMessage vor dem content_block_stop-Ereignis dieses Blocks an, und Sie erhalten Nachrichten in dieser Reihenfolge:
Ohne aktivierte Teilnachrichten erhalten Sie alle Nachrichtentypen außer StreamEvent. Häufige Typen sind SystemMessage (Sitzungsinitialisierung), AssistantMessage (vollständige Inhaltsblöcke), ResultMessage (Endergebnis) und eine kompakte Grenzmarkierungsnachricht, die anzeigt, wann der Gesprächsverlauf komprimiert wurde (SDKCompactBoundaryMessage in TypeScript; SystemMessage mit Subtyp "compact_boundary" in Python).

Tool-Aufrufe streamen

Tool-Aufrufe werden auch inkrementell gestreamt. Sie können verfolgen, wann Tools starten, ihre Eingabe erhalten, während sie generiert wird, und sehen, wann sie abgeschlossen sind. Das folgende Beispiel verfolgt das aktuell aufgerufene Tool und sammelt die JSON-Eingabe, während sie gestreamt wird. Es verwendet drei Ereignistypen:
  • content_block_start: Tool beginnt
  • content_block_delta mit input_json_delta: Eingabe-Chunks kommen an
  • content_block_stop: Tool-Aufruf abgeschlossen

Streaming-UI erstellen

Dieses Beispiel kombiniert Text- und Tool-Streaming in eine kohärente Benutzeroberfläche. Es verfolgt, ob der Agent gerade ein Tool ausführt (mit einem in_tool-Flag), um Statusanzeigen wie [Using Read...] anzuzeigen, während Tools ausgeführt werden. Text wird normal gestreamt, wenn nicht in einem Tool, und die Tool-Fertigstellung löst eine „done”-Nachricht aus. Dieses Muster ist nützlich für Chat-Schnittstellen, die während mehrstufiger Agent-Aufgaben Fortschritt anzeigen müssen.

Bekannte Einschränkungen

  • Strukturierte Ausgabe: Das JSON-Ergebnis erscheint nur in der finalen ResultMessage.structured_output, nicht als Streaming-Deltas. Weitere Informationen finden Sie unter Strukturierte Ausgaben.

Nächste Schritte

Jetzt, da Sie Text und Tool-Aufrufe in Echtzeit streamen können, erkunden Sie diese verwandten Themen: