Skip to content

Latest commit

 

History

History
101 lines (56 loc) · 5.66 KB

README.md

File metadata and controls

101 lines (56 loc) · 5.66 KB
Raw

This project is tested with BrowserStack

This is a free plugin. There is no paid version or pro version of this plugin!!

This plugin was created during mentorship of some local students to teach them the skills of using API's, AI, Wordpress, PHP, and CSS to plan, design, and program a website bot.

Like it? Give it a star.

OpenAI Chat WordPress Plugin

Description

The OpenAI Chat WordPress Plugin allows you to integrate OpenAI's GPT-3.5 Turbo model into your WordPress website for interactive chat experiences. Engage with your visitors by creating a chatbot that can provide answers, assistance, and engage in conversations.

Please Note: This plugin is provided free of charge and "as is," with no warranties or guarantees of any kind. By using this plugin, you acknowledge that you are using it at your own risk. The plugin author and developer are not liable for any damages, losses, or issues that may arise from its use.

Please do not claim this software as your own, charge money for it, or sell it. It should be free for everyone to use! Please give credit if you do use it and if you make a cool mod for it please share!

Important: OpenAI API Charges

This plugin relies on OpenAI's API, which may incur real charges when used. You must obtain an API key from OpenAI and agree to OpenAI's terms and pricing before using this plugin. OpenAI's pricing and terms are subject to change, and it's your responsibility to understand and comply with them.

Installation

Follow these steps to install and activate the OpenAI Chat WordPress Plugin:

Step 1: Download

  1. Visit the Donalda's Github repository for the OpenAI Chat WordPress Plugin.
  2. Click the "Code" button and select "Download ZIP" to download the plugin's source code to your computer.

Step 2: Unzip

  1. Locate the downloaded ZIP file (usually in your computer's "Downloads" folder) and unzip it. You should now have a folder named openai-chat containing the plugin files.

Step 3: Upload to WordPress

  1. Log in to your WordPress admin dashboard.
  2. Navigate to the "Plugins" menu on the left sidebar and click "Add New."
  3. Click the "Upload Plugin" button at the top of the page.
  4. Choose the openai-chat.zip file located in the openai-chat folder on your computer and click "Install Now."

Step 4: Activate

  1. After installation, click the "Activate" button to activate the OpenAI Chat WordPress Plugin.
  2. The plugin is now active and ready to use.

Usage

Plugin Settings

You can customize the behavior and appearance of the chatbot through the plugin settings in the WordPress admin area. These settings include:

  • API Settings: Enter your OpenAI API key to enable chat functionality.
  • Custom JSON Data: Add Frequently Asked Questions (FAQs) directly through the admin panel.
  • Chat Title and Welcome Message: Customize the chatbot's title and welcome message for visitors.

Allowing Visitors to Search the site for Information

The OpenAI Chat WordPress Plugin includes a search feature that allows users to find specific information on your website. To use it, instruct users to follow these steps:

  1. Start a conversation with the chatbot by typing a message.
  2. Type "search" followed by the keyword or topic they want to search for. For example:
    • To find a page named "Contact Us," they can type: search Contact Us
    • To search for information about turtles, they can type: search turtles
  3. The chatbot will attempt to find a page on your website that matches the user's query. If it finds a match, it will provide the URL link to that page.
  4. If no matching page is found, the chatbot will attempt to provide an answer based on the available FAQs or refer the user to ChatGPT for assistance.

This search feature helps users quickly locate relevant information on your website using natural language queries.

Shortcode

To add the chatbot to your pages or posts, use the [openai_chat] shortcode. You can customize the chatbot's title and welcome message by providing attributes to the shortcode.

Example shortcode: [openai_chat title="Chat with Us"]

FAQ Integration

You can add and manage FAQs directly through the admin panel or by importing custom JSON data. FAQs are used to provide answers to common questions your visitors may have. We have tested this using different browsers.

Disclaimer

Disclaimer: By using this WordPress plugin, you agree to the following terms: This plugin is provided as-is and without any warranty or compensation of any kind. You acknowledge that you are using this plugin at your own risk. The plugin developer who is also the author is not liable for any damages, losses, or issues that may arise from its use. It is your responsibility to ensure that the plugin is suitable for your needs and that you use it in a manner that complies with all applicable laws and regulations.

Support and Customization

For any job offers, code commission work, questions, or if you encounter any issues, please feel free to reach out to Donalda at [email protected].

Important Note Regarding Support

Please be aware that I do not offer free support for my free plugins. If you require any modifications, customizations, or changes to the plugin's functionality, these are what I consider paid jobs, and I do not provide them for free. (Sadly, I've been burned by the internet before so now I require the fee as 1/2 upfront and the rest upon delivery. NO Exceptions!)

Thank you for your understanding and for using the OpenAI Chat WordPress Plugin.

License

This plugin is released under the GNU GPLv2.