adding first version.

Author: debymf

+llms/+internal/callOpenAIChatAPI.m

@@ -0,0 +1,69 @@
+function [text, message, response] = callOpenAIChatAPI(messages, functions, nvp)
+    arguments
+        messages                
+        functions               
+        nvp.FunctionCall              
+        nvp.ModelName              
+        nvp.Temperature         
+        nvp.TopProbabilityMass               
+        nvp.NumCompletions      
+        nvp.StopSequences                
+        nvp.MaxNumTokens           
+        nvp.PresencePenalty                                   
+        nvp.FrequencyPenalty                                      
+        nvp.ApiKey      
+    end
+
+    END_POINT = "https://api.openai.com/v1/chat/completions";
+
+    parameters = buildParametersCall(messages, functions, nvp);
+
+    response = llms.internal.sendRequest(parameters,nvp.ApiKey, END_POINT);
+
+    if response.StatusCode=="OK"
+        message = response.Body.Data.choices(1).message;
+        if isfield(message, "function_call")
+            text = "";
+            message.function_call.arguments = message.function_call.arguments;
+        else
+            text = string(message.content);
+        end
+    else
+        text = "";
+        message = struct();
+    end
+end
+
+function parameters = buildParametersCall(messages, functions, nvp)
+    parameters = struct();
+    parameters.messages = messages;
+    if ~isempty(functions)
+        parameters.functions = functions;
+    end
+
+    if ~isempty(nvp.FunctionCall)
+        parameters.function_call = nvp.FunctionCall;
+    end
+
+    parameters.model = nvp.ModelName;
+
+    dict = mapNVPToParameters;
+    
+    nvpOptions = keys(dict);
+    for i=1:length(nvpOptions)
+        if isfield(nvp, nvpOptions(i))
+            parameters.(dict(nvpOptions(i))) = nvp.(nvpOptions(i));
+        end
+    end
+end
+
+function dict = mapNVPToParameters()
+    dict = dictionary();
+    dict("Temperature") = "temperature";
+    dict("TopProbabilityMass") = "top_p";
+    dict("NumCompletions") = "n";
+    dict("StopSequences") = "stop";
+    dict("MaxNumTokens") = "max_tokens";
+    dict("PresencePenalty") = "presence_penalty";
+    dict("FrequencyPenalty ") = "frequency_penalty";
+end

+llms/+internal/checkEnvOrNVP.m

@@ -0,0 +1,11 @@
+function key = checkEnvOrNVP(nvp)
+    if isfield(nvp, "ApiKey")
+        key = nvp.ApiKey;
+    else
+        if isenv("OPENAI_API_KEY")
+            key = getenv("OPENAI_API_KEY");
+        else
+            error("llms:keyMustBeSpecified", llms.utils.errorMessageCatalog.getMessage("llms:keyMustBeSpecified"));
+        end
+    end
+end

+llms/+internal/sendRequest.m

@@ -0,0 +1,15 @@
+function response = sendRequest(parameters, token, endpoint, consumer)
+    % Define the headers for the API request
+    
+    headers = matlab.net.http.HeaderField('Content-Type', 'application/json');
+    headers(2) = matlab.net.http.HeaderField('Authorization', 'Bearer ' + string(token));
+    % Define the request message
+    request = matlab.net.http.RequestMessage('post',headers,parameters);
+    % Send the request and store the response
+    if nargin==3
+        response = send(request, matlab.net.URI(endpoint));
+    else
+        response = send(request, matlab.net.URI(endpoint),[],consumer);
+    end   
+end
+

+llms/+utils/errorMessageCatalog.m

@@ -0,0 +1,40 @@
+classdef errorMessageCatalog
+    properties(Constant)
+        Catalog = buildErrorMessageCatalog;
+    end
+
+    methods(Static)
+        function msg = getMessage(messageId, slot)
+            arguments
+                messageId {mustBeNonzeroLengthText}
+            end
+            arguments(Repeating)
+                slot {mustBeNonzeroLengthText}
+            end
+            msg = llms.utils.errorMessageCatalog.Catalog(messageId);
+            if ~isempty(slot)
+                for i=1:numel(slot)
+                    msg = replace(msg,"{"+i+"}", slot{i});
+                end
+            end
+        end
+    end
+end
+
+function catalog = buildErrorMessageCatalog
+catalog = dictionary("string", "string");
+catalog("llms:mustBeUnique") = "Values must be unique.";
+catalog("llms:mustBeVarName") = "Parameter name must begin with a letter and contain not more than namelengthmax characters.";
+catalog("llms:parameterMustBeUnique") = "A parameter name equivalent to '{1}' already exists in Parameters. Redefining a parameter is not allowed.";
+catalog("llms:mustBeAssistantCall") = "Input struct must contain field 'role' with value 'assistant' and field 'content'.";
+catalog("llms:mustBeAssistantWithContent") = "Input struct must contain field 'content' containing text with one or more characters";
+catalog("llms:mustBeAssistantWithNameAndArguments") = "Field 'function_call' must be a struct with fields 'name' and 'arguments'";
+catalog("llms:assistantMustHaveTextNameAndArguments") = "Fields 'name' and 'arguments' must be text with one or more characters";
+catalog("llms:mustBeValidIndex") = "Value is larger than the number of elements in Messages ({0})";
+catalog("llms:stopSequencesMustHaveMax4Elements") = "Number of elements must not be larger than 4.";
+catalog("llms:keyMustBeSpecified") = "API key not found as enviroment variable OPEN_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:mustBeMessagesOrTxt") = "Messages must be text with one or more characters or an openAIMessages objects";
+end
+

+llms/+utils/isUnique.m

@@ -0,0 +1,4 @@
+function tf = isUnique(values)
+    tf = numel(values)==numel(unique(values));
+end
+

+llms/+utils/mustBeTextOrEmpty.m

@@ -0,0 +1,5 @@
+function mustBeTextOrEmpty(value)
+    if ~isempty(value)
+        mustBeTextScalar(value)
+    end
+end

SECURITY.md

@@ -0,0 +1,6 @@
+# Reporting Security Vulnerabilities 
+
+If you believe you have discovered a security vulnerability, please report it to 
+[security@mathworks.com](mailto:security@mathworks.com). Please see 
+[MathWorks Vulnerability Disclosure Policy for Security Researchers](https://www.mathworks.com/company/aboutus/policies_statements/vulnerability-disclosure-policy.html) 
+for additional information.  

examples/ExampleAgentCreation.mlx

@@ -0,0 +1,10 @@
+%% Example Title
+% Summary of example objective
+
+%% Section 1 Title
+% Description of first code block
+a = 1;
+
+%% Section 2 Title
+% Description of second code block
+b = 2;

examples/ExampleBasicUsage.mlx

@@ -0,0 +1,11 @@
+Copyright (c) 2023, The MathWorks, Inc.
+All rights reserved.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. In all cases, the software is, and all modifications and derivatives of the software shall be, licensed to you solely for use in conjunction with MathWorks products and service offerings. 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+
+