User guide

Adjusting the settings is the first task that you should do before being able to use the Add-On.
Start by going to Solwai > Settings.
The following dialog box opens:

API key for ChatGPT is what you need to let SOLWAI-ChatGPT Add-On connect to Chat GPT.
The following document explains in details who to create such a key:
https://www.howtogeek.com/885918/how-to-get-an-openai-api-key/

Tag to open and close prompt are a sequence of characters that you choose in order for the Add-On to identify prompts inside your document.
For example, following the above image, when the Add-On detects a line such as
<<: summarize the above text into only 3 lines :>>
It will consider it at a prompt that should be sent to chat GPT.

Treat prompts as independent from each other, let the Add-On execute each prompt separately from each other so that the result of the previous prompt is not taken into consideration by the next prompt.

Remove prompts after execution: as its name suggests this option instructs to remove the prompts from the document after execution.

The sidebar, is the panel on the right, that allows you to directly chat with ChatGPT.
The importance of this panel is that it permits a freestyle chat, or discussion regarding the content of the document, or a selection in this document.
The result may be included in the document using a single click on the context menu.

The image below shows a discussion between ChatGPT and a user seeking to write a “Service Agreement”.

Notice that the context menu allows the user to send the response to the document:

Sends the response to the current position of the cursor in the document

Appends the response to end of the document

Copies the response to the clipboard

In addition to that the Subject in the toolbar above the editor, specifies the context of the communication with ChatGPT:

Chat: this is a freestyle chatting

Selection: includes any selected text in the document with the message sent to ChatGPT

Document: includes the whole document with the message sent to ChatGPT

In-Text prompts are prompts similar to those written on ChatGPT, however they are identified in the document (to separate them from normal text) by the open and close tags as specified in the Settings (cf. Settings section).

When detecting prompts inside the document, the Add-on takes the prompt and any text before it then sends them to ChatGPT. The response is then inserted directly after the prompt.

When multiple prompts are detected inside the document, the Add-on takes each prompt and the text before it until the prompt that is above (or the start of the document).
Then each one is sent to ChatGPT.

Consider the following example. The document contains a text and a prompt (highlighted for clarity).

In order to execute this, you go to the menu Solwai > Scan for Prompts.

The following dialog box appears.

The System message is a way to give ChatGPT context of what you are trying to achieve.
In this example you are asking it to be a skillful writer.
The options Treat prompts as independent from each other, and Remove prompts after execution are the same as in the Settings.

When you click the Scan button, the Add-On will send the prompts and the related text to chatGPT and wait for a response. The response might take a few seconds to several minutes.

The result will be something similar to: