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.

Note: Ensure you have a valid OpenAI API key before starting.

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 on your server for insights. (Required for the Insights tab).
  • 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, TXT, DOCX, and JSON files (Max 2MB 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

  • Multi-Site Support: Create unique Vector Stores for different sites sharing the same API key.
  • Data Isolation: Files are strictly isolated to their specific Vector Store, ensuring knowledge bases never mix.
  • Easy Switching: Instantly switch between active stores to manage files for different contexts.

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: Customize the Privacy Title and Description text.
  • Policy Links: Add your Privacy Policy URL and custom link text.
  • Consent Message: Define the exact text users must agree to before chatting.

Cost Estimation

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

Updated Pricing (Dec 2025): Calculations include latest GPT-5 and Nano models. Prices subject to change by OpenAI.

Model Pricing (Per 1M Tokens)

Model Input Output Verdict
GPT-5-nano $0.05 $0.40 Ultra Low Cost
GPT-5-mini $0.125 $1.00 Balanced
GPT-4o-mini $0.15 $0.60 Reliable Budget
GPT-5 $1.25 $10.00 Best Intelligence
GPT-4o $2.50 $10.00 Standard

Example Monthly Costs

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

Traffic (Chats/Month) GPT-5-nano GPT-5-mini GPT-4o-mini GPT-5 GPT-4o
Small (100) $0.13 $0.33 $0.30 $3.31 $5.12
Medium (1,000) $1.30 $3.30 $3.00 $33.10 $51.20
High (5,000) $6.50 $16.50 $15.00 $165.50 $256.00

Vector Store Costs

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

Freqently Asked Questions

Do I need to create an Assistant on OpenAI manually?

No! ChatMate handles the Assistant creation and Vector Store management entirely within WordPress.

What happens if my API key expires?

The chatbot will stop responding. You will see an error in the logs. Simply update the key in the settings to restore service.

Can I export chat history?

Yes, go to the Insights tab to view analytics and export chat logs to CSV.

Changelog

v1.0.0 Dec 16, 2025
  • New Initial release of ChatMate AI.
  • New RAG System with Knowledge Base integration.
  • New OpenAI Vector Store management.
  • New Custom Chat Widget with theming support.