FAQ - Frequently asked questions - AI Assist for Confluence
Welcome to the FAQ page for "AI Assist for Confluence" app. Here, you'll find a collection of frequently asked questions (FAQs) that are categorized for easy reference.
- 1 General
- 2 Functional
- 3 Known issues and limitations
- 3.1 Why am I not able to replace the selected text on the page from the app?
- 3.2 Why can’t I use AI Assist in editor mode?
- 3.3 Why isn’t the global API key working?
- 3.4 Why isn’t the OpenAI API key field masked?
- 3.5 Why am I getting an error when trying to create an inline comment?
- 3.6 Why does the AI Assist popup sometimes open on a random place on the page?
- 3.7 Why does the AI Assist for Confluence popup close when click I outside of it?
- 3.8 Why am I getting a Function timed out past limit of 25.03 seconds error?
- 4 Security & Privacy
- 5 Licensing, pricing and trials
Frequently asked questions (FAQs)
General
What is AI?
AI stands for Artificial Intelligence, which is a branch of computer science that focuses on creating intelligent machines that can perform tasks that normally require human intelligence, such as learning, problem-solving, decision-making, and understanding natural language.
What is NLP?
NLP stands for Natural Language Processing, which is a subfield of AI that deals with the interaction between computers and human languages. It involves teaching machines to understand, interpret, and generate human language, such as text or speech. NLP is a key technology behind chatbots, language translation, and voice assistants like Siri or Alexa.
Which AI service does AI Assist for Confluence use?
The app AI Assist for Confluence uses an AI service called OpenAI, which is sometimes referred to as ChatGPT. This service is a type of artificial intelligence that specializes in natural language processing, meaning it can understand and generate human language.
What is OpenAI?
OpenAI is a research organization that focuses on developing advanced AI technologies for the benefit of humanity. Their work spans a range of AI applications, including NLP, robotics, computer vision, and game-playing. They are known for their breakthroughs in natural language processing, such as the GPT series of language models that can generate coherent and human-like text.
Functional
How do I get started with AI Assist for Confluence?
To get started with AI Assist for Confluence, you need to install the app from the Atlassian Marketplace. Once installed, you need to provide a bearer token and an instruction on what to do with the selected text. The app will then display the results on the Confluence page.
What instructions can I give to the AI?
Please refer to the page What instructions can I give to OpenAI? - AI Assist for Confluence for a detailed list of example instructions.
Why am I getting strange responses from the AI?
Most likely the AI doesn't have enough information to work with. Try to:
Select a larger piece of text; and/or
Provide more clear instructions.
What is an OpenAI API key?
An OpenAI API key is a type of access token that allows an application, such as AI Assist for Confluence, to access the OpenAI API. When you sign up for an OpenAI API token, you are given a unique API key that you must provide to AI Assist to enable it to communicate with the OpenAI servers. The API key acts as a sort of password that identifies you and your application to the OpenAI system, allowing you to use their technology to enhance your content in Confluence.
Why do I have to enter the OpenAI API key each time I use the app?
You have to enter the OpenAI API key each time you use AI Assist for Confluence because the app cannot securely store the key for users individually due to limitations in the platform it is built on, Atlassian Forge. This means that the key is not saved by the app, so you need to enter it each time you use the app to enable it to communicate with the OpenAI servers. However, you can use your browser's auto-fill features to make it easier and less cumbersome to enter the key each time.
You can ask you Confluence Administrator to set a global OpenAI API key. This way you do not have to enter an API key each time you want to use AI Assist for Confluence.
Known issues and limitations
Why am I not able to replace the selected text on the page from the app?
We are currently unable to offer this feature because the development platform that is used to create AI Assist for Confluence doesn't support it yet. However, Atlassian is continually improving their platform and once they make this possible, we will start implementation.
Why can’t I use AI Assist in editor mode?
We are currently unable to offer this feature because the development platform that is used to create AI Assist for Confluence doesn't support it yet. However, Atlassian is continually improving their platform and once they make this possible, we will start implementation.
Why isn’t the global API key working?
The global API key is stored in a secret within the Atlassian Cloud, after saving the global API key, it may take up to 10 minutes, before AI Assist can find the saved global API key.
Why isn’t the OpenAI API key field masked?
The OpenAI API key field is not masked so that users can use their browser's auto-fill feature. If the field were masked, the auto-fill feature would not work. This means that users would have to manually enter the key each time they used the app, which would be more time-consuming and less convenient. Note that the OpenAI API key isn't saved by the app.
Why am I getting an error when trying to create an inline comment?
There could be 2 reasons:
You do not have the permission to create comments in the space the current page is located in. The app will warn you about this.
The text you have selected appears multiple times on the page, and we are unable to determine which instance you have selected, due to functional limitations in the development platform we are using. This is however needed to create an online comment. Hence the inline comment creation fails. Try to select a piece of text is unique to the page.
Why does the AI Assist popup sometimes open on a random place on the page?
The location of the AI Assist for Confluence app popup is determined by Atlassian. Unfortunately, we can't control or influence this. This is most likely to happen when the page’s window is too small.
Why does the AI Assist for Confluence popup close when click I outside of it?
Atlassian determines this behavior and we're unable to control or change it. We understand this may be frustrating, but it's something we have to accept.
Why am I getting a Function timed out past limit of 25.03 seconds error?
The error that can bee seen below is caused by a service limitation of the Atlassian Forge platform. Requests to external sources, like OpenAI, are not allowed to take longer than 25 seconds. If they do, an error is displayed as shown below. Currently there is now way to catch this error and handle it in a user friendly manner.
To avoid this situation, try to keep your request simple or limit the amount of text you select. OpenAI requires time to process your requests, which can result in longer response times.
Security & Privacy
How does AI Assist for Confluence work?
AI Assist for Confluence uses OpenAI to perform tasks requested by the user on any selected text on a Confluence page. All the user needs to do is provide a bearer token and an instruction on what to do with the selected text. OpenAI processes the request and provides the results back to the app, which then displays the result to the user.
Is my data safe with AI Assist for Confluence?
Yes, your data is safe with AI Assist for Confluence. The app does not store any data, not even the OpenAI bearer token. However, any data, including possible IP, submitted to OpenAI is subject to OpenAI's data privacy and security policies.
Does AI Assist for Confluence comply with data privacy regulations?
A: Yes, AI Assist for Confluence complies with various data privacy regulations, including GDPR, CCPA, and the Australian Privacy Act. TMC ALM - APPS, Atlassian, and OpenAI all have data privacy policies and comply with local data privacy regulations.
Does AI Assist for Confluence have access to my Confluence page content?
Yes, AI Assist for Confluence has access to the Confluence page content where it is installed. However, the app only processes selected text and does not store any data.
Licensing, pricing and trials
Is payment required to use OpenAI?
Yes, OpenAI offers a range of APIs and services for developers to utilize, and some of these may require payment to access. However, OpenAI also provides a free research preview service, which allows developers to experiment with cutting-edge AI models and technologies in a limited capacity. This service is designed for research and experimentation purposes and may not have the same level of support and reliability as the paid APIs and services. Additionally, some of the paid APIs may have free usage tiers or limited free trials available, allowing developers to test out the features before committing to a paid plan.
Overall, OpenAI offers a range of pricing plans based on usage and specific features, and users can choose the plan that best fits their needs.
Â
Â
We hope that this FAQ page 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