Documentation & Help

Everything you need to get started with IrisAI

Quick Start Guide

Step 1: Install the Plugin

1. Download IrisAI from WordPress.org
2. Go to Plugins – Add New in your WordPress admin
3. Click “Upload Plugin” and select the ZIP file
4. Click “Install Now” and then “Activate”

Step 2: Choose Your Mode

Option A: Proxy Mode (Recommended)

1. Sign up at irisai.cloud
2. Register your WordPress domain
3. Purchase credits via PayPal
4. Copy your Proxy Base URL and API Key
5. Go to IrisAI – General tab in WordPress
6. Paste your credentials and save

Option B: BYO Mode

1. Get an API key from platform.openai.com
2. Go to IrisAI – General tab in WordPress
3. Enable “Bring Your Own Key” mode
4. Enter your OpenAI API key
5. Save settings

Step 3: Index Your Content

1. Go to IrisAI – Vector Search tab
2. Click “Start Indexing”
3. Wait for the process to complete (2-3 seconds per page)
4. Your content is now searchable!

Step 4: Add Chat to Your Site

Option A: Full-Page Chat

1. Create a new page (e.g., “AI Assistant”)
2. Select a full-width template
3. Add the shortcode: [irisai_chat]
4. Publish and add to your menu

Option B: Floating Widget

1. Go to IrisAI – Widget tab
2. Enable “Auto-inject Widget”
3. Choose position (bottom-right recommended)
4. Save settings
5. Widget now appears on all pages!

Or manually add: [irisai_widget]

Step 5: Customize (Optional)

• Visit the Appearance tab to match your brand colors
• Edit suggestion chips in the General tab
• Customize welcome message in Widget tab
• Adjust chat behavior in Chat Page tab

Shortcode Reference

Full-Page Chat

Basic Usage:

[irisai_chat]

What It Does:

• Creates a full-page chat interface
• Includes animated hero section
• Shows suggestion chips
• Displays wave background animation

Best For:

• Dedicated AI assistant pages
• Help centers
• Support pages

---

Floating Widget

Basic Usage:

[irisai_widget]

With Position:

[irisai_widget position="bottom-right"]
[irisai_widget position="bottom-left"]
[irisai_widget position="top-right"]
[irisai_widget position="top-left"]

What It Does:

• Adds a floating chat button
• Opens compact popup window
• Persists across page navigation
• Shows welcome message

Best For:

• Site-wide availability
• Non-intrusive chat access
• E-commerce stores

Troubleshooting

Chat Not Working

Symptoms: No response when asking questions

Solutions:

1. Verify API credentials in General tab
2. Check that content is indexed (Vector Search tab)
3. Ensure sufficient credits (Proxy mode) or API quota (BYO mode)
4. Check browser console for JavaScript errors (F12)
5. Verify domain is registered in proxy dashboard

Indexing Failed

Symptoms: Indexing process stops or shows errors

Solutions:

1. Check PHP max_execution_time (increase to 300+)
2. Verify database permissions
3. Check for WordPress memory limits (increase to 256MB+)
4. Try indexing in smaller batches
5. Enable WP_DEBUG for detailed error logs

Widget Not Appearing

Symptoms: Floating button doesn’t show

Solutions:

1. Check “Auto-inject Widget” is enabled (Widget tab)
2. Clear browser cache and hard refresh (Ctrl+Shift+R)
3. Check for CSS conflicts with theme
4. Verify JavaScript is enabled in browser
5. Check z-index conflicts with other floating elements

Slow Responses

Symptoms: Chat takes long to respond

Solutions:

1. Reduce max_tokens in General tab (try 500-800)
2. Check server response times
3. Verify OpenAI API status
4. Consider using faster model (GPT-3.5 Turbo)
5. Check hosting server performance

Wrong Answers

Symptoms: AI gives incorrect or irrelevant answers

Solutions:

1. Re-index content after major updates
2. Improve content structure (clear headings, concise text)
3. Adjust system prompt for better context
4. Increase number of retrieved chunks
5. Verify content quality and accuracy

API Key Errors

Symptoms: “Invalid API key” or authentication errors

Solutions:

1. Verify API key is copied correctly (no extra spaces)
2. Check key hasn’t expired or been revoked
3. Confirm domain is registered (Proxy mode)
4. Test key in proxy dashboard
5. Regenerate API key if necessary

Best Practices

Content Optimization

• Clear Headings: Use descriptive H1, H2, H3 tags
• Concise Text: Keep paragraphs focused and scannable
• Structured Data: Use lists, tables for factual info
• Regular Updates: Re-index after significant changes
• Quality Over Quantity: Well-written content performs better

Suggestion Chips

• Ask common questions your visitors have
• Cover different topic areas (products, support, about)
• Keep them short (5-10 words)
• Update seasonally or based on trends
• Test which ones get clicked most

System Prompts

• Define your brand voice and tone
• Specify response length preferences
• Include key disclaimers if needed
• Guide AI on handling off-topic questions
• Update based on user feedback

Performance

• Index during low-traffic hours
• Monitor token usage regularly
• Set appropriate rate limits
• Use caching where possible
• Optimize content length

User Experience

• Place widget where it won’t obstruct content
• Write welcoming, helpful messages
• Test on mobile devices
• Monitor chat logs for improvements
• Respond to feedback quickly

Getting Help

Support Channels

Before Contacting Support

1. Check this documentation page
2. Review troubleshooting section
3. Search community forum
4. Enable WP_DEBUG for error details
5. Prepare plugin/theme versions

What to Include in Support Requests

• WordPress version
• IrisAI plugin version
• Active theme name
• Mode (Proxy or BYO)
• Error messages (if any)
• Steps to reproduce issue
• Browser console errors