openai vba framework

Framework OpenAI-VBA

OpenAI-VBA-Framework est une boîte à outils indépendante permettant aux développeurs de créer des applications VBA avec les modèles de langage OpenAI tels que GPT-4, ChatGPT et DALL-E. Il propose une suite de classes pour une intégration facile avec l'API d'OpenAI. Veuillez noter que ce projet n'est pas officiellement associé ni approuvé par OpenAI.

Conditions préalables

• Vous devrez créer un compte OpenAI et créer une API_KEY. Vous pouvez le faire à l'emplacement suivant : Clés API OpenAI

Cours principaux

1. clsOpenAI - Classe principale pour interagir avec OpenAI
2. clsOpenAILogger - Classe de journalisation pour le débogage et le suivi
3. clsOpenAIMessage - Classe pour gérer les messages individuels
4. clsOpenAIMessages - Classe pour gérer les collections de messages
5. clsOpenAIRequest - Classe pour faire des requêtes à OpenAI
6. clsOpenAIResponse - Classe de gestion des réponses d'OpenAI
7. IOpenAINameProvider - Classe d'interface pour la fourniture de noms

Le module mdOpenAI_tests est fourni pour tester les fonctionnalités du framework.

OpenAIFrameworkDemo.xlsm est un fichier qui contient tout le code du référentiel à des fins de démonstration. D'autres fichiers sont également inclus dans le référentiel pour la gestion des versions.

Usage

Voici quelques exemples d’utilisation du framework :

API de complétion de chat

 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

Création d'images 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

Configuration

Vous pouvez personnaliser OpenAI-VBA-Framework en ajustant les propriétés dans la classe clsOpenAI :

 ' 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>")

Installation (via GIT)

1. Clonez ce dépôt à l'aide de la commande suivante dans votre ligne de commande :

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

2. Ouvrez Excel et appuyez sur ALT + F11 pour ouvrir l'éditeur VBA.
3. Dans la barre d'outils, sélectionnez Fichier -> Importer un fichier....
4. Accédez à l'emplacement du référentiel cloné et sélectionnez tous les fichiers .cls et .bas, puis cliquez sur Ouvrir.
5. Enregistrez le fichier Excel en tant que classeur prenant en charge les macros .xlsm.

Dépannage

Vous pouvez vérifier l'état de l'API OpenAI ici.

Vous pouvez obtenir plus d'informations sur les codes d'état HTTP renvoyés par l'API ici.

Pour les problèmes de codage, utilisez la ligne suivante pour parcourir le code.

 oOpenAI.IsLogOutputRequired True

L'ensemble du framework peut être testé pour détecter les modifications importantes à l'aide du module mdTest_OpenAI . Exécutez simplement la procédure RunAllTests .

Contribuer

Les demandes de tirage sont les bienvenues. Pour les changements majeurs, veuillez d'abord ouvrir un ticket pour discuter de ce que vous souhaitez changer.

Licence

Ce projet est sous licence selon les termes de la licence MIT.