Class OpenAiStreamingResponseBuilder

java.lang.Object

dev.langchain4j.model.openai.OpenAiStreamingResponseBuilder

public class OpenAiStreamingResponseBuilder
extends Object

This class needs to be thread safe because it is called when a streaming result comes back and there is no guarantee that this thread will be the same as the one that initiated the request, in fact it almost certainly won't be.

Constructor Summary

Constructors

Constructor	Description
OpenAiStreamingResponseBuilder()
OpenAiStreamingResponseBuilder(boolean returnThinking)
OpenAiStreamingResponseBuilder(boolean returnThinking, boolean accumulateToolCallId)

Method Summary

Modifier and Type	Method	Description
void	append(ChatCompletionResponse partialResponse)
void	append(CompletionResponse partialResponse)
void	append(ParsedAndRawResponse<ChatCompletionResponse> parsedAndRawResponse)
ChatResponse	build()
String	errorMessage()	Returns an error message if the provider sent an error inside the stream (e.g.

Methods inherited from class Object

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

Constructor Details

OpenAiStreamingResponseBuilder

public OpenAiStreamingResponseBuilder()

OpenAiStreamingResponseBuilder

public OpenAiStreamingResponseBuilder(boolean returnThinking)

OpenAiStreamingResponseBuilder

public OpenAiStreamingResponseBuilder(boolean returnThinking,
 boolean accumulateToolCallId)

Method Details

append

public void append(ParsedAndRawResponse<ChatCompletionResponse> parsedAndRawResponse)

append

public void append(ChatCompletionResponse partialResponse)

append

public void append(CompletionResponse partialResponse)

errorMessage

public String errorMessage()

Returns an error message if the provider sent an error inside the stream (e.g. data: {"error": {...}}), otherwise null.

build

public ChatResponse build()