openai vba framework

Marco OpenAI-VBA

OpenAI-VBA-Framework es un conjunto de herramientas independiente para que los desarrolladores creen aplicaciones VBA con los modelos de lenguaje de OpenAI como GPT-4, ChatGPT y DALL-E. Ofrece un conjunto de clases para una fácil integración con la API de OpenAI. Tenga en cuenta que este proyecto no está asociado ni respaldado oficialmente por OpenAI.

Requisitos previos

• Deberá registrarse para obtener una cuenta OpenAI y crear una API_KEY. Puede hacer esto en la siguiente ubicación: Claves API de OpenAI

Clases principales

1. clsOpenAI - Clase principal para interactuar con OpenAI
2. clsOpenAILogger : clase de registro para depuración y seguimiento
3. clsOpenAIMessage : clase para manejar mensajes individuales
4. clsOpenAIMessages : clase para manejar colecciones de mensajes
5. clsOpenAIRequest - Clase para realizar solicitudes a OpenAI
6. clsOpenAIResponse : clase para manejar respuestas de OpenAI
7. IOpenAINameProvider : clase de interfaz para provisión de nombres

El módulo mdOpenAI_tests se proporciona para probar la funcionalidad del marco.

OpenAIFrameworkDemo.xlsm es un archivo que contiene todo el código del repositorio para fines de demostración. También se incluyen otros archivos en el repositorio para su control de versiones.

Uso

A continuación se muestran algunos ejemplos del uso del marco:

API de finalización 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

Creación de imágenes 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

Configuración

Puede personalizar OpenAI-VBA-Framework ajustando las propiedades en la clase 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>")

Instalación (a través de GIT)

1. Clona este repositorio usando el siguiente comando en tu línea de comando:

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

2. Abra Excel y presione ALT + F11 para abrir el editor VBA.
3. Desde la barra de herramientas seleccione Archivo -> Importar archivo....
4. Navegue hasta la ubicación del repositorio clonado y seleccione todos los archivos .cls y .bas y luego haga clic en Abrir.
5. Guarde el archivo de Excel como un libro de trabajo habilitado para macros .xlsm.

Solución de problemas

Puede consultar el estado de la API OpenAI aquí.

Puede obtener más información sobre los códigos de estado HTTP devueltos por la API aquí.

Para problemas de codificación, utilice la siguiente línea para revisar el código.

 oOpenAI.IsLogOutputRequired True

Todo el marco se puede probar para detectar cambios importantes utilizando el módulo mdTest_OpenAI . Simplemente ejecute el procedimiento RunAllTests .

Contribuyendo

Las solicitudes de extracción son bienvenidas. Para cambios importantes, primero abra un problema para discutir lo que le gustaría cambiar.

Licencia

Este proyecto está licenciado según los términos de la licencia MIT.