AI Moderator for BuddyPress Documentation

Plugin Settings

The AI Moderator for BuddyPress plugin has three settings:

• OPEN AI Model Your preferred AI Model from OPEN AI to send your post for moderation.
• Prohibited Words: A list of words that the plugin should check for in activity feed posts.
• OpenAI API Key: The API key to use when making requests to the OpenAI API.
• Notification Text: The text of the notification, sent when an user's post has been marked as SPAM.
• Notification URL: (Optional) The URL for the notification sent to the user when a post has been marked as SPAM.
• Troubleshooting: Learn how to troubleshoot common issues faced while using the plugin.

You can access the plugin settings page by going to the WordPress admin panel and clicking on the "AI Moderator for BuddyPress" link in the left-hand menu.

OpenAI API Model

The "Open AI Model" is the drop-down field that allows you to select the AI model to use for sending requests to OpenAI. The "Open AI Model" field has three options: Text Davinci 003, Text Curie 001, Text Babbage 001. These options represent different AI models that you can use for different purposes. Text Davinci 003 is the most advanced and powerful model for post moderation, while Text Curie 001 and Text Babbage 001 are less powerful but still effective for low-level moderation. It is important to note that selecting the most powerful model, Text Davinci 003 , will increase the cost of using the OpenAI API key. And, the other two models; Text Curie 001 and Text Babbage 001 will consume less credit from your account. Therefore, it is recommended to choose the appropriate model based on your specific needs and available resources. Learn More from here.

1. Go to the WordPress admin panel and click on the "AI Moderator for BuddyPress" link in the left-hand menu.
2. You will find the "OpenAI Model" drop-down.
3. Select the AI model you want to use from the dropdown list. The Default selected is "Text Davinci 003"
4. Click the "Save Changes" button.

Prohibited Words

This field allows you to define a list of words and phrases that will be used to identify potentially problematic activity feed posts. You can add one word or phrase per line in the text area provided. If any of the words or phrases in this list appear in an activity feed post, the post will be marked as spam.

1. Go to the WordPress admin panel and click on the "AI Moderator for BuddyPress" link in the left-hand menu.
2. You will find the Prohibited Words Text Field.
3. Add or remove words as necessary.
4. Click the "Save Changes" button.

OpenAI API Key

In order to use the OpenAI API for spam detection, you need to provide an API key. Enter your API key in this field to enable spam detection. If you don't have an API key, you can sign up for one at the OpenAI website. If the activity content doesn't have any prohibited words you mentioned in the before field, then the activity content will be sent to OPEN AI for spam detection. If OPENAI finds the contents of the activity post as spam, it will mark that activity content as SPAM and notify the user who posted it. The "OpenAI API Key" setting is the API key to use when making requests to the OpenAI API. To set or change the API key:

1. Go to the WordPress admin panel and click on the "AI Moderator for BuddyPress" link in the left-hand menu.
2. You will find the "OpenAI API Key" field box.
3. Follow this STEP by STEP video tutorial to learn how to get you OPEN AI's API key.
4. Enter your API key in the text box.
5. Click the "Save Changes" button.
6. Please ensure you have enough credeits in your OPEN AI account for the API to work. If you notice that the plugin isn't functioning properly, you will be needing to check if you have non-expired banalnce in your OPEN AI account.

Notification Text

This field allows you to specify the text of the notification that will be sent to a user when their activity post has been marked as spam by the plugin.

1. Go to the WordPress admin panel and click on the "AI Moderator for BuddyPress" link in the left-hand menu.
2. You will find the Notification Text field.
3. Enter the text for the notification in the text area provided.
4. If you leave the field blank, a default message will be used instead.
5. Click the "Save Changes" button.

Notification URL (Optional)

The "Notification URL" setting is the URL that is used on the notification text, sent to a particular user, when his post has been marked as SPAM by our system. You can use the link to your Terms and Conditions page, or Content Policy page. To set the URL:

1. Go to the WordPress admin panel and click on the "AI Moderator for BuddyPress" link in the left-hand menu.
2. You will find the "Notification URL" field box.
3. Enter your preferred URL in the box

Troubleshooting

If you find that the plugin isn't working as expected, I have got some workarounds for you. We hope these steps will most likely solve any isuses you might have with the plugin. If any help you need other than these, never hesitate to contact me directly.

1. At first, please ensure that your CRON system is running properly. This could be WP Cron or any other external Cron you may be using. The plugin sets up the check for the spam on the contents of the post, after 30 seconds of the post being posted. So, a working Cron system is a must here.
2. Secondly, keep an eye on your WordPress administrative email box. Our plugin will send any technical errors it confronts while functioning, right to your email box. So, keep an eye over your admin email if you find the plugin to not work.
3. Thirdly, if still spam detection isn't working poperly, kindly generate a new API secret token from OPEN AI, and replace it with your current one from the plugin settings. We have noticed in some cases, sometimes an API key causes to return the same data over and over instead of fetching the new details. The problem gets resolved after replacing that API key with another newly created one.