removeMessage

September 27, 2024 · View on GitHub

Remove message from message history

updatedMessages = removeMessage(messages,messageIndex)

Description

updatedMessages = removeMessage(messages,messageIndex) removes an existing message from the specified position in the messageHistory object messages.

Examples

Add Response Message to Message History

Initialize the message history.

messages = messageHistory;

Add a user message to the message history.

messages = addUserMessage(messages,"Why is a raven like a writing desk?");

Remove the message from the message history.

messages = removeMessage(messages,1)

messages = 
  messageHistory with properties:

    Messages: {1x0 cell}

Input Arguments

`messages` — Message history

messageHistory object

Message history, specified as a messageHistory object.

`messageIndex` — Message index

positive integer

Index of the message to remove, specified as a positive integer.

Output Argument

`updatedMessages` — Updated message history

messageHistory object

Updated message history, specified as a messageHistory object.