Add files via upload

Author: zq99

OpenAIFrameworkDemo.xlsm

@@ -155,6 +155,8 @@ For coding issues, use the following line, to go through the code.
 oOpenAI.IsLogOutputRequired True
 ```
 
+The entire framework can be tested for breaking changes using the mdTest_OpenAI module. Simply run the proceedure "RunAllTests".
+
 ## Contributing
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 

README.md

@@ -34,12 +34,19 @@ Attribute VB_Exposed = False
 
 Option Explicit
 
+#If VBA7 Then
+    Private Declare PtrSafe Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As LongPtr)
+#Else
+    Private Declare Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As Long)
+#End If
+
 Implements IOpenAINameProvider
 
 Private mstrAPI_KEY As String
 Private mobjHttpRequest As Object
 Private mobjLogger As clsOpenAILogger
 Private mobjRequest As clsOpenAIRequest
+Private mlngCallsToAPICount As Long
 
 'OpenAI API Endpoints
 Private Const API_ENDPOINT_CHAT As String = "https://api.openai.com/v1/chat/completions"
@@ -113,6 +120,14 @@ Public Property Let Model(ByVal value As String)
      mobjRequest.Model = value
 End Property
 
+Public Property Get Model() As String
+     Model = mobjRequest.Model
+End Property
+
+Public Property Get CallsToAPICount() As Long
+    CallsToAPICount = mlngCallsToAPICount
+End Property
+
 Public Property Let MaxTokens(ByVal value As Long)
     mobjRequest.MaxTokens = value
 End Property
@@ -128,6 +143,10 @@ Public Property Let Temperature(ByVal value As Double)
     mobjRequest.Temperature = value
 End Property
 
+Public Property Get Temperature() As Double
+    Temperature = mobjRequest.Temperature
+End Property
+
 Public Property Let FrequencyPenalty(ByVal value As Double)
     mobjRequest.FrequencyPenalty = value
 End Property
@@ -144,6 +163,10 @@ Public Property Get FolderToSaveTo() As String
     FolderToSaveTo = mstrFolderToSave
 End Property
 
+Public Sub Pause(Optional ByVal lngMilliSeconds As Long = 1000)
+    mobjLogger.PrintMessage ("Pausing for " & CStr(lngMilliSeconds) & " milliseconds")
+    Sleep lngMilliSeconds
+End Sub
 
 Public Sub IsLogOutputRequired(ByVal value As Boolean)
 'Purpose: Calling routines can switch off messages in this framework from appearing in the Immediate window
@@ -199,6 +222,8 @@ On Error GoTo ERR_HANDLER:
 
     If mobjHttpRequest.Status = HTTP_STATUS_OK Then
 
+        mlngCallsToAPICount = mlngCallsToAPICount + 1
+    
         'get the json result from the successful request
         strResponseJson = Trim(mobjHttpRequest.ResponseText)
         Log strResponseJson
@@ -239,6 +264,8 @@ End Function
 
 
 Private Function GetResponseObjectForImageParse(ByVal strResponseJson As String)
+'Purpose: this takes the response Json from the OpenAI api, and saves the information as a picture
+'         on the local PC, it then returns a response object with a reference to the picture created
 
     Set GetResponseObjectForImageParse = Nothing
 
@@ -368,6 +395,7 @@ Private Sub Class_Initialize()
     mobjLogger.SetClass Me
 
     mstrFolderToSave = DEFAULT_LOCAL_LOCATION
+    mlngCallsToAPICount = 0
 
     mstrAPI_KEY = Empty
 
@@ -402,6 +430,7 @@ Private Function GetDefaultRequestSettings() As clsOpenAIRequest
         .TimeoutSend = 60000
     End With
     Set GetDefaultRequestSettings = oRequest
+    mlngCallsToAPICount = 0
 
     Set oRequest = Nothing
 End Function

clsOpenAI.cls

@@ -106,6 +106,10 @@ Public Property Let Temperature(ByVal value As Double)
     mdblTemperature = value
 End Property
 
+Public Property Get Temperature() As Double
+    Temperature = mdblTemperature
+End Property
+
 Public Property Let FrequencyPenalty(ByVal value As Double)
     mdblFrequencyPenalty = value
 End Property

clsOpenAIRequest.cls

@@ -128,23 +128,26 @@ Public Property Let SavedLocalFile(ByVal value As String)
     mstrSavedFile = value
 End Property
 
+Public Function IsExistSavedLocalFile() As Boolean
+    IsExistSavedLocalFile = IIf(Len(Dir(mstrSavedFile)) > 0, True, False)
+End Function
 
 Private Sub Class_Initialize()
 ' Initialize the variables
-    mstrId = ""
-    mstrObject = ""
+    mstrId = Empty
+    mstrObject = Empty
     mstrCreated = 0
-    mstrModel = ""
+    mstrModel = Empty
     mintPromptTokens = 0
     mintCompletionTokens = 0
     mintTotalTokens = 0
-    mstrMessageRole = ""
-    mstrMessageContent = ""
-    mstrFinishReason = ""
+    mstrMessageRole = Empty
+    mstrMessageContent = Empty
+    mstrFinishReason = Empty
     mintIndex = 0
-    mstrText = ""
-    mstrLogprobs = ""
-    mstrSavedFile = ""
+    mstrText = Empty
+    mstrLogprobs = Empty
+    mstrSavedFile = Empty
 End Sub
 
 

clsOpenAIResponse.cls

@@ -7,7 +7,7 @@ Attribute VB_Name = "mdOpenAI_Examples"
 ' Author: Zaid Qureshi
 ' GitHub: https://github.com/zq99
 '
-' Modules in the Framework:
+' Classes / Modules in the Framework:
 ' - clsOpenAI
 ' - clsOpenAILogger
 ' - clsOpenAIMessage

mdOpenAI_Examples.bas

@@ -7,7 +7,7 @@ Attribute VB_Name = "mdOpenAI_TESTS"
 ' Author: Zaid Qureshi
 ' GitHub: https://github.com/zq99
 '
-' Modules in the Framework:
+' Classes / Modules in the Framework:
 ' - clsOpenAI
 ' - clsOpenAILogger
 ' - clsOpenAIMessage
@@ -26,12 +26,6 @@ Attribute VB_Name = "mdOpenAI_TESTS"
 
 Option Explicit
 
-#If VBA7 Then
-    Declare PtrSafe Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As LongPtr)
-#Else
-    Declare Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As Long)
-#End If
-
 '******************************************************
 ' GET YOUR API KEY: https://openai.com/api/
 Public Const API_KEY As String = "<API_KEY>"
@@ -48,23 +42,26 @@ Public Sub RunAllTests()
 
     oOpenAI.IsLogOutputRequired True
     oOpenAI.API_KEY = API_KEY
+    
+    Debug.Assert oOpenAI.API_KEY = API_KEY
+    Debug.Assert oOpenAI.CallsToAPICount = 0
 
     ' Assign all posssible MSXML types
     arrMSXMLTypes(1) = Empty
     arrMSXMLTypes(2) = oOpenAI.MSXML_XML_VALUE
     arrMSXMLTypes(3) = oOpenAI.MSXML_SERVER_XML_VALUE
 
-    ' Declare a variable for the loop index
     Dim i As Integer
 
     ' Loop through each item in the array
     For i = LBound(arrMSXMLTypes) To UBound(arrMSXMLTypes)
         DoEvents
         oOpenAI.Log arrMSXMLTypes(i)
         Call TestOpenAI(oOpenAI, arrMSXMLTypes(i))
-        Sleep 1000
+        oOpenAI.Pause
     Next i
-
+    
+    Debug.Assert oOpenAI.CallsToAPICount > 0
     Set oOpenAI = Nothing
 
 End Sub
@@ -76,43 +73,72 @@ Private Sub TestOpenAI(ByVal oOpenAI As clsOpenAI, Optional ByVal strRequestXMLT
     Dim oResponse As clsOpenAIResponse
 
     If strRequestXMLType <> Empty Then
-        oOpenAI.MSXMLType = oOpenAI.MSXML_SERVER_XML_VALUE
+        oOpenAI.MSXMLType = strRequestXMLType
+        Debug.Assert oOpenAI.MSXMLType = strRequestXMLType
     End If
 
-    'All output to sent to immediate window
+    'Test temperature can be changed
+    oOpenAI.Temperature = 0.9
+    Debug.Assert oOpenAI.Temperature = 0.9
+    
+    'Set least amount of variation for testing
     oOpenAI.Temperature = 0
+    Debug.Assert oOpenAI.Temperature = 0
 
     '*********************************************
     '(1) Simple chat test
     '*********************************************
 
-    oMessages.AddSystemMessage "Every answer should only contain alphanumeric characters, and every letter should be capitalized"
-    oMessages.AddUserMessage "What is the capital of France?"
-
-    Set oResponse = oOpenAI.ChatCompletion(oMessages)
+    'Test with different models
+    Dim arrModels(1 To 2) As String
+    Dim i As Integer
 
-    Debug.Assert Not oResponse Is Nothing
-    Debug.Assert Len(oResponse.MessageContent) > 0
-    Debug.Assert oResponse.MessageContent = "PARIS"
-    Debug.Assert oResponse.MessageRole = "assistant"
+    arrModels(1) = Empty
+    arrModels(2) = "gpt-4"
+    
+    For i = LBound(arrModels) To UBound(arrModels)
+    
+        DoEvents
 
-    oOpenAI.Log oMessages.GetAllMessages
-    oOpenAI.Log oResponse.MessageContent
-    oOpenAI.Log oResponse.MessageRole
+        If arrModels(i) <> Empty Then
+            oOpenAI.Model = arrModels(i)
+            Debug.Assert oOpenAI.Model = arrModels(i)
+        End If
+        
+        oOpenAI.Log "Testing with model: " & IIf(oOpenAI.Model = Empty, "[None]", oOpenAI.Model)
+    
+        oMessages.AddSystemMessage "Every answer should only contain alphanumeric characters, and every letter should be capitalized"
+        oMessages.AddUserMessage "What is the capital of France?"
+    
+        Set oResponse = oOpenAI.ChatCompletion(oMessages)
+        
+        Debug.Assert Not oResponse Is Nothing
+        Debug.Assert Len(oResponse.MessageContent) > 0
+        Debug.Assert oResponse.MessageContent = "PARIS"
+        Debug.Assert oResponse.MessageRole = "assistant"
+        
+        oOpenAI.Log oMessages.GetAllMessages
+        oOpenAI.Log oResponse.MessageContent
+        oOpenAI.Log oResponse.MessageRole
+        
+        oOpenAI.Pause
+    
+    Next i
 
     '*********************************************
     '(2) Simple chat test with temperature change
     '*********************************************
 
-    oMessages.AddUserMessage "write a string of digits in order up to 9"
-    oOpenAI.Temperature = 0.9
+    oMessages.AddUserMessage "write a string of digits in order up to 9 starting with 1 and ending with 9"
     Set oResponse = oOpenAI.ChatCompletion(oMessages)
 
     Debug.Assert Not oResponse Is Nothing
     Debug.Assert Len(oResponse.MessageContent) > 0
     Debug.Assert oResponse.MessageContent = "123456789"
     Debug.Assert oResponse.MessageRole = "assistant"
 
+    oOpenAI.Pause
+    
     '*********************************************
     '(3) Change timeouts
     '*********************************************
@@ -126,6 +152,8 @@ Private Sub TestOpenAI(ByVal oOpenAI As clsOpenAI, Optional ByVal strRequestXMLT
     Debug.Assert oResponse.MessageContent = "123456789"
     Debug.Assert oResponse.MessageRole = "assistant"
 
+    oOpenAI.Pause
+    
     '*********************************************
     '(4) Text completion test
     '*********************************************
@@ -134,6 +162,7 @@ Private Sub TestOpenAI(ByVal oOpenAI As clsOpenAI, Optional ByVal strRequestXMLT
 
     'reset to default
     oOpenAI.ClearSettings
+    Debug.Assert oOpenAI.CallsToAPICount = 0
 
     strMsg = "Write a Haiku about a dinosaur that loves to code in VBA"
     Set oResponse = oOpenAI.TextCompletion(strMsg)
@@ -142,16 +171,25 @@ Private Sub TestOpenAI(ByVal oOpenAI As clsOpenAI, Optional ByVal strRequestXMLT
     Debug.Assert Len(oResponse.TextContent) > 0
     oOpenAI.Log (oResponse.TextContent)
 
+    oOpenAI.Pause
+    
     '*********************************************
     '(5) Image creation from prompt test
     '*********************************************
 
     oOpenAI.ClearSettings
-    Set oResponse = oOpenAI.CreateImageFromText("A cat playing a banjo on a surfboard", 256, 256)
+    
+    strMsg = "A cat playing a banjo on a surfboard"
+    Set oResponse = oOpenAI.CreateImageFromText(strMsg, 256, 256)
 
     Debug.Assert Not oResponse Is Nothing
     Debug.Assert Len(oResponse.SavedLocalFile) > 0
     Debug.Assert Len(Dir(oResponse.SavedLocalFile)) > 0
+    Debug.Assert oResponse.IsExistSavedLocalFile = True
+    
+    oOpenAI.Log ("Prompt=" & strMsg)
+    oOpenAI.Log ("Image saved to: " & oResponse.SavedLocalFile)
+    oOpenAI.Pause
 
     Set oResponse = Nothing
     Set oMessages = Nothing