Awesome

1. Description

Easily access ChatGPT's awesome chatbot capabilies in Microsoft Word. This application captures the conversation history between a user and the chatbot. By utilizing conversation history, the chatbot can mimic an awareness of context and thus provide responses that make more sense. <br /><br />

https://user-images.githubusercontent.com/52817125/225483447-b59057f0-8cd8-4a75-9062-a0fb75ccf5ac.mp4

2. Getting Started

2.1 Dependencies

• Requires an OpenAI API Key (create an account and get API Key at <a href="https://chat.openai.com">https://chat.openai.com</a>)
• Requires Microsoft Windows 10/11 (<a href="https://www.microsoft.com/en-au/windows">https://www.microsoft.com/en-au/windows</a>)
• Requires Microsoft Word 365 (<a href="https://www.microsoft.com/en-us">https://www.microsoft.com/en-us</a>)

Please be aware of the costs associated with using the OpenAI API when utilizing this project.

2.2 AI Models

This application uses the following OpenAI model:

Further information about all OpenAI models can be found here: <a href="https://platform.openai.com/docs/models/overview">https://platform.openai.com/docs/models/overview</a>

We endeavour to test and integrate newer models when they are become Generally Available (GA). Models released as a 'Limited Beta' will not be integrated until they become GA.

2.3 OpenAI Status

Should you receive error messages for a period of 5 minutes or more, please check the Chat Uptime status at the following link: <a href="https://status.openai.com/">https://status.openai.com/</a>

3. Instructions

• To start a chat, write a message anywhere in Microsoft Word
• Select your message and click the Chat Completion button in the AI Assistant tab
• Wait for the model to respond
• The chat response will appear under initial message
• Repeat the steps above to continue the chat <br />

To chat about a new topic simply click the Chat Reset button in the AI Assistant tab

3.1 Chat Completion Example 1

User Message #1

Who won the world series in 2020?

Chatbot Reply

The Los Angeles Dodgers won the World Series in 2020.

User Message #2

Where was it played?

Chatbot Reply

The 2020 World Series was played in Arlington, Texas at Globe Life Field, the home stadium of the Texas Rangers.

<strong>Conversation Flow</strong>

User: Who won the world series in 2020?

Chatbot: The Los Angeles Dodgers won the World Series in 2020.

User: Where was it played?

Chatbot: The 2020 World Series was played in Arlington, Texas at Globe Life Field, the home stadium of the Texas Rangers.

4. Installation

There are 4 basic steps in order to add a ChatGPT button into Microsoft Word:

1. Enable the Developer Tab
2. Import the VBA script files
3. Create the Chat Completion and Chat Reset buttons
4. Add your OpenAI APIKey

Each of these steps are fully outlined below. <br /><br />

4.1 Enable the Developer Tab

The Developer tab isn't displayed by default, but you can add it to the ribbon.

Step 1 - On the File tab, go to Options > Customize Ribbon.

Step 2 - Under Customize the Ribbon and under Main Tabs, select the Developer check box.

The latest instructions to enable the Developer Tab from Microsoft can be found here: <a href="https://support.microsoft.com/en-us/office/show-the-developer-tab-in-word-e356706f-1891-4bb8-8d72-f57a51146792">https://support.microsoft.com/en-us/office/show-the-developer-tab-in-word-e356706f-1891-4bb8-8d72-f57a51146792</a> <br /><br />

4.2 Import the Chat.bas and ChatReset.bas files

Step 1 - Download and Save the latest Chat.bas and ChatReset.bas file from the src/windows folder in this repository. <br />

Keep the location of where the file is saved as you will need it later.<br /> <br />

Step 2 - On the Developer tab, click the Visual Basic button.

Step 3 - On the File tab, go to Import File...

Step 4 - Add the two .bas files

• Select the Chat.bas file and click Open
• Select the ChatReset.bas file and click Open <br /><br />

4.3 Add your Chat Completion and Chat Reset buttons into the Microsoft Word Ribbon

Please Note: This project closely relates to two of our other projects:

• Add ChatGPT to Microsoft Word - project found <a href="https://github.com/analyticsinmotion/add-chatgpt-to-microsoft-word">here</a>
• Create Images with DALL·E in Microsoft Word - project found <a href="https://github.com/analyticsinmotion/create-images-with-dall-e-in-microsoft-word">here</a>

If you have have already added one or both of these projects into Microsoft Word you can start at Step 3 of this section. <br /><br />

Step 1 - Add a new tab <br />

• On the File tab, go to Options > Customize Ribbon
• Click New Tab <br />

Step 2 - Rename the New Tab to AI Assistant

Step 3 - Rename New Group (Custom) to ChatBot

Step 4 - Select Macros in the Choose Commands from dropdown box

Step 5 - Select the Chat Macro and click Add >>

Step 6 - Rename button to Chat Completion, select a Symbol and click OK

Step 7 - Repeat Steps 5 & 6 to to create a Chat Reset button

• Ensure you select the ChatReset Macro to link to your Chat Reset button in this step <br />

After the preceding steps have been completed the Microsoft Word screen should look like the following:

4.4 Add your OpenAI APIKey into Windows

Step 1 - Open the Start menu and start typing "environment variables". When the best match appears click "Edit the system environment variables" result.

Step 2 - Click the "Environment variables" button under the "Advanced" tab.

Step 3 - Create a new user variable by clicking "New" under the "User Variables" section.

Step 4 - Type the variable name OPENAI_API_KEY in the first field and your OpenAI APIKEY in the variable value field. Then click OK.

Step 5 - IMPORTANT You must restart Windows to apply the new environment variable <br /><br />

5. Best Practices for API Key Safety

Your OpenAI APIKEY key/s should be kept secure and private at all times.

Please follow the best practices guide for API security from OpenAI <br /> <a href="https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety">https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety</a>