Hyve Documentation

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.

Setting Up Hyve

Log in to your WordPress dashboard and navigate to the "Plugins" section. Click on "Add New," then select "Upload Plugin." Choose the hyve.zip file from your computer and click "Install Now." Once the installation is complete, click on "Activate Plugin" to enable Hyve on your site.

After activating the plugin, you can click on Hyve in your WordPress Dashboard. From there, you should click on Setup API Key, which will take you to the Settings tab. In there, you need to add two keys. The first one is your Hyve License key, which you should find in your ThemeIsle Account's Purchase History. The second is your OpenAI API key that you can generate from your OpenAI Account. Make sure your key either has permission to all resources or, in case you are using a Restricted Key, it has access to all the required resources, as seen in the screenshot.

As of Hyve 1.1, we use the following models from OpenAI:

text-embedding-3-small
gpt-3.5-turbo-0125
text-moderation-latest

One more thing: ensure your account has some credits added for OpenAI API to work.

Knowledge Base & Adding Data to Hyve

In Knowledge Base, you will find all the Posts/Pages that you have added to Hyve. From here, you can see and remove any data that you do not want to be part of the chat's data source. On a fresh install, Knowledge Base will be empty by default. You can move to the Add Data tab to add data to your Knowledge Base. If a post that you have added to your Knowledge Base has been updated since you will see them 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.

You can also navigate to Settings > Moderation to modify the threshold for each category if you feel your content is falsely triggering one particular category. Remember to be cautious and review what you put out to avoid unforeseen consequences.

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.

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.

Settings

You can also find a few more options in Hyve's General Settings. Here, you can modify the Welcome Message of the Chat, which is the first message it sends when you open the chat window. Similarly, you can change the Default Message sent if AI cannot answer the user's question. You can also edit the list of Pre-defined Questions displayed at the beginning of the chat as a starter point for users to interact with the chatbot.

Finally, 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.

Shortcode and Block

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.

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.