adding tests and minor fixes.

matlab-deep-learning · Jan 16, 2024 · adbddc2 · adbddc2
1 parent bd780e2
commit adbddc2
Show file tree

Hide file tree

Showing 22 changed files with 780 additions and 441 deletions.
diff --git a/+llms/+internal/callOpenAIChatAPI.m b/+llms/+internal/callOpenAIChatAPI.m
@@ -1,6 +1,4 @@
 function [text, message, response] = callOpenAIChatAPI(messages, functions, nvp)
-% This function is undocumented and will change in a future release
-
 %callOpenAIChatAPI Calls the openAI chat completions API.
 %
 %   MESSAGES and FUNCTIONS should be structs matching the json format
@@ -52,7 +50,7 @@
 %   % Send a request
 %   [text, message] = llms.internal.callOpenAIChatAPI(messages, functions, ApiKey=apiKey)
 
-%   Copyright 2023 The MathWorks, Inc.
+%   Copyright 2023-2024 The MathWorks, Inc.
 
 arguments
     messages

diff --git a/+llms/+utils/errorMessageCatalog.m b/+llms/+utils/errorMessageCatalog.m
@@ -1,18 +1,15 @@
 classdef errorMessageCatalog
-% This class is undocumented and will change in a future release
-
 %errorMessageCatalog Stores the error messages from this repository
 
-%   Copyright 2023 The MathWorks, Inc.
+%   Copyright 2023-2024 The MathWorks, Inc.
+
     properties(Constant)
         %CATALOG dictionary mapping error ids to error msgs
         Catalog = buildErrorMessageCatalog;
     end
 
     methods(Static)
         function msg = getMessage(messageId, slot)
-            % This function is undocumented and will change in a future release
-
             %getMessage returns error message given a messageID and a SLOT.
             %   The value in SLOT should be ordered, where the n-th element
             %   will replace the value "{n}".
@@ -47,7 +44,12 @@
 catalog("llms:stopSequencesMustHaveMax4Elements") = "Number of elements must not be larger than 4.";
 catalog("llms:keyMustBeSpecified") = "API key not found as environment variable OPENAI_API_KEY and not specified via ApiKey parameter.";
 catalog("llms:mustHaveMessages") = "Value must contain at least one message in Messages.";
-catalog("llms:mustSetFunctionsForCall") = "When no functions are defined, FunctionCall must not be specified.";
+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.";
-end
-
+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:functionNotAvailableForModel") = "This function is not supported for ModelName '{1}'";
+catalog("llms:promptLimitCharacter") = "Prompt must have a maximum length of {1} characters for ModelName '{2}'";
+catalog("llms:pngExpected") = "Argument must be a PNG image.";
+catalog("llms:warningJsonInstruction") = "When using JSON mode, you must also prompt the model to produce JSON yourself via a system or user message.";
+end
diff --git a/examples/ExampleDALLE.mlx b/examples/ExampleDALLE.mlx
diff --git a/examples/ExampleFunctionCalling.mlx b/examples/ExampleFunctionCalling.mlx
diff --git a/examples/ExampleGPT4Vision.mlx b/examples/ExampleGPT4Vision.mlx
diff --git a/examples/ExampleJSONMode.mlx b/examples/ExampleJSONMode.mlx
diff --git a/examples/ExampleParallelFunctionCalls.mlx b/examples/ExampleParallelFunctionCalls.mlx
diff --git a/examples/ExampleStreaming.mlx b/examples/ExampleStreaming.mlx
diff --git a/examples/Example_DALL·E.mlx b/examples/Example_DALL·E.mlx
diff --git a/examples/Example_GPT4_Vision.mlx b/examples/Example_GPT4_Vision.mlx
diff --git a/examples/Example_JSON_Mode.mlx b/examples/Example_JSON_Mode.mlx
diff --git a/examples/Example_Parallel_Function_Calls.mlx b/examples/Example_Parallel_Function_Calls.mlx
diff --git a/examples/Example_Streaming.mlx b/examples/Example_Streaming.mlx
diff --git a/examples/images/bear_mask.png b/examples/images/bear_mask.png
diff --git a/examples/images/mask_bear.png b/examples/images/mask_bear.png
diff --git a/openAIChat.m b/openAIChat.m
@@ -66,7 +66,7 @@
 %       TimeOut              - Connection Timeout in seconds (default: 10 secs)
 %
 
-% Copyright 2023 The MathWorks, Inc.
+% Copyright 2023-2024 The MathWorks, Inc.
 
     properties        
         %TEMPERATURE   Temperature of generation.
@@ -83,10 +83,6 @@
 
         %FREQUENCYPENALTY   Penalty for using a token that is frequent in the training data.
         FrequencyPenalty
-
-        %RESPONSEFORMAT     Response format, text or json     
-        ResponseFormat
-
     end
 
     properties(SetAccess=private) 
@@ -101,6 +97,9 @@
 
         %SYSTEMPROMPT   System prompt.
         SystemPrompt = []
+
+        %RESPONSEFORMAT     Response format, text or json     
+        ResponseFormat 
     end
 
     properties(Access=private)
@@ -156,18 +155,19 @@
             this.Temperature = nvp.Temperature;
             this.TopProbabilityMass = nvp.TopProbabilityMass;
             this.StopSequences = nvp.StopSequences;
-            % Response Format is supported in the latest models only
-            if strcmp(nvp.ResponseFormat,"json")
+
+            % ResponseFormat is only supported in the latest models only
+            if (nvp.ResponseFormat == "json")
                 if ismember(this.ModelName,["gpt-3.5-turbo-1106","gpt-4-1106-preview"])
-                    if contains(this.SystemPrompt{1}.content,"designed to output to JSON")
-                        this.ResponseFormat = nvp.ResponseFormat;
-                    else
-                        error("To get JSON output, add 'designed to output to JSON' to the system prompt.")
-                    end
+                    warning("llms:warningJsonInstruction", ...
+                        llms.utils.errorMessageCatalog.getMessage("llms:warningJsonInstruction"))
                 else
-                    mustBeMember(this.ModelName,["gpt-3.5-turbo-1106","gpt-4-1106-preview"])
+                    error("llms:invalidOptionAndValueForModel", ...
+                        llms.utils.errorMessageCatalog.getMessage("llms:invalidOptionAndValueForModel", "ResponseFormat", "json", this.ModelName));
                 end
+
             end
+
             this.PresencePenalty = nvp.PresencePenalty;
             this.FrequencyPenalty = nvp.FrequencyPenalty;
             this.ApiKey = llms.internal.getApiKeyFromNvpOrEnv(nvp);