Make model choices explicit in Open AI examples

Co-authored-by: Miriam Scharnke <[email protected]>

Author: 2 people

examples/AnalyzeScientificPapersUsingFunctionCalls.md

@@ -25,6 +25,9 @@ Set up the function to store paper details and initiate a chat with the OpenAI A
 
 Define the function that you want the model to have access to. In this example the used function is `writePaperDetails`.
 
+
+This example uses the model gpt\-4.1\-mini.
+
 ```matlab
 f = openAIFunction("writePaperDetails", "Function to write paper details to a table.");
 f = addParameter(f, "name", type="string", description="Name of the paper.");
@@ -33,9 +36,9 @@ f = addParameter(f, "explanation", type="string", description="Explanation on wh
 
 paperVerifier = openAIChat("You are an expert in filtering scientific papers. " + ...
     "Given a certain topic, you are able to decide if the paper" + ...
-    " fits the given topic or not.");
+    " fits the given topic or not.", ModelName="gpt-4.1-mini");
 
-paperExtractor = openAIChat("You are an expert in extracting information from a paper.", Tools=f);
+paperExtractor = openAIChat("You are an expert in extracting information from a paper.", Tools=f, ModelName="gpt-4.1-mini");
 
 function writePaperDetails(name, url, desc)
 filename = "papers_to_read.csv";

examples/AnalyzeSentimentinTextUsingChatGPTwithStructuredOutput.md

@@ -50,10 +50,10 @@ prototype = struct with fields:
 ```
 
 
-Create a chat object and set `ResponseFormat` to `prototype`.
+Create a chat object and set `ResponseFormat` to `prototype`. This example uses the model GPT\-4.1 nano.
 
 ```matlab
-chat = openAIChat(systemPrompt, ResponseFormat=prototype);
+chat = openAIChat(systemPrompt, ResponseFormat=prototype, ModelName="gpt-4.1-nano");
 ```
 
 Concatenate the prompt and input text and generate an answer with the model.
@@ -84,12 +84,12 @@ T = movevars(T,"text","Before","sentiment")
 |:--:|:--:|:--:|:--:|
 |1|"I can't stand homework."|negative|0.9500|
 |2|"This sucks. I'm bored."|negative|0.9500|
-|3|"I can't wait for Halloween!!!"|positive|0.9500|
-|4|"I am neither for nor against the idea."|neutral|0.9500|
+|3|"I can't wait for Halloween!!!"|positive|0.8500|
+|4|"I am neither for nor against the idea."|neutral|0.9000|
 |5|"My cat is adorable ❤️❤️"|positive|0.9500|
 |6|"I hate chocolate"|negative|0.9500|
-|7|"More work. Great."|negative|0.8500|
-|8|"More work. Great!"|positive|0.9000|
+|7|"More work. Great."|negative|0.8000|
+|8|"More work. Great!"|positive|0.8000|
 
 
 

examples/CreateSimpleChatBot.md

@@ -20,12 +20,12 @@ loadenv(".env")
 ```
 # Setup Model
 
-Set the maximum allowable number of words per chat session and define the keyword that, when entered by the user, ends the chat session. This example uses the model o1.
+Set the maximum allowable number of words per chat session and define the keyword that, when entered by the user, ends the chat session. This example uses the model GPT\-4.1 nano.
 
 ```matlab
 wordLimit = 2000;
 stopWord = "end";
-modelName = "o1";
+modelName = "gpt-4.1-nano";
 ```
 
 Create an instance of `openAIChat` to perform the chat and `messageHistory` to store the conversation history`.`
@@ -114,15 +114,15 @@ end
 
 ```matlabTextOutput
 User: Hello, how much do you know about physics?
-AI: I have broad knowledge spanning classical, relativistic, and quantum physics.
+AI: I know basics of physics, including classical mechanics, electromagnetism, thermodynamics, and modern physics.
 User: What is torque?
-AI: Torque is a measure of how a force causes rotational motion around an axis.
+AI: Torque is a measure of the rotational force applied to an object.
 User: What is force?
-AI: Force is an interaction that changes an object's state of motion.
+AI: Force is a push or pull that can cause an object to move or change motion.
 User: What is motion?
 AI: Motion is the change in an object's position over time.
 User: What is time?
-AI: Time is the dimension in which events occur sequentially from past to future.
+AI: Time is a measurable period during which events occur.
 User: end
 AI: Closing the chat. Have a great day!
 ```

examples/ProcessGeneratedTextinRealTimebyUsingChatGPTinStreamingMode.md

@@ -19,6 +19,9 @@ To run this example, you need a valid API key from a paid OpenAI™ API account.
 ```matlab
 loadenv(".env")
 ```
+
+This example uses the model GPT\-4.1 nano.
+
 # Print Stream Directly to Screen
 
 In this example, the streamed output is printed directly to the screen. 
@@ -35,7 +38,7 @@ end
 Create the chat object with the defined function as a handle. 
 
 ```matlab
-chat = openAIChat(StreamFun=@printToken);
+chat = openAIChat(StreamFun=@printToken, ModelName="gpt-4.1-nano");
 ```
 
 Generate response to a prompt in streaming mode. 
@@ -46,7 +49,15 @@ generate(chat, prompt, MaxNumTokens=500);
 ```
 
 ```matlabTextOutput
-Model-Based Design is an approach to system development that uses graphical models to design and simulate systems before implementing them in hardware or software. It involves creating models that represent the behavior and interactions of system components, and using these models to analyze, validate, and optimize the system before building it. Model-Based Design can help to improve the efficiency, reliability, and quality of system development by enabling engineers to explore design alternatives, detect errors early in the development process, and facilitate collaboration between different teams working on the same project.
+Model-Based Design (MBD) is a systematic methodology used in engineering and development processes where models—often graphical or mathematical representations—are employed to design, analyze, simulate, and verify complex systems before they are physically built. This approach enables engineers to visualize system behavior, perform simulations, and validate functionality early in the development cycle, thereby reducing costs, minimizing risks, and improving overall reliability.
+
+Key aspects of Model-Based Design include:
+- **Creating high-level models** of system components and interactions
+- **Simulating system behavior** to evaluate performance under various conditions
+- **Automatically generating code** from models for deployment on hardware
+- **Executing rapid prototyping and testing** within simulation environments
+
+MBD is widely used in industries like aerospace, automotive, and robotics, especially for embedded systems and control applications, as it streamlines development and enhances collaboration among multidisciplinary teams.
 ```
 
 # Print Stream to HTML UI Component
@@ -70,7 +81,7 @@ resetTable(h);
 Create the chat object with the function handle, which requires the `uihtml` object created earlier. 
 
 ```matlab
-chat = openAIChat(StreamFun=@(x)printStream(h,x));
+chat = openAIChat(StreamFun=@(x)printStream(h,x), ModelName="gpt-4.1-nano");
 ```
 
 Add the user prompt to the table in the HTML UI component.

examples/RetrievalAugmentedGenerationUsingChatGPTandMATLAB.md

@@ -64,13 +64,14 @@ Split the text data into paragraphs with the helper function `preprocessDocument
 documents = preprocessDocuments(str);
 ```
 
-Initialize the chatbot with a system prompt and API key. Include your API key in the environment variable `OPENAI_API_KEY` or pass your key using the `APIKey` name\-value pair.
+Initialize the chatbot with a system prompt and API key. Include your API key in the environment variable `OPENAI_API_KEY` or pass your key using the `APIKey` name\-value pair. This example uses the model GPT\-4.1 mini.
 
 ```matlab
 chat = openAIChat("You are a helpful assistant. You will get a " + ...
     "context for each question, but only use the information " + ...
     "in the context if that makes sense to answer the question. " + ...
-    "Let's think step-by-step, explaining how you reached the answer.");
+    "Let's think step-by-step, explaining how you reached the answer.", ...
+    ModelName="gpt-4.1-mini");
 ```
 # Retrieve Relevant Documents
 
@@ -123,18 +124,41 @@ wrapText(response)
 
 ```matlabTextOutput
 ans = 
-    "The context provides information on how technical criteria can be used to 
-     streamline new approvals for grid-friendly DPV. It mentions that technical 
-     approvals for DPV installations to connect to the grid can be streamlined with 
-     prudent screening criteria for systems that meet certain specifications. 
-     Additionally, it emphasizes the importance of having a grid code that reflects 
-     expected future growth of distributed energy resources.
+    "To streamline new approvals for grid-friendly distributed photovoltaics (DPV), 
+     prudent technical criteria can be applied that balance deployment with the 
+     technical requirements of the distribution system. Specifically:
      
-     Therefore, the technical criteria that can be used to streamline new approvals 
-     for grid-friendly DPV include having prudent screening criteria based on 
-     specific specifications and ensuring that the grid code is in line with the 
-     expected growth of distributed resources. This helps in facilitating the 
-     connection of DPV installations to the grid efficiently and effectively."
+1. **Technical Screening Criteria**: Utilities can use technical screening
+     criteria based on metrics relevant to the impact of DPV on low-voltage 
+     distribution grids. For example, limiting DPV capacity relative to the minimum 
+     feeder daytime load helps prevent technical issues.
+     
+     2. **Hosting Capacity Calculations**: These calculations estimate the point at 
+     which DPV penetration would induce technical impacts on system operation. 
+     Screening criteria derived from these calculations allow utilities to set 
+     limits that ensure grid stability.
+     
+     3. **Connection Size Limits**: Some regulations specify maximum DPV 
+     installation sizes relative to customer peak load (e.g., 80 percent of peak 
+     load in India), serving as a straightforward technical criterion for approval.
+     
+     4. **Advanced Inverter Functions**: Specifying that inverters have advanced 
+     capabilities such as reactive power control and active power curtailment before 
+     connection approval helps maintain grid stability and voltage management.
+     
+     5. **Grid Codes Reflecting DPV Growth**: Adopting or updating grid codes to 
+     include expected growth of distributed energy resources and requirements for 
+     inverter functionalities streamlines approvals by setting clear technical 
+     standards.
+     
+     6. **Cost-effective and Forward-looking Measures**: The criteria should be easy 
+     to implement, cost-efficient, and anticipate future system integration needs, 
+     helping avoid costly retrofits.
+     
+     Thus, prudent technical criteria include setting size limits relative to load, 
+     applying hosting capacity-based screens, requiring advanced inverter 
+     functionalities, and updating grid codes to reflect DPV penetration—all 
+     facilitating streamlined, grid-friendly DPV approvals."
 
 ```
 

examples/SummarizeLargeDocumentsUsingChatGPTandMATLAB.md

@@ -48,10 +48,10 @@ chunks = createChunks(incrementalSummary, limitChunkWords);
 ```
 # Summarize Chunks
 
-Initialize a ChatGPT session with the role of summarizing text
+Initialize a ChatGPT session with the role of summarizing text. This example uses the model GPT\-4.1 nano.
 
 ```matlab
-summarizer = openAIChat("You are a professional summarizer.");
+summarizer = openAIChat("You are a professional summarizer.", ModelName="gpt-4.1-nano");
 ```
 
 Looping process to gradually summarize the text chunk by chunk, reducing the chunk size with each iteration. 
@@ -99,11 +99,17 @@ wrapText(fullSummary)
 
 ```matlabTextOutput
 ans = 
-    ""Alice's Adventures in Wonderland" by Lewis Carroll follows the whimsical journey of a young girl, Alice, who falls into a fantastical world through a rabbit hole.
-     Throughout her adventures, Alice encounters a series of peculiar characters and bizarre events while trying to find her way back home.
-     She navigates through surreal situations such as a Caucus-race with talking animals, converses with a cryptic Caterpillar about identity and size changes, and experiences a mad tea party with the March Hare and the Hatter.
-     Alice also interacts with the Queen of Hearts during a chaotic croquet game, intervenes in a trial involving the theft of tarts, and meets the Mock Turtle and Gryphon who share odd stories and engage in whimsical discussions about lobsters and fish tails.
-     The narrative is filled with illogical and imaginative elements, capturing readers' imaginations with its colorful and eccentric storytelling."
+    "The excerpt from Lewis Carroll's "Alice’s Adventures in Wonderland" vividly depicts Alice’s fantastical journey through a surreal and whimsical realm filled with eccentric characters, bizarre settings, and illogical scenarios.
+     Initially, Alice adventures down a rabbit-hole while chasing the White Rabbit with a pocket watch, leading her into Wonderland, a land of constant size changes and peculiar encounters.
+     She consumes mysterious cakes and potions that cause her to shrink or grow, sometimes making her over nine feet tall and other times too small to fit through doors, exemplifying the whimsical logic of the world.
+     Throughout her travels, Alice interacts with a diverse array of characters, including the White Rabbit, a grumpy Caterpillar smoking a hookah who challenges her understanding of identity, the Cheshire Cat offering cryptic advice, the Duchess with her sarcastic banter, and various animals engaged in nonsensical activities.
+     She explores strange environments such as a locked hall with a tiny door leading to a beautiful garden, chaotic kitchens, and a garden where roses are painted white.
+     Notable scenes include the humorous Caucus-race where everyone wins prizes, Alice helping the White Rabbit find his gloves and fan, and her participation in a mad tea-party hosted by the March Hare and the Hatter, featuring riddles like “Why is a raven like a writing-desk?”
+     and conversations about manipulating time and living at the bottom of a treacle well.
+     Alice also witnesses the Queen of Hearts’ violent temper during a chaotic game of croquet using live hedgehogs and flamingoes, and observes a courtroom trial over stolen tarts with improbable evidence and absurd proceedings, satirizing judicial processes.
+     Throughout her journey, Alice experiences moments of wonder, confusion, frustration, and curiosity.
+     She contemplates her identity, questions her surroundings, and navigates the illogical world with a playful sense of imagination.
+     The narrative's surreal and humorous tone highlights themes of curiosity, nonsense, authority, and the blurring of reality and imagination, creating a richly satirical and whimsical portrayal of Wonderland’s chaotic, absurd universe."
 
 ```