Package com.microsoft.semantickernel.services.chatcompletion

Class ChatHistory

java.lang.Object

com.microsoft.semantickernel.services.chatcompletion.ChatHistory

All Implemented Interfaces:

Iterable<ChatMessageContent<?>>

public class ChatHistory
extends Object
implements Iterable<ChatMessageContent<?>>

Provides a history of messages between the User, Assistant and System

Constructor Summary

Constructors

Constructor	Description
ChatHistory()	The default constructor
ChatHistory(String instructions)	Constructor that adds the given system instructions to the chat history.
ChatHistory(List<? extends ChatMessageContent<?>> chatMessageContents)	Constructor that adds the given chat message contents to the chat history.

Method Summary

Modifier and Type	Method	Description
void	addAll(ChatHistory value)	Add all messages from the given chat history to this chat history
ChatHistory	addAll(List<ChatMessageContent<?>> messages)	Add all messages to the chat history
ChatHistory	addAssistantMessage(String content)	Add an assistant message to the chat history
ChatHistory	addMessage(AuthorRole authorRole, String content)	Add a message to the chat history
ChatHistory	addMessage(AuthorRole authorRole, String content, Charset encoding, FunctionResultMetadata<?> metadata)	Add a message to the chat history
ChatHistory	addMessage(ChatMessageContent<?> content)	Add a message to the chat history
ChatHistory	addSystemMessage(String content)	Add an system message to the chat history
ChatHistory	addUserMessage(String content)	Add a user message to the chat history
void	forEach(Consumer<? super ChatMessageContent<?>> action)	Perform the given action for each message in the chat history
Optional<ChatMessageContent<?>>	getLastMessage()	Get last message
List<ChatMessageContent<?>>	getMessages()	Get the chat history
Iterator<ChatMessageContent<?>>	iterator()	Create an Iterator from the chat history.
Spliterator<ChatMessageContent<?>>	spliterator()	Create a Spliterator from the chat history

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatHistory

public ChatHistory()

The default constructor

ChatHistory

public ChatHistory(@Nullable
                   String instructions)

Constructor that adds the given system instructions to the chat history.

Parameters:

instructions - The instructions to add to the chat history

ChatHistory

public ChatHistory(List<? extends ChatMessageContent<?>> chatMessageContents)

Constructor that adds the given chat message contents to the chat history.

Parameters:

chatMessageContents - The chat message contents to add to the chat history

Method Detail

getMessages

public List<ChatMessageContent<?>> getMessages()

Get the chat history

Returns:

List of messages in the chat

getLastMessage

public Optional<ChatMessageContent<?>> getLastMessage()

Get last message

Returns:

The most recent message in chat

addAll

public void addAll(ChatHistory value)

Add all messages from the given chat history to this chat history

Parameters:

value - The chat history to add to this chat history

iterator

public Iterator<ChatMessageContent<?>> iterator()

Create an Iterator from the chat history.

Specified by:

iterator in interface Iterable<ChatMessageContent<?>>

Returns:

An Iterator from the chat history.

forEach

public void forEach(Consumer<? super ChatMessageContent<?>> action)

Perform the given action for each message in the chat history

Specified by:

forEach in interface Iterable<ChatMessageContent<?>>

Parameters:

action - The action to perform for each message in the chat history

spliterator

public Spliterator<ChatMessageContent<?>> spliterator()

Create a Spliterator from the chat history

Specified by:

spliterator in interface Iterable<ChatMessageContent<?>>

Returns:

A Spliterator from the chat history

addMessage

public ChatHistory addMessage(AuthorRole authorRole,
                              String content,
                              Charset encoding,
                              FunctionResultMetadata<?> metadata)

Add a message to the chat history

Parameters:

authorRole - The role of the author of the message

content - The content of the message

encoding - The encoding of the message

metadata - The metadata of the message

Returns:

this ChatHistory

addMessage

public ChatHistory addMessage(AuthorRole authorRole,
                              String content)

Add a message to the chat history

Parameters:

authorRole - The role of the author of the message

content - The content of the message

Returns:

this ChatHistory

addMessage

public ChatHistory addMessage(ChatMessageContent<?> content)

Add a message to the chat history

Parameters:

content - The content of the message

Returns:

this ChatHistory

addUserMessage

public ChatHistory addUserMessage(String content)

Add a user message to the chat history

Parameters:

content - The content of the user message

Returns:

this ChatHistory

addAssistantMessage

public ChatHistory addAssistantMessage(String content)

Add an assistant message to the chat history

Parameters:

content - The content of the assistant message

Returns:

this ChatHistory

addSystemMessage

public ChatHistory addSystemMessage(String content)

Add an system message to the chat history

Parameters:

content - The content of the system message

Returns:

this ChatHistory

addAll

public ChatHistory addAll(List<ChatMessageContent<?>> messages)

Add all messages to the chat history

Parameters:

messages - The messages to add to the chat history

Returns:

this ChatHistory