Quick Start Guide

AiChatGPT - Ai ChatGPT for Confluence is an app that will fetch all the power of ChatGPT into Confluence. It is a connector that provides a macro insertable in the Confluence pages, and menus in different locations from where you can query to ChatGPT and create content automatically. This content can be saved into a page whenever you want.

This guide will show you step by step how to install, configure and run your interaction with ChatGPT. Let’s start!

Setup

This section will show you how install the app in you Jira instance.

System requirements

  • Be a Jira Administrator.

  • Access to Atlassian Marketplace via Internet.

  • Hava an Atlassian Site with Confluence Cloud (Server/DC is not supported yet).

 

  1. Browse to AiChatGPT for Confluence page on Atlassian Marketplace and click on the button: Get it now

    image-20240417-163216.png

  2. (Optional) If you have more than one Site, choose the Site where install it

    image-20240417-163900.png

  3. Click on: Get it now

  4. Click on: Get Started

     

  5. Copy and paste OpenAI API connection data and click on Save

     

Notes

  • The values in the snapthot are only example. You will need to get your values from: OpenAI API - Org ID and OpenAI API - API Key.

  • When ‘Save’ button is clicked or you get into current screen, a test call will be run to OpenAI API for verifing the connection data is right.

    • If the test fails, you will see the error returned by OpenAI. E.g.


      This means the API Key is not correct. Verify you API Key was copied-pasted correctly.

  • From 8 March of 2024, OpenAI changed the Free Plan to Prepaid Billing. All the details are here. If you do not have credits yet, you will need to add some to your account in the billing section.

    • If you run out credits, OpenAI will return the following error:

       

      You can Enable auto recharge in the billing section to avoid run out credits:

  1. Verify your configuration writing a prompt in Test Configuration and clicking on Text button or press key ‘Enter’.

Upgrade

Whenever a new release is launched you can update the app to get the most recent version with the new features click in on the ‘Update’ button.

 

Usage

There are several ways from where you can access to the AI ChatGPT for Confluence features.

Ways to interact with the AI

In this section you will find different ways to interact with the AI.

Global Page

The easiest way to interact with the AI is clicking on Apps > Ask to AI ChatGPT Assistant.
This is the recommended option whenever you need to generate a new content from scratch.

Space Page

When you will be located into a space, you will see a Space Page called: Ask to AI ChatGPT Assistant

Inline Content

An esay way to interact with the AI is clicking on the option: Ask to AI ChatGPT Assistant

Page Actions

You also will be able to use Ask to AI ChatGPT Assistant from the More actions menu clicking on the three dots.

Selected Text

Whenever you select a text on your page, you will see the option Ask to AI clicking on the down arrow:

Page Macro

Users also has a page macro available can be added within the pages.

  1. Edit a page.

  2. Click on the page body, type: /ai and click on the ‘ai’ (macro).

  3. Previous step is equivalent of click on the macro via: + button

  4. Click on: Publish.

Features

Summarize

From a page or selected text click on this button and the AI will respond with a TL;DR summary.

 

Summarize a selected text

 

Summarize a full page

 

Explain

From a page or selected text click on this button and the AI will try to explain you with simplier terms the content.

Explain a seleted text

 

Explain a full page

 

Custom content generation

From a page or selected text, you will have a form where you can input a prompt and the AI will generate a content from that text.

Text generation

Write a prompt (eg. Act as Product Owner of a Banking mobile app. Create three user stories. The output should be a table with four columns: 'Id', 'Name', 'Description', 'Acceptance criteria'. Include two Acceptance criteria by every story.) and press key ‘Enter’.

Search in Confluence
Search in files
Create charts
Create images

 

Note: You can continue talking with the AI on the same way, to adjust the content until you will be happy with the result.

Save the generated content

Info

You need generate content to see this options. If you didn’t yet, please check the previous steps.

Click on the ‘Save’ to store the generated content into a page using different saving modes:

After you save the content, you will be redirected into the page in order to see the saved changes.

 

Save replacing a page

This option will create a new page on the space you selecte here.

Save replacing a page

This option will replace a current page with the new content. Optionally you can modify the page’s title here too.

Save adding content on a page’s bottom

This option will add the new content on a page’s bottom

Save adding content on a page’s top

This option will add the new content on a page’s top

 

Congratulations!
You created your first content using ChatGPT AI. From here only your imagination is the limit.

 

Notes

Somethings to take into account when you use this macro:

  • If the API Key or Org ID are not right, then an error will be displayed when you send your prompt. Please, as an administrator, ensure the values were copied right from OpenAPI and do a test before to communicate your users the app is ready to use.

  • Sometimes the time ChatGPT might fails depending on the prompt and context. On that cases it is recommeding restart the context activating the New chat button (+).

     

  • Due to the high popularity of ChatGPT, sometimes it can be overloaded. On that cases you will recevie this message:

  • Tip: To put it easy to users, you can include this macro into a Template so they have it already included just clicking on the Template.

  • Some tasks such as image generation may take some time to complete. If there is no answer from ChatGPT after a while, a time out error will be displayed. Also you can cancel the run in any moment clicking on ‘stop’ button.