WordPress FAQ Plugin (CMFAQ) - Use Case - How to Build Up an FAQ Knowledge Base On Your Site Using ChatGPT
Use Case - How to Build Up an FAQ Knowledge Base On Your Site Using ChatGPT
Note: This guide covers features from the Pro version of the WordPress Glossary plugin - This document uses version 1.8.0.
Video Use-Case
Introduction
The WordPress Glossary plugin is a tool that allows you to build a frequently asked question (FAQs) knowledge base on your WordPress site. The plugin includes an AJAX FAQ search widget with autocomplete or users can search the FAQ by category to help site visitors find exactly what they need.
Use Case Front-End
Use Case Assumptions
In this example use case guide, we'll cover how to configure ChatGPT integration and generate automatic answers to frequently asked questions.
We consider that you have already bought the plugin, but not installed it.
It follows:
- Installing the plugin
- Quick recap
- What is ChatGPT?
- Creating API key
- Enabling ChatGPT integration on your site
- Generating automatic answers
- Preventing automatic answer generation to question
- End result
Installing the Plugin
The process is the same for all CM plugins.
- Download the plugin from your customer dashboard.
- Log in to WordPress and navigate to the WordPress Admin → Plugins settings.
- Click on Add New.
- Activate it and add the license.
Learn more: Getting Started - Installation And First Steps
Quick Recap
This use case guide is focused on the setting up the ChatGPT integration for generating automatic answers to frequently asked questions. We recommend you first to configure the base plugin. Learn more about it in this use case guide:
It will help to configure the following:
- Setting up
- Suggest submission form
- Community submissions labels
- Security (Captcha)
- Moderation
- Star rating
- Notification settings
- Form labels & placeholders
- Terms of Service
- Shortcodes
- User dashboard
What is ChatGPT?
ChatGPT is an AI chatbot that uses natural language processing and machine learning to generate conversations based on user input. It is based on OpenAI's GPT-3 model and can be used to create automated conversations for websites and applications.
ChatGPT processes text using tokens. Tokens are pieces of words used for natural language processing. For English text, 1 token equals about 4 characters or 0.75 words. Every time the plugin request an answer to a question, it spends tokens which are paid. When you register your account, OpenAI gives a start credit which you can spend. When your credit is run out, you can pay to continue using the service.
Learn more about Tokens and check the Pricing Plans.
In order to connect your forum with ChatGPT, you need to obtain the API Key.
Creating API Key
To get the API key, please do the following:
- Go to the OpenAI website at https://openai.com/.
- Click on the “Get Started” button.
- Fill in your email address and password to create a new account.
- Verify your email address by clicking the link sent to your email.
- Once you have verified your email address, log in to your OpenAI account.
- Click on the “API keys” link in the right-hand navigation menu.
- Click the “Create new Secret key” button.
- Copy the API key that is generated from the popup.
- Keep your API key safe and secure, as it provides access to your OpenAI account and services.
As creating an API key is committed on a third-party service side, so the process of obtaining an API key can have some minor changes from time to time. Follow the instructions on the OpenAI site.
Enabling ChatGPT Integration On Your Site
To configure the integration, navigate to Admin Dashboard → CM FAQ → Options → Plugin Options tab.
Scroll down and find the section Chat GPT. It has the following options:
- Enable Chat_GPT - Turn on this option to activate ChatGPT feature.
- Chat GPT API Key - Enter here the API key obtained from OpenAI site.
Chat GPT Model - This option allows you to choose a ChatGPT model. This option is inactive until you enter your API key in the option above and save the changes. Once it's done, you will be able to choose any model supported by your API in the dropdown. Note: this option was updated in version 1.8.7.
- Chat GPT AI Role - Here you can define the role for the Chat GPT assistant to make your answers more specialized. This way, if you define the assistant as an expert in some certain area, it will generate the answers related to your main topic.
- Chat GPT Prompt Template - Specify the request which the plugin will be sending to ChatGPT for getting answers. Important: this template must contain the following placeholders: {question}.
Request Example
Let's consider more detailed how the request is formed and sent to the ChatGPT in order to receive an answer. The request defined in the options Chat GPT AI Role and Chat GPT Prompt Template will be combined to generate an answer for certain specialization. The example of the settings on the screenshot above will have the following request:
You're a helpful assistant. {question}
The way how you define the AI role can have a huge affect of the result and generate totally different answers to the same question.
When the ChatGPT AI Role is set to "You are a WordPress expert.", the ChatGPT will answer the question "How to install a plugin?" in the context of WordPress plugins:
But when the ChatGPT AI Role is set to "You are a Magento expert.", the ChatGPT will answer the same question "How to install a plugin?" in the context of Magento plugins:
- Chat GPT Reply Length - Set the maximum length of the reply requested from the ChatGPT. This value is set in tokens. Warning: longer replies use more tokens, so you can reach limit faster. Learn more about Pricing Plans.
- Chat GPT AI Temperature - This option allows to define how accurate the generated answer will be. This value ranges from 0 to 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
When you finished configuring the settings, click the button Save Changes at the bottom of the page.
This is how our settings look like after setting up:
Generating Automatic Answers
To automatically generate an answer for a needed question, navigate to Admin Dashboard → CM FAQ → Add New Question.
On the appearing page, just enter the question and leave the answer area empty, choose the category and click Publish. The automatic answer will be generated.
Important
The automatic answer can be generated only for newly created questions. If you remove the answer in the already existing question and update it, the automatic answer will not be generated in this case.
Preventing Automatic Answer Generation To Question
If you don't want the plugin to generate the automatic answer to the question you create, you can disable ChatGPT for this specific case. While creating the question, find the metabox Chat GPT and check the option Disable auto-answering by Chat GPT for this question. After the question is published, the answer area will be empty.
End Result
Following instructions found in the WordPress Glossary plugin and guides, you should be able to build an FAQ knowledge base on your site using ChatGPT.
Use Case Front-End
More information about the WordPress Glossary Plugin Other WordPress products can be found at CreativeMinds WordPress Store |
|
Let us know how we can Improve this Product Documentation Page To open a Support Ticket visit our support center |