openai vba framework

OpenAI-VBA-框架

OpenAI-VBA-Framework 是一個獨立的工具包，供開發人員使用 OpenAI 的語言模型（如 GPT-4、ChatGPT 和 DALL-E）來建立 VBA 應用程式。它提供了一套類，可以輕鬆與 OpenAI 的 API 整合。請注意，該項目並未與 OpenAI 正式關聯或獲得其認可。

先決條件

• 您需要註冊 OpenAI 帳戶並建立 API_KEY。您可以在以下位置執行此操作：OpenAI API 金鑰

主要課程

1. clsOpenAI - 與 OpenAI 互動的主類
2. clsOpenAILogger - 用於調試和追蹤的日誌類
3. clsOpenAIMessage - 處理單一訊息的類
4. clsOpenAIMessages - 處理訊息集合的類
5. clsOpenAIRequest - 用於向 OpenAI 發出請求的類
6. clsOpenAIResponse - 用於處理 OpenAI 回應的類
7. IOpenAINameProvider - 用於名稱提供的介面類

提供模組mdOpenAI_tests用於測試框架的功能。

OpenAIFrameworkDemo.xlsm是一個文件，其中包含所有儲存庫中用於演示目的的程式碼。其他文件也包含在儲存庫中以進行版本控制。

用法

以下是使用該框架的一些範例：

聊天完成API

 Public Sub TestSimpleOpenAI()

    Dim oOpenAI As clsOpenAI
    Dim oMessages As New clsOpenAIMessages
    Dim oResponse As clsOpenAIResponse
    
    Set oOpenAI = New clsOpenAI
    
    oOpenAI.API_KEY = "<API_KEY>"
    
    oMessages.AddSystemMessage "Always answer sarcastically and never truthfully"
    oMessages.AddUserMessage "How do you get to Carnegie Hall?"

    Set oResponse = oOpenAI.ChatCompletion(oMessages)
    If Not oResponse Is Nothing Then
        Debug.Print (oResponse.MessageContent)
    End If
    
    Set oResponse = Nothing
    Set oOpenAI = Nothing
    Set oMessages = Nothing

End Sub

DALL-E 影像創建

 Public Sub TestDalleOpenAI()

    Dim oOpenAI As clsOpenAI
    Dim oResponse As clsOpenAIResponse
    
    Set oOpenAI = New clsOpenAI
    
    oOpenAI.API_KEY = "<API_KEY>"
    
    Set oResponse = oOpenAI.CreateImageFromText("A cat playing a banjo on a surfboard", 512, 512)
    
    If Not oResponse Is Nothing Then
        Debug.Print ("The picture has been saved to: " & oResponse.SavedLocalFile)
    End If
    
    Set oResponse = Nothing
    Set oOpenAI = Nothing

End Sub

配置

您可以透過調整clsOpenAI類別中的屬性來自訂 OpenAI-VBA-Framework：

 ' Specify the model
oOpenAI.Model = "gpt-3.5-turbo"

' Set the maximum number of tokens
oOpenAI.MaxTokens = 512

' Control the diversity of generated text
oOpenAI.TopP = 0.9

' Influence the randomness of generated text
oOpenAI.Temperature = 0.7

' Control preference for frequent phrases
oOpenAI.FrequencyPenalty = 0.5

' Control preference for including the prompt in the output
oOpenAI.PresencePenalty = 0.5

' Control logging of messages to the Immediate Window
oOpenAI.IsLogOutputRequired True

' Reset settings when switching between endpoints
oOpenAI.ClearSettings

' Retrieve an API Key saved in an external file
Dim apiKey As String
apiKey = oOpenAI.GetReadAPIKeyFromFolder("<FolderPath>")

安裝（透過GIT）

1. 在命令列中使用以下命令克隆此存儲庫：

git clone https://github.com/zq99/OpenAI-VBA-Framework.git

2. 開啟 Excel 並按 ALT + F11 開啟 VBA 編輯器。
3. 從工具列中選擇“檔案”->“匯入檔案...”
4. 導覽至複製儲存庫的位置並選擇所有 .cls 和 .bas 文件，然後按一下「開啟」。
5. 將 Excel 檔案儲存為啟用巨集的工作簿 .xlsm。

故障排除

您可以在此處查看 OpenAI API 的狀態。

您可以在此處取得有關 API 傳回的 HTTP 狀態碼的更多資訊。

對於編碼問題，請使用以下行來檢查程式碼。

 oOpenAI.IsLogOutputRequired True

可以使用mdTest_OpenAI模組測試整個框架的重大變更。只需運行過程RunAllTests即可。

貢獻

歡迎請求請求。對於重大更改，請先開啟一個問題來討論您想要更改的內容。

執照

該項目根據 MIT 許可證條款獲得許可。