dev.langchain4j.model

Interface StreamingResponseHandler

public interface StreamingResponseHandler

Method Summary

Modifier and Type	Method and Description
default void	onComplete() This method is invoked once LLM has finished responding.
void	onError(Throwable error) This method is invoked when an error occurs during streaming.
void	onNext(String token) This method is invoked each time LLM sends a token.
default void	onToolArguments(String arguments) This method is invoked each time LLM sends a token.
default void	onToolName(String name) This method is invoked when LLM decides to execute a tool.

Method Detail

onNext

void onNext(String token)

This method is invoked each time LLM sends a token.

Parameters:

token - single token, part of a complete response

onToolName

default void onToolName(String name)

This method is invoked when LLM decides to execute a tool. It is supposed to work exclusively with the StreamingChatLanguageModel.

Parameters:

name - the name of the tool that LLM has chosen to execute

onToolArguments

default void onToolArguments(String arguments)

This method is invoked each time LLM sends a token. This is how the following string with arguments { "argument": "value" } can be streamed: 1. "{" 2. " \"" 3. "argument" 4: "\":" 5. " \"" 6. "value" 7. "\" " 8. "}" It is supposed to work exclusively with the StreamingChatLanguageModel.

Parameters:

arguments - single token, a part of the complete arguments JSON object

onComplete

default void onComplete()

This method is invoked once LLM has finished responding.

onError

void onError(Throwable error)

This method is invoked when an error occurs during streaming.

Parameters:

error - the Throwable error that occurred