User guide - AI Assist for Confluence

Owned by Rick van Twillert
Last updated: 27 Mar 2023
3 min read

Welcome to the user guide for the app AI Assist for Confluence! This app allows you to utilize the power of OpenAI to assist you in generating content for your Confluence pages.

Topics in this user guide:

Walkthrough video

Step-by-step guide

  1. Select text: To use the app, start by selecting the text you want to use as input for OpenAI. Highlight the text with your mouse or keyboard, as you normally would when selecting text.

  2. Open the app: Once you've selected the text, you can open the app in one of two ways:

    1. Context menu: Right-click on the selected text and choose AI Assist from the context menu.

    2. Keyboard shortcut: type a i on your keyboard.

  3. Fill in the required fields: After opening the app, you will see a popup where you need to fill in your OpenAI API key/bearer token and an instruction for OpenAI on what to do with the selected text. These are mandatory fields and must be filled in before you can proceed.

  4. Submit your request: Once you've filled in the required fields, click the AI Assist button to submit your request to OpenAI. This may take a few seconds, but once OpenAI processed you request, the result will be displayed on the next screen. Please read our app's data security and privacy statement on submitting data to OpenAI.

  5. Choose what to do next: After you've received the response from OpenAI, you can choose to either:

    1. Go back and modify your request by clicking on the Go back button. You'll be taken to the previous screen.

    2. Add the response as an inline comment to the selected text on the Confluence page. To add the response as an inline comment, simply click the Add as inline comment button. You will need to refresh the page to see the comment after it has been created.

    3. Close AI Assist by clicking anywhere outside of the popup.

And that's it! You've successfully used the AI Assist for Confluence app to generate content for your Confluence pages. Remember, this app is powered by OpenAI, so the quality of the response will depend on the quality of your input and the capabilities of OpenAI.

Installation

If you haven't already installed the AI Assist for Confluence app, navigate to the Atlassian Marketplace and install it to your Confluence instance.

Installing apps on Confluence requires Confluence administrative permissions

Troubleshooting

To access information about known issues, limitations, and troubleshooting, please follow this link:

Best practices and tips & tricks

To learn more about best practices, tips, and tricks in using AI assist for Confluence, please follow this link:

FAQ

To find answers to the most commonly asked questions about AI Assist for Confluence, please refer to our FAQ pages:

 

We hope that this user guide has helped you to better understand AI Assist for Confluence. If you have any other questions, suggestions or concerns, please do not hesitate to contact us.

Copyright © 2023 AppsFoundry
Data Security and Privacy Statement