Package org.springframework.ai.anthropic.api

Class StreamHelper

java.lang.Object

org.springframework.ai.anthropic.api.StreamHelper

public class StreamHelper
extends Object

Helper class to support streaming function calling and thinking events.

It can merge the streamed AnthropicApi.StreamEvent chunks in case of function calling message. It passes through other events like text, thinking, and signature deltas.

Since:

1.0.0

Author:

Mariusz Bernacki, Christian Tzolov, Jihoon Kim, Alexandros Pappas, Claudio Silva Junior, Soby Chacko

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamHelper.ChatCompletionResponseBuilder	Builder for AnthropicApi.ChatCompletionResponse.

Constructor Summary

Constructors

Constructor	Description
StreamHelper()

Method Summary

Modifier and Type	Method	Description
AnthropicApi.ChatCompletionResponse	eventToChatCompletionResponse(AnthropicApi.StreamEvent event, AtomicReference<StreamHelper.ChatCompletionResponseBuilder> contentBlockReference)	Converts a raw AnthropicApi.StreamEvent potentially containing tool use aggregates or other block types (text, thinking) into a AnthropicApi.ChatCompletionResponse chunk.
boolean	isToolUseFinish(AnthropicApi.StreamEvent event)
boolean	isToolUseStart(AnthropicApi.StreamEvent event)
AnthropicApi.StreamEvent	mergeToolUseEvents(AnthropicApi.StreamEvent previousEvent, AnthropicApi.StreamEvent event)	Merge the tool‑use related streaming events into one aggregate event so that the upper layers see a single ContentBlock with the full JSON input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StreamHelper

public StreamHelper()

Method Details

isToolUseStart

public boolean isToolUseStart(AnthropicApi.StreamEvent event)

isToolUseFinish

public boolean isToolUseFinish(AnthropicApi.StreamEvent event)

mergeToolUseEvents

public AnthropicApi.StreamEvent mergeToolUseEvents(AnthropicApi.StreamEvent previousEvent,
 AnthropicApi.StreamEvent event)

Merge the tool‑use related streaming events into one aggregate event so that the upper layers see a single ContentBlock with the full JSON input.

eventToChatCompletionResponse

public AnthropicApi.ChatCompletionResponse eventToChatCompletionResponse(AnthropicApi.StreamEvent event,
 AtomicReference<StreamHelper.ChatCompletionResponseBuilder> contentBlockReference)

Converts a raw AnthropicApi.StreamEvent potentially containing tool use aggregates or other block types (text, thinking) into a AnthropicApi.ChatCompletionResponse chunk.

Parameters:

event - The incoming StreamEvent.

contentBlockReference - Holds the state of the response being built across multiple events.

Returns:

A ChatCompletionResponse representing the processed chunk.