Documentation

Welcome to the official documentation for ChatMate AI. Learn how to install, configure, and get the most out of your RAG-powered WordPress chatbot.

Installation

Getting started with ChatMate AI is simple. Follow these steps to install the plugin on your WordPress site.

1. Download the chatmate-ai.zip file from your purchase confirmation.
2. Log in to your WordPress Admin Dashboard.
3. Navigate to Plugins > Add New.
4. Click Upload Plugin and select the zip file.
5. Click Install Now and then Activate.

Configuration & Settings

ChatMate AI is organized into several tabs for granular control over your chatbot.

General Settings

• Enable Chatbot: Toggle the chatbot on or off globally.
• Pages to Skip: Select specific pages where the chatbot should be hidden (e.g., checkout or landing pages).
• Save Chat Logs: Enable to store chat history locally on your server for insights. If disabled, chats are processed by OpenAI but not stored in your WordPress database. Note: Recent chat history is always stored in the user's browser (localStorage) to maintain conversation context across page reloads.
• Data Retention Period: Select how long to keep logs (1, 3, 7, 14, or 30 days) before auto-deletion.

API Configuration

• OpenAI API Key: Enter your secret key to connect to OpenAI's services.
• Model Selection: Choose between available models (e.g., GPT-4o Mini) based on your needs.
• System Instructions: Define your assistant's core behavior:
  • Persona: Set the role (e.g., "Official Customer Support Assistant").
  • Communication Style: Define tone, voice (First-person plural), and language rules.
  • Product Link Rule: Configure how the bot links to your products.
  • Greeting Handling: Define standard responses for casual greetings ("Hi", "Hello").
• "I Don't Know" Message: Set a fallback message for when the AI cannot answer.

Customization

Tailor the visual appearance and interaction style of the chatbot.

Appearance

• Assistant Identity: Set the Assistant Name and upload a custom Avatar.
• Floating Icon Position: Choose where the trigger button appears (e.g., Bottom Right).
• Colors & Branding: Fully customize the Primary Color, User Bubble/Text, and Bot Bubble/Text colors.
• Typography: Adjust the chat font size.
• Feedback: Enable Upvote/Downvote buttons on AI responses.

Messages

• Welcome Message: detailed HTML-supported welcome note to greet users.
• Error Message: Custom text displayed during connection issues.
• Timeout Message: Message shown if a request takes too long.

Insights Dashboard

Monitor your chatbot's performance and user engagement.

• Engagement Stats: View Total Queries, Responses Given, Unique Users, and Avg Queries per User.
• Date Range: Filter metrics by date (e.g., Today, Last 7 Days).
• Top Keywords: See frequently used terms to understand user intent.
• Recent Chats: View a list of conversation logs with Last Activity timestamps and Export to CSV capability.

Knowledge Base

Train your AI using two powerful methods: Document Uploads and Manual FAQs.

Documents (RAG)

• File Support: Upload PDF, DOCX, TXT, Code files (JS/PY/PHP), JSON, and more (Max 25MB each).
• Management: View file status, delete old files, or link directly to OpenAI Storage.
• Training: Files are automatically indexed into a Vector Store for retrieval.

Vector Store Management

• Auto-Creation by Domain: The system automatically creates a unique Vector Store named after your domain (e.g., yoursite.com).
• Smart De-duplication: Prevents duplicate files and stores. If a file exists in your OpenAI account, it's reused instead of re-uploaded.
• Instant Reconnection: Reinstalling the plugin automatically reconnects to your existing domain's Vector Store.

Manual FAQs

• Q&A Pairs: Manually add specific Questions and detailed Answers.
• Export: Download all FAQs as a text file for backup or external training.
• Listing: Manage and edit existing FAQs directly from the dashboard.

GDPR Compliance Suite

Ensure your chatbot complies with privacy regulations.

• Enable Compliance: Displays a mandatory privacy consent popup for first-time users.
• Privacy Information: Custom Privacy Title and Description. Includes smart switching for "Logs On" vs "Logs Off" descriptions.
• Privacy Description (Logs Off): Custom message shown when "Save Chat Logs" is disabled.
• Policy Links: Add your Privacy Policy URL and custom link text.
• Dynamic Accept Button: Customize the text of the "Accept & Start Chat" button.
• Consent Message: Define the exact text users must agree to before chatting.
• Cookie Usage: Sets a chatmate_gdpr_consent cookie (valid for 365 days) when a user accepts the privacy policy.
• Browser Storage: Uses LocalStorage to persist session data (Expires in 7 days):
  • chatmate_convo_id: Stores the active OpenAI Thread ID.
  • chatmate_messages: Caches recent chat history for instant loading.

Cost Estimation

Estimating your OpenAI usage costs is important. This guide helps you calculate potential running costs.

Model Pricing (Per 1M Tokens)

Example Monthly Costs

Based on a standard interaction (10 questions/answers per chat):

Vector Store Costs

• Storage: $0.10 per GB / day (First 1 GB is free).
• Search: Retrieval counts as input tokens.

Freqently Asked Questions

Changelog