Stop warning in constructor for ResponseFormat="json"

Since we now throw an error when `ResponseFormat="json"` is used without the required `"json"` in the inputs, we can stop warning in the constructor. With the previous state, users got a warning they could not avoid, even in code doing everything correctly.
matlab-deep-learning · Nov 13, 2024 · 2d0ec2d · 2d0ec2d
1 parent 245e4b0
commit 2d0ec2d
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 25 deletions.
diff --git a/+llms/+openai/validateResponseFormat.m b/+llms/+openai/validateResponseFormat.m
@@ -18,9 +18,6 @@ function validateResponseFormat(format,model,messages)
                 error("llms:warningJsonInstruction", ...
                     llms.utils.errorMessageCatalog.getMessage("llms:warningJsonInstruction"))
             end
-        else
-            warning("llms:warningJsonInstruction", ...
-                llms.utils.errorMessageCatalog.getMessage("llms:warningJsonInstruction"))
         end
     elseif requestsStructuredOutput(format)
         if ~startsWith(model,"gpt-4o")

diff --git a/examples/AnalyzeSentimentinTextUsingChatGPTinJSONMode.md b/examples/AnalyzeSentimentinTextUsingChatGPTinJSONMode.md
@@ -48,10 +48,6 @@ model = "gpt-3.5-turbo";
 chat = openAIChat(systemPrompt, ModelName=model, ResponseFormat="json");
 ```
 
-```matlabTextOutput
-Warning: When using JSON mode, you must also prompt the model to produce JSON yourself via a system or user message.
-```
-
 Concatenate the prompt and input text and generate an answer with the model.
 
 ```matlab
@@ -67,7 +63,7 @@ Generate a response from the message.
 end
 ```
 
-Extract the data from the JSON ouput. 
+Extract the data from the JSON output. 
 
 ```matlab
 T = struct2table([scores{:}]);
@@ -78,10 +74,10 @@ T = movevars(T,"text","Before","sentiment")
 |:--:|:--:|:--:|:--:|
 |1|"I can't stand homework."|'negative'|0.9500|
 |2|"This sucks. I'm bored."|'negative'|0.9000|
-|3|"I can't wait for Halloween!!!"|'positive'|0.9500|
+|3|"I can't wait for Halloween!!!"|'positive'|1|
 |4|"I am neigher for or against the idea."|'neutral'|1|
 |5|"My cat is adorable ❤️❤️"|'positive'|0.9500|
-|6|"I hate chocolate"|'negative'|0.9000|
+|6|"I hate chocolate"|'negative'|1|
 
 
 *Copyright 2024 The MathWorks, Inc.*

diff --git a/examples/mlx-scripts/AnalyzeSentimentinTextUsingChatGPTinJSONMode.mlx b/examples/mlx-scripts/AnalyzeSentimentinTextUsingChatGPTinJSONMode.mlx
diff --git a/tests/hopenAIChat.m b/tests/hopenAIChat.m
@@ -297,14 +297,6 @@ function createChatWithStreamFunc(testCase)
             testCase.verifyGreaterThan(numel(sf("")), 1);
         end
 
-        function warningJSONResponseFormat(testCase)
-            chat = @() testCase.constructor("You are a useful assistant", ...
-                APIKey="this-is-not-a-real-key", ...
-                ResponseFormat="json");
-
-            testCase.verifyWarning(@()chat(), "llms:warningJsonInstruction");
-        end
-
         function errorJSONResponseFormat(testCase)
             testCase.verifyError( ...
                 @() generate(testCase.structuredModel,"create some address",ResponseFormat="json"), ...

diff --git a/tests/tazureChat.m b/tests/tazureChat.m
@@ -171,10 +171,6 @@ function deploymentNotFound(testCase)
             testCase.verifyError(@()azureChat, "llms:deploymentMustBeSpecified");
         end
 
-        % open TODOs for azureChat
-        function warningJSONResponseFormat(testCase)
-            testCase.assumeFail("TODO for azureChat");
-        end
     end
 end
 
@@ -194,6 +190,21 @@ function warningJSONResponseFormat(testCase)
                 "SystemPrompt", {[]}, ...
                 "ResponseFormat", {"text"} ...
             ) ...
+        ),...
+    "SomeSettings", struct( ...
+        "Input",{{"Temperature",1.23,"TopP",0.6,"TimeOut",120,"ResponseFormat","json"}}, ...
+        "ExpectedWarning", '', ...
+        "VerifyProperties", struct( ...
+                "Temperature", {1.23}, ...
+                "TopP", {0.6}, ...
+                "StopSequences", {string([])}, ...
+                "PresencePenalty", {0}, ...
+                "FrequencyPenalty", {0}, ...
+                "TimeOut", {120}, ...
+                "FunctionNames", {[]}, ...
+                "SystemPrompt", {[]}, ...
+                "ResponseFormat", {"json"} ...
+            ) ...
         ));
 end
 

diff --git a/tests/texampleTests.m b/tests/texampleTests.m
@@ -67,8 +67,7 @@ function testAnalyzeScientificPapersUsingFunctionCalls(testCase)
 
         function testAnalyzeSentimentinTextUsingChatGPTinJSONMode(testCase)
             testCase.startCapture("AnalyzeSentimentinTextUsingChatGPTinJSONMode");
-            testCase.verifyWarning(@AnalyzeSentimentinTextUsingChatGPTinJSONMode,...
-                "llms:warningJsonInstruction");
+            AnalyzeSentimentinTextUsingChatGPTinJSONMode;
         end
 
         function testAnalyzeTextDataUsingParallelFunctionCallwithChatGPT(testCase)

diff --git a/tests/topenAIChat.m b/tests/topenAIChat.m
@@ -340,7 +340,7 @@ function specialErrorForUnsupportedResponseFormat(testCase)
         ), ...
     "ResponseFormat", struct( ...
         "Input",{{"APIKey","this-is-not-a-real-key","ResponseFormat","json"}}, ...
-        "ExpectedWarning", "llms:warningJsonInstruction", ...
+        "ExpectedWarning", '', ...
         "VerifyProperties", struct( ...
                 "Temperature", {1}, ...
                 "TopP", {1}, ...