Invite Bot

User Guide: Getting Started With AwesomeQA

User Guide: Getting Started With AwesomeQA

Aug 30, 2023

AwesomeQA is an AI Chatbot designed to help manage online communities on platforms like Discord, Telegram, and websites. It's like having a smart assistant that can quickly answer questions from community members.

Content

Inviting the bot to your Discord

Step 1: Visit the AwesomeQA Website

To get started, open your web browser and go to the official AwesomeQA website at https://awesomeqa.xyz.

Step 2: Click "Get Started For Free" or "Invite Bot"

Once you're on the AwesomeQA website, locate and click on the "Get Started For Free" or the "Invite Bot" button. This will initiate the process of adding the bot to your Discord server.

Step 3: Fill Out the Form

You'll be presented with a form to fill out (only 2 fields). Make sure to provide accurate information in the required fields.

Step 4: Select Your Server

After submitting the form, a pop-up prompt will appear. In this prompt, you'll see there's a drop down menu with a list of your Discord servers (in case you have admin rights in multiple servers). Select the server where you want to add the AwesomeQA bot. Once you've made your selection, click the "Continue" button.

Step 5: Review and Authorize Permissions

Another pop-up prompt will appear, displaying the permissions that the AwesomeQA bot requires to function effectively on your server. We ask for the least amount of permissions as compared to other similar tools. Click the "Authorize" button to grant the bot access to your server.

That’s all. You've successfully invited the AwesomeQA bot to your Discord server! Next, you'll need to complete the onboarding to train and activate the bot (only takes a few minutes).

Inviting the bot to your Telegram

Step 1: Visit the official account

Go to **https://t.me/awesomeQA_bot** and click start to enable it. This just makes the bot available to you as a member that you can add to your Telegram group or channel.

Step 2: Adding the bot to your Group/Channel

You can do this by clicking on the AwesomeQA name at the top, and then clicking on 'more', then 'Add to group', then select the group from the list, and add it as an admin.

Note, you only have to give it admin rights, and the rest of the permissions can be kept toggled off.

Alternatively, you can watch this video that covers the steps above.

Step 3: Share Details

Send your group/channel link where you have added the bot and your Discord ID (numerical digits) to us at hi@awesomeqa.xyz or via TG to https://t.me/syedaqa. This information is crucial for setup as we will use your Discord ID to create the dashboard for you where you can add knowledge sources to train the bot and manage the bot permissions, etc. After this part, there's nothing more for you to do.

Step 4: Permissions and Data

Next, AwesomeQA's team will review permissions, export your Telegram chat history data, create a dashboard, and whitelist you for this dashboard using the Discord user ID you've provided so you can easily log in using your Discord account.

Once we are done, you’ll receive a confirmation email/message, and the bot will be activated in your Telegram channel.

How to complete onboarding?

Step 1: Click on the Start Onboarding Button

Locate the "Start Onboarding" button, and click on it to start the onboarding.

Step 2: Uploading your Documentation or any web pages

  • Add Web Pages Links: Begin by adding the links to your documentation and web pages (just copy/paste the URLs. These links will serve as a valuable resource for the bot to learn from. You're not limited to a specific number of web links—feel free to add as many as you need. This is one of the key ways AwesomeQA sources information and creates a knowledge base ensuring its responses are well-informed and relevant.


    Pro Tip: We automatically scrape your uploaded web page links every two weeks to keep the knowledge base up to date. However, you can force trigger the scraping process at any time just by clicking on the refresh icon located at the beginning of the link whenever you want the bot to quickly pick up on any new changes or updates from those pages.

Step 3: Set Bot Permissions

One of the most powerful features of AwesomeQA is its flexibility. You have full control over where the bot can operate within your community. Here's how to set the permissions:

  • Channel Selection: You can decide which channels the bot should interact with. Whether it's specific discussion channels, support forums, or anywhere else.


  • Learn Permissions: Toggle on or off the "Learn" permission for each channel individually. This controls whether the bot can access and monitor conversations in those channels for training.

  • Reply Permissions: Similarly, toggle on or off the "Reply" permission for each channel. This determines where AwesomeQA can actively engage with your community. For example, if you toggle it off for a channel, then the bot will never send a message in that channel.

By individually adjusting these permissions, you customize AwesomeQA's role to suit your community's unique needs. It's a smart way to ensure the bot operates seamlessly within your community, providing valuable support where it's needed most.

Final Step: Launching AwesomeQA's Training and Activation

  • Review Your Choices: Take a moment to review all the choices you've made throughout the onboarding process. But don’t worry, you can always come back and change things around as you please, nothing is final.


  • Click "Finish": When you're satisfied with your selections, click the "Finish" button. This marks the start of the bot's training phase, where it fine-tunes its responses to match your community's unique needs. Keep an eye out for a banner at the top of the web app indicating that the AI is training.


  • Await the Activation: As the training completes, AwesomeQA gears up to join your community's conversation. You'll receive a direct message on Discord from the AwesomeQA bot, indicating that it's ready to roll.


    Pro Tip: Want to know if AwesomeQA is up and running? It's as easy as asking a question and tagging the bot. Simply type a question like "Are you there? @awesomeqa" in your community's chosen channels. The bot's response will let you know that it's active and ready to assist.

What is the Support Portal?

This feature is designed to streamline your support workflow and ensure that no question goes unanswered. Let's delve into the details:

  • Organized Unanswered Questions: Provides you with an organized list of all unanswered questions within your community. This creates a central hub where you can easily identify which queries need attention, preventing any question from slipping through the cracks.


  • Open and Mark Resolved Buttons: For each question listed on the Support Portal, two buttons are available: "Open" and "Mark Resolved." These options grant you the flexibility to manage your support tasks effectively.


  • Open Button: When you click the "Open" button, you're instantly taken to the Discord or Telegram chat where the question was originally asked. This direct link eliminates the need to search for the question manually, saving you valuable time and allowing you to reply promptly.


  • Mark Resolved Button: Clicking the "Mark Resolved" button is a straightforward way to declutter the Support Portal. This action removes the question from the list, streamlining the portal and ensuring that only relevant queries are at the forefront. It's a powerful method to keep your workspace organized and focused on actionable tasks.


  • Chat History Display: If you click on any of the questions listed, the chat history that followed that question is displayed on the right side of the portal. This insight lets you see whether anyone outside your team attempted to answer the question and whether the information provided was accurate. With this knowledge, you can step in and correct any misinformation, ensuring accurate and helpful responses.

What are FAQ Insights?

Are you curious about what's buzzing within your community? You can quickly learn about that on the FAQ insights page.

  • Comprehensive Topic and Question Listing: Get a bird's-eye view of the most-discussed topics and questions in your community. You'll have a curated list right at your fingertips.

  • Uncover Burning Questions: Instantly identify the hottest questions your community is asking. This knowledge empowers you to address pressing concerns and engage with your audience effectively.

  • Trend Analysis Made Easy: By filtering FAQ insights based on specific date ranges, you can spot trends and track the evolution of discussions. Stay ahead of the curve with this valuable data.

  • Community Understanding and Product Enhancement: The information you gather from FAQ Insights goes beyond just Q&A. It offers deep insights into your community's preferences and concerns, enabling you to refine your products and services.

Can you edit the bot’s responses?

One of the greatest features of AwesomeQA is that you can edit any of its responses to fit your needs. Here's how:

  1. Identify Inaccuracies:

  • If you spot a response that's not quite up to the mark or needs a refresh, take action.

  1. Access to Editing:

  • Right-click on the response in question. From the dropdown menu, navigate to "Apps" and select "AQA-Edit."

  1. Link Generation:

  • The bot will promptly generate a link for you, plus, you will also see a 'pen' icon at the end of the answer you're trying to edit. So you can click on either of the two, and you'll be directed to the dashboard.

  1. Custom Responses:

  • Once you're in the dashboard, in the answer field make the changes you like.

  1. Save Changes:

  • Then, hit that save button. Your edits are now saved in your Knowledge Base for future reference.

  1. Automatic Update:

  • Whatever changes you’ve just made, the original bot's message in the Discord chat gets an automatic update. Your changes are seamlessly integrated in real time.

Can you add QAs from your Discord chat directly to your Knowledge base?

AQA-Add is a key feature to optimize the way you handle repeated questions and valuable answers.

  1. Spot and Store:

  • Identify exceptional questions and answers in your Discord chat. If you foresee these being valuable for future queries, consider using AQA-Add to store them.

  1. Initiate the Process:

  • Right-click on the question or answer you want to add to your Knowledge base and choose AQA-Add from the dropdown menu. The next steps would be the same as discussed in the previous section.

  1. Navigate to Knowledge Base:

  • Following your selection, the link provided will guide you to your AwesomeQA web app Knowledge Base.

  1. Duplicate the Excellence:

  • Within the Knowledge Base, replicate the answer or question that struck you as noteworthy.

  1. Preserve for Future Use:

  • Save your changes. These QAs are now securely stored for future reference.

Is there a way I can test AwesomeQA before adding it to my community?

Fortunately, with AwesomeQA, you can take it for a test drive before committing. Here's how:

  1. Create a Test Environment:

  • Start by creating a test server or a private channel within your main server. This isolated space is your playground for getting to know AwesomeQA.

  1. Onboarding Steps:

  • Follow the onboarding steps explained earlier in this blog post. These initial steps will help you set up AwesomeQA in your test environment.

  1. Tag for Testing:

  • By default, we've configured AwesomeQA not to respond to moderators, owners, team members, community managers, or admins. Since you likely have one of these roles in your test server, you'll need to initiate interactions by tagging the bot after your question. For instance, "Why am I not seeing the most recent transaction in my wallet? @awesomeqa". Once tagged, AwesomeQA will respond promptly to your inquiries.

A Note on Testing

It's important to understand that tagging the bot is a requirement only in this testing scenario. When AwesomeQA is fully active within your community, it operates seamlessly without this step. It automatically responds to relevant questions by drawing information from your three primary sources: the knowledge base, chat history, and documentation.

Empowering Global Communities with AwesomeQA

We've recently added the ability to support multiple languages to help your community connect better. What makes us different is that we can answer questions in any language, even if the main information is in your first language.

This global approach allows you to easily communicate with community members from all around the world. Whether your community speaks English, Spanish, French, or any other language, AwesomeQA can help them out.

We really value your feedback and want to grow by making your ideas a part of our service. This commitment to listening to customers sets us apart, along with our great performance.

You're not just getting a tool; you're getting a team that's ready to help you make your community better.