Rename openAIMessages to messageHistory

Author: ccreutzi

+llms/+utils/errorMessageCatalog.m

@@ -46,7 +46,7 @@
 catalog("llms:keyMustBeSpecified") = "Unable to find API key. Either set environment variable {1} or specify name-value argument ""APIKey"".";
 catalog("llms:mustHaveMessages") = "Value must contain at least one message in Messages.";
 catalog("llms:mustSetFunctionsForCall") = "When no functions are defined, ToolChoice must not be specified.";
-catalog("llms:mustBeMessagesOrTxt") = "Messages must be text with one or more characters or an openAIMessages objects.";
+catalog("llms:mustBeMessagesOrTxt") = "Messages must be text with one or more characters or a messageHistory object.";
 catalog("llms:invalidOptionAndValueForModel") = "'{1}' with value '{2}' is not supported for ModelName '{3}'";
 catalog("llms:invalidOptionForModel") = "{1} is not supported for ModelName '{2}'";
 catalog("llms:invalidContentTypeForModel") = "{1} is not supported for ModelName '{2}'";

README.md

@@ -134,10 +134,10 @@ txt = generate(chat,"The team is feeling very motivated")
 
 If you want to create a chat system, you will have to create a history of the conversation and pass that to the `generate` function.
 
-To start a conversation history, create a `openAIMessages` object:
+To start a conversation history, create a `messageHistory` object:
 
 ```matlab
-history = openAIMessages;
+history = messageHistory;
 ```
 
 Then create the chat assistant:
@@ -146,7 +146,7 @@ Then create the chat assistant:
 chat = openAIChat("You are a helpful AI assistant.");
 ```
 
-(Side note: `azureChat` and `ollamaChat` work with `openAIMessages`, too.)
+(Side note: `azureChat` and `ollamaChat` work with `messageHistory`, too.)
 
 Add a user message to the history and pass it to `generate`:
 
@@ -197,7 +197,7 @@ chat = openAIChat("You are a helpful assistant.",Tools=f);
 When the model identifies that it could use the defined functions to answer a query, it will return a `tool_calls` request, instead of directly generating the response:
 
 ```matlab
-messages = openAIMessages;
+messages = messageHistory;
 messages = addUserMessage(messages, "What is the sine of 30?");
 [txt, response] = generate(chat, messages);
 messages = addResponseMessage(messages, response);
@@ -287,7 +287,7 @@ Note that this function does not need to exist, since it will only be used to ex
 ```matlab
 chat = openAIChat("You are helpful assistant that reads patient records and extracts information", ...
     Tools=f);
-messages = openAIMessages;
+messages = messageHistory;
 messages = addUserMessage(messages,"Extract the information from the report:" + newline + patientReport);
 [txt, response] = generate(chat, messages);
 ```
@@ -332,7 +332,7 @@ You can use gpt-4-turbo to experiment with image understanding.
 ```matlab
 chat = openAIChat("You are an AI assistant.", ModelName="gpt-4-turbo");
 image_path = "peppers.png";
-messages = openAIMessages;
+messages = messageHistory;
 messages = addUserMessageWithImages(messages,"What is in the image?",image_path);
 [txt,response] = generate(chat,messages,MaxNumTokens=4096);
 % Should output the description of the image
@@ -357,8 +357,8 @@ After establishing your connection with Azure, you can continue using the `gener
 % Initialize the Azure Chat object, passing a system prompt and specifying the API version
 chat = azureChat(YOUR_RESOURCE_NAME, YOUR_DEPLOYMENT_NAME, "You are a helpful AI assistant", APIVersion="2023-12-01-preview");
 
-% Create an openAIMessages object to start the conversation history
-history = openAIMessages;
+% Create a messageHistory object to start the conversation history
+history = messageHistory;
 
 % Ask your question and store it in the history, create the response using the generate method, and store the response in the history 
 history = addUserMessage(history,"What is an eigenvalue?");
@@ -382,8 +382,8 @@ In many workflows, `ollamaChat` is drop-in compatible with `openAIChat`:
 % Initialize the chat object
 chat = ollamaChat("phi3");
 
-% Create an openAIMessages object to start the conversation history
-history = openAIMessages;
+% Create a messageHistory object to start the conversation history
+history = messageHistory;
 
 % Ask your question and store it in the history, create the response using the generate method, and store the response in the history 
 history = addUserMessage(history,"What is an eigenvalue?");

azureChat.m

@@ -261,7 +261,7 @@ function mustBeNonzeroLengthTextScalar(content)
 end
 
 function mustBeValidMsgs(value)
-if isa(value, "openAIMessages")
+if isa(value, "messageHistory")
     if numel(value.Messages) == 0
         error("llms:mustHaveMessages", llms.utils.errorMessageCatalog.getMessage("llms:mustHaveMessages"));
     end

examples/AnalyzeTextDataUsingParallelFunctionCallwithChatGPT.mlx

@@ -27,7 +27,7 @@
         "inputs":
         [
             {"name":"this","kind":"required","type":["openAIChat","scalar"]},
-            {"name":"messages","kind":"required","type":[["openAIMessages","row"],["string","scalar"]]},
+            {"name":"messages","kind":"required","type":[["messageHistory","row"],["string","scalar"]]},
             {"name":"NumCompletions","kind":"namevalue","type":["numeric","scalar","integer","positive"]},
             {"name":"MaxNumTokens","kind":"namevalue","type":["numeric","scalar","positive"]},
             {"name":"ToolChoice","kind":"namevalue","type":"choices=[\"none\",\"auto\",this.FunctionNames]"},
@@ -69,7 +69,7 @@
         "inputs":
         [
             {"name":"this","kind":"required","type":["azureChat","scalar"]},
-            {"name":"messages","kind":"required","type":[["openAIMessages","row"],["string","scalar"]]},
+            {"name":"messages","kind":"required","type":[["messageHistory","row"],["string","scalar"]]},
             {"name":"NumCompletions","kind":"namevalue","type":["numeric","scalar","integer","positive"]},
             {"name":"MaxNumTokens","kind":"namevalue","type":["numeric","scalar","positive"]},
             {"name":"ToolChoice","kind":"namevalue","type":"choices=[\"none\",\"auto\",this.FunctionNames]"},
@@ -107,7 +107,7 @@
         "inputs":
         [
             {"name":"this","kind":"required","type":["ollamaChat","scalar"]},
-            {"name":"messages","kind":"required","type":[["openAIMessages","row"],["string","scalar"]]},
+            {"name":"messages","kind":"required","type":[["messageHistory","row"],["string","scalar"]]},
             {"name":"NumCompletions","kind":"namevalue","type":["numeric","scalar","integer","positive"]},
             {"name":"MaxNumTokens","kind":"namevalue","type":["numeric","scalar","positive"]},
             {"name":"Seed","kind":"namevalue","type":["numeric","integer","scalar"]}

examples/CreateSimpleChatBot.mlx

@@ -1,8 +1,8 @@
-classdef (Sealed) openAIMessages   
-    %openAIMessages - Create an object to manage and store messages in a conversation.
-    %   messages = openAIMessages creates an openAIMessages object.
+classdef (Sealed) messageHistory   
+    %messageHistory - Create an object to manage and store messages in a conversation.
+    %   messages = messageHistory creates a messageHistory object.
     %
-    %   openAIMessages functions:
+    %   messageHistory functions:
     %       addSystemMessage         - Add system message.
     %       addUserMessage           - Add user message.
     %       addUserMessageWithImages - Add user message with images for
@@ -11,7 +11,7 @@
     %       addResponseMessage       - Add a response message.
     %       removeMessage            - Remove message from history.
     %
-    %   openAIMessages properties:
+    %   messageHistory properties:
     %       Messages                 - Messages in the conversation history.
 
     % Copyright 2023-2024 The MathWorks, Inc.
@@ -31,7 +31,7 @@
             %
             %   Example:
             %   % Create messages object
-            %   messages = openAIMessages;
+            %   messages = messageHistory;
             %
             %   % Add system messages to provide examples of the conversation
             %   messages = addSystemMessage(messages, "example_user", "Hello, how are you?");
@@ -40,7 +40,7 @@
             %   messages = addSystemMessage(messages, "example_assistant", "O céu está lindo hoje.");
 
             arguments
-                this (1,1) openAIMessages 
+                this (1,1) messageHistory 
                 name {mustBeNonzeroLengthTextScalar}
                 content {mustBeNonzeroLengthTextScalar}
             end
@@ -57,13 +57,13 @@
             %
             %   Example:
             %   % Create messages object
-            %   messages = openAIMessages;
+            %   messages = messageHistory;
             %
             %   % Add user message
             %   messages = addUserMessage(messages, "Where is Natick located?");
 
             arguments
-                this (1,1) openAIMessages
+                this (1,1) messageHistory
                 content {mustBeNonzeroLengthTextScalar}
             end
 
@@ -94,7 +94,7 @@
             %   chat = openAIChat("You are an AI assistant.", ModelName="gpt-4-vision-preview"); 
             %
             %   % Create messages object
-            %   messages = openAIMessages;
+            %   messages = messageHistory;
             %
             %   % Add user message with an image
             %   content = "What is in this picture?"
@@ -105,7 +105,7 @@
             %   [text, response] = generate(chat, messages, MaxNumTokens=300);
 
             arguments
-                this (1,1) openAIMessages
+                this (1,1) messageHistory
                 content {mustBeNonzeroLengthTextScalar}
                 images (1,:) {mustBeNonzeroLengthText}
                 nvp.Detail string {mustBeMember(nvp.Detail,["low","high","auto"])} = "auto"
@@ -148,14 +148,14 @@
             %
             %   Example:
             %   % Create messages object
-            %   messages = openAIMessages;
+            %   messages = messageHistory;
             %
             %   % Add function message, containing the result of 
             %   % calling strcat("Hello", " World")
             %   messages = addToolMessage(messages, "call_123", "strcat", "Hello World");
 
             arguments
-                this (1,1) openAIMessages
+                this (1,1) messageHistory
                 id {mustBeNonzeroLengthTextScalar}
                 name {mustBeNonzeroLengthTextScalar}
                 content {mustBeNonzeroLengthTextScalar}
@@ -182,7 +182,7 @@
             %   chat = openAIChat("You are a helpful AI Assistant.");
             %
             %   % Create messages object
-            %   messages = openAIMessages;
+            %   messages = messageHistory;
             %
             %   % Add user message
             %   messages = addUserMessage(messages, "What is the capital of England?");
@@ -194,7 +194,7 @@
             %   messages = addResponseMessage(messages, response);
 
             arguments
-                this (1,1) openAIMessages
+                this (1,1) messageHistory
                 messageStruct (1,1) struct
             end
 
@@ -223,7 +223,7 @@
             %   Example:
             %
             %   % Create messages object
-            %   messages = openAIMessages;
+            %   messages = messageHistory;
             %
             %   % Add user messages
             %   messages = addUserMessage(messages, "What is the capital of England?");
@@ -233,7 +233,7 @@
             %   messages = removeMessage(messages,1);
 
             arguments
-                this (1,1) openAIMessages
+                this (1,1) messageHistory
                 idx (1,1) {mustBeInteger, mustBePositive}
             end
             if idx>numel(this.Messages)
@@ -247,7 +247,7 @@
 
         function this = addAssistantMessage(this, content, toolCalls)
             arguments
-                this (1,1) openAIMessages
+                this (1,1) messageHistory
                 content string
                 toolCalls struct = []
             end

examples/DescribeImagesUsingChatGPT.mlx

@@ -187,7 +187,7 @@
 end
 
 function mustBeValidMsgs(value)
-if isa(value, "openAIMessages")
+if isa(value, "messageHistory")
     if numel(value.Messages) == 0
         error("llms:mustHaveMessages", llms.utils.errorMessageCatalog.getMessage("llms:mustHaveMessages"));
     end

functionSignatures.json

@@ -249,7 +249,7 @@ function mustBeNonzeroLengthTextScalar(content)
 end
 
 function mustBeValidMsgs(value)
-if isa(value, "openAIMessages")
+if isa(value, "messageHistory")
     if numel(value.Messages) == 0
         error("llms:mustHaveMessages", llms.utils.errorMessageCatalog.getMessage("llms:mustHaveMessages"));
     end