Hyve Documentation
| Install and Set Up | Settings |
|---|---|
| Adding Content to Knowledge Base | General |
| Enable the chat | Appearance |
| Read and Manage Messages | Assistant |
| External API support | Moderation |
| Troubleshooting | Advanced |
Getting Started
Hyve is an AI-powered chatbot that transforms your WordPress content into engaging conversations. It uses the content from your WordPress site as a knowledge base to intelligently respond to user inquiries, providing accurate and context-aware answers directly from your existing materials.
To use Hyve, free or pro, an OpenAI API key with credit on the account is required.
Install and Set Up
Download the plugin
- The free version of the plugin, Hyve Lite, is available on WordPress.org or directly in the Dashboard of your website at Plugins > Add new and search for Hyve.
- The premium version, Hyve, is available in your customer account on store.themeisle.com.
If you paid for the plugin, Hyve Lite isn't required for it to work; you can only use Hyve.
Install the plugin
In your website's Dashboard, navigate to Plugins, Add New, and upload the plugin zip file you just downloaded, either hyve-lite.zip or hyve.zip .
Configure the API key and license key
Once installed and activated, the first step is to configure the OpenAI API key.
This can be done in Hyve > Settings > Advanced.
You can generate a new OpenAI API key or copy an existing one on this page.
To activate your license key for Hyve and enable the premium features, copy the key from your account at store.themeisle.com and activate it in the same Hyve > Settings > Advanced page.
Adding Content to the Knowledge Base
The chat won't work if the Knowledge Base is empty.
To add content to the Knowledge Base, navigate to Hyve > Knowledge Base > Knowledge Base and choose an option to add sources.
- WordPress (available with Hyve Lite)
- Custom Data (pro)
- Website URL (pro)
- Sitemap (pro)
To check if a source was successfully added to the Knowledge Base, you can navigate to Hyve > Dashboard and check the Knowledge Base count.
By default, the Knowledge Base is limited to a maximum of 500 sources. To extend this limit without an additional cost, see our dedicated article: Integrate Hyve with Qdrant.
If a post that you have added to your Knowledge Base has been updated since you will see it in the Requires Update tab. From there, you update the data in your knowledge base. This might seem like an extra step, but we do this to avoid anything that does not pass Moderation and goes to your Knowledge Base.
Sometimes, when you try to add a post to your Knowledge Base, you might see a Failed Moderation dialog. This might happen if your content fails to pass OpenAI's Moderation checks. In the dialog, you can see what exactly is causing your content to fail, and you can review and edit it accordingly. After a review, if you find your content does not fall under any given categories, you can override the moderation to proceed with your content. OpenAI can often falsely flag content for violations, sometimes due to lack of context.
Custom Data & FAQ
From the Custom Data tab, you can also add Custom Data to your Hyve's Knowledge Base, in addition to post types. Custom Data lets you privately feed specific data directly into your chatbot without displaying this information on your public website. This can be good for content that does not make much sense to be publicly visible on your posts or even answer some of the specific questions that your users might have.
Custom Data titles are not indexed in the Hyve Knowledge Base. This means that if you use Custom Data to answer Suggested Questions or FAQs, you must include the actual question within the content of the Custom Data itself for it to be recognized and retrieved by the chatbot.
For example:
- Question: Do you offer support?
- Answer: Yes, you can contact us on store.themeisle.com/contact
How to add this as Custom Data:
- Custom Data Title: Do you offer support?
- Custom Data Content: Do you offer support? Yes, you can contact us on store.themeisle.com/contact
With the FAQ, you can find out some of the questions your users asked on your website that went unanswered. The FAQ page updates a couple of times daily to show you the questions and their count. You can use this information to update your post to answer those particular questions or add them as part of your Custom Data. This feedback loop can help you train your Chatbot to answer most of your user's queries.
Enable the chat
Once your Knowledge Base has content, there are two ways to enable the chat.
Enable the chat on all pages
By enabling this option, the chat bubble will appear on all the pages within the website.
Enable the chat on a specific page
The chat can be displayed only on certain pages by disabling the global option (Enable chat on all the pages) and using the dedicated Gutenberg Blocks on the desired pages, posts, or custom post types.
- Hyve Chat - Inline
- Hyve Chat - Chat Bubble
The blocks don't work if the chat is enabled on all pages.
Hyve shortcode
If you want to display the Hyve chatbot only on certain pages, you can toggle the chatbot off from the settings and either use a shortcode or block to display it only on those pages.
- Shortcode for inline chat:
[hyve]
- Shortcode for the bubble chat:
[hyve floating="true"]
Based on your requirement, you can either display the chatbox floating as it does normally with the global settings, or you can display it inline in the content area. Keep in mind you can only display the chatbot once on a page.
Read and Manage Messages
Messages sent by your site visitors in the Hyve chat will be kept Hyve > Messages page. From here, you can also delete threads and, with the premium version, export them.
Deleted threads are removed from local storage but are still accessible via the OpenAI API.
Exported messages are formatted as CSV and include: thread_ID, sender (user/bot), message content, date, and timestamp.
Integrations
Enable external services to search your Knowledge Base using advanced semantic search powered by Retrieval-Augmented Generation (RAG) and OpenAI embeddings. Integrate automation tools (Zapier, n8n, etc.) with a secure API endpoint to perform intelligent content searches via simple API requests.
1. Generate an Access Token
- Access tokens are required for authentication. Generate your token as described on the Hyve Integrations page or within your WordPress dashboard under Hyve settings.
2. Make an API Request
- Use tools like Postman or your preferred HTTP client.
- Refer to the exact request format and endpoint URL provided on the Hyve Integrations page.
3. Configure Search Parameters
You can customize your search with the following parameters:
| Parameter | Type | Range/Example | Description |
|---|---|---|---|
| threshold | float | -1 to 1 | Sets the minimum cosine similarity between your query and knowledge base entries to be considered a match. If unset, defaults to the Knowledge Base’s Cosine Similarity Threshold setting. |
| max_tokens | integer | e.g. 1000 | Limits the maximum number of tokens (words/characters) in a returned post. If a matching post exceeds this, it is excluded. If not set, no token limit is applied as long as the similarity threshold is met. |
- threshold: Controls how closely the search result must match your query. Higher values (closer to 1) mean stricter matching; lower values (closer to -1) are more permissive. If you do not specify this parameter, Hyve will use the default threshold set in your Knowledge Base settings.
- max_tokens: Prevents very long posts from being returned if they exceed the specified token count. Useful for ensuring concise results. If not specified, all posts that meet the similarity threshold are eligible, regardless of length.
Troubleshooting
For the chat to work properly, make sure that:
- An OpenAI API key with available credit on the account is connected
- At least one source/article was added to Hyve's knowledge base
- The chat is enabled either on all pages from Hyve > Dashboard, or on a specific page with the Gutenberg blocks.
If something critical goes wrong and the chat is not functional, you should see an error notice on the Hyve > Dashboard page. Below is an example of a Qdrant connection failing due to invalid credentials.
General Settings
Enable “Add to Hyve” Post Action - When enabled, an “Add to Hyve” button will appear in the post/page row actions. Disable this to remove the option from the posts/pages list, but keep the added posts to the knowledge base.
Welcome Message (customizable) - This message will be displayed when the chat is opened.
Default Message (customizable) - This message will return when the chat is unable to find an answer.
Suggested Questions (customizable pro feature) - These questions will be displayed in the chat to get the conversation started.
Appearance Settings
Available in the premium version, the Appearance Settings allow customizing the chat icon (choose from predefined icons), and colors for the chat background, assistant background messaage, user background, and icon background.
For the changes to apply, make sure to click the Save button.
Assistant Settings
In Hyve's Assistant Settings, you can modify the temperature and top_p parameter of your OpenAI requests. You can learn more about these parameters here.
Choose the AI model that powers your chatbot. More advanced models provide better responses but may cost more.
Moderation Settings
The Moderation page in the Hyve plugin helps you ensure that your content is safe and appropriate for your users. This feature uses OpenAI’s Moderation system to automatically check your content for potentially harmful material before it becomes part of your chatbot’s knowledge base.
How Moderation Works
- When you add new content to Hyve, it is automatically checked for issues like hate speech, harassment, self-harm, sexual content, and violence.
- If the system detects a problem, you’ll see a message explaining which category was triggered and why.
- Sometimes, the system may make mistakes and flag content that doesn’t actually violate any rules (these are called “false positives”). In these cases, you can manually review the content and override the decision if you believe it is safe.
Adjusting Moderation Sensitivity
- You can adjust how strict the moderation is for each category in the Hyve > Settings > Moderation page.
- If you notice that certain types of content are being incorrectly flagged too often, you can modify the threshold for that category to reduce false positives.
Why Moderation Matters
Moderation helps protect your users and your website by preventing harmful or inappropriate content from being used by the chatbot. It also helps you comply with platform guidelines and legal requirements.
Advanced Settings
Add your OpenAI Api key and Hyve license key here.
When using Hyve Lite, only the OpenAI API key will appear here.
Enable telemetry to help us improve the plugin by sending anonymous usage data. Data is private and not shared with third-party entities.
Telemetry does not include your conversations, Knowledge Base, FAQ, or any private content—only which plugin options you use. Your privacy is always protected!