com.theokanning.openai.service

Class ChatMessageAccumulator

java.lang.Object

com.theokanning.openai.service.ChatMessageAccumulator

public class ChatMessageAccumulator
extends java.lang.Object

Class that accumulates chat messages and provides utility methods for handling message chunks and function calls within a chat stream. This class is immutable.

Constructor Summary

Constructors

Constructor and Description
ChatMessageAccumulator(com.theokanning.openai.completion.chat.ChatMessage messageChunk, com.theokanning.openai.completion.chat.ChatMessage accumulatedMessage) Constructor that initializes the message chunk and accumulated message.

Method Summary

Modifier and Type	Method and Description
com.theokanning.openai.completion.chat.ChatFunctionCall	getAccumulatedChatFunctionCall() Retrieves the function call from the accumulated message.
com.theokanning.openai.completion.chat.ChatMessage	getAccumulatedMessage() Retrieves the accumulated message.
com.theokanning.openai.completion.chat.ChatFunctionCall	getChatFunctionCallChunk() Retrieves the function call from the message chunk.
com.theokanning.openai.completion.chat.ChatMessage	getMessageChunk() Retrieves the message chunk.
boolean	isChatMessage() Checks if the accumulated message contains a chat message.
boolean	isFunctionCall() Checks if the accumulated message contains a function call.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatMessageAccumulator

public ChatMessageAccumulator(com.theokanning.openai.completion.chat.ChatMessage messageChunk,
                              com.theokanning.openai.completion.chat.ChatMessage accumulatedMessage)

Constructor that initializes the message chunk and accumulated message.

Parameters:

messageChunk - The message chunk.

accumulatedMessage - The accumulated message.

Method Detail

isFunctionCall

public boolean isFunctionCall()

Checks if the accumulated message contains a function call.

Returns:

true if the accumulated message contains a function call, false otherwise.

isChatMessage

public boolean isChatMessage()

Checks if the accumulated message contains a chat message.

Returns:

true if the accumulated message contains a chat message, false otherwise.

getMessageChunk

public com.theokanning.openai.completion.chat.ChatMessage getMessageChunk()

Retrieves the message chunk.

Returns:

the message chunk.

getAccumulatedMessage

public com.theokanning.openai.completion.chat.ChatMessage getAccumulatedMessage()

Retrieves the accumulated message.

Returns:

the accumulated message.

getChatFunctionCallChunk

public com.theokanning.openai.completion.chat.ChatFunctionCall getChatFunctionCallChunk()

Retrieves the function call from the message chunk. This is equivalent to getMessageChunk().getFunctionCall().

Returns:

the function call from the message chunk.

getAccumulatedChatFunctionCall

public com.theokanning.openai.completion.chat.ChatFunctionCall getAccumulatedChatFunctionCall()

Retrieves the function call from the accumulated message. This is equivalent to getAccumulatedMessage().getFunctionCall().

Returns:

the function call from the accumulated message.