Initial commit
This commit is contained in:
Josako
96
docs/Integrations/WordPress/WordPress Basics.md
Normal file
96
docs/Integrations/WordPress/WordPress Basics.md
Normal file
@@ -0,0 +1,96 @@
|
||||
---
|
||||
id: wordpress-overview
|
||||
title: WordPress Integration
|
||||
description: Overview of Evie's WordPress integration capabilities
|
||||
sidebar_label: Overview
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# WordPress Integration
|
||||
|
||||
Evie offers seamless integration with WordPress through two dedicated plugins that help you enhance your WordPress site with AI capabilities. These plugins allow you to both synchronize your content with Evie's knowledge base and provide intelligent chat functionality to your visitors.
|
||||
|
||||
## Available Plugins
|
||||
|
||||
### Content Synchronization (eveai_sync)
|
||||
The content synchronization plugin automatically keeps your Evie knowledge base up-to-date with your WordPress content:
|
||||
- Syncs posts and pages to Evie's Standard Catalog
|
||||
- Maintains versioning of your content
|
||||
- Ensures your AI interactions always use the latest content
|
||||
|
||||
### Chat Integration (eveai_chat)
|
||||
Add intelligent chat capabilities to your WordPress site:
|
||||
- Easy-to-integrate chat widget
|
||||
- Powered by Evie's Q&A RAG Specialist
|
||||
- Supports multiple languages
|
||||
- Simple configuration and setup
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before you can use either plugin, you'll need:
|
||||
|
||||
1. A WordPress website
|
||||
2. An Evie account with API access
|
||||
3. An API key from Ask Eve AI
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Obtaining Your API Key
|
||||
|
||||
To use the WordPress plugins, you'll need an API key from Ask Eve AI. You can ask your AskEveAI administrator to provide you
|
||||
with an API Key. After the request, you'll receive an email containing:
|
||||
- Your tenant information
|
||||
- A unique API key
|
||||
- Enabled services information
|
||||
|
||||
Here's an example of the API key email you'll receive:
|
||||
|
||||
|
||||
|
||||
:::important
|
||||
Store your API key securely. It cannot be retrieved once the email is gone.
|
||||
:::
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[Request API Access] -->|Receive Email| B[API Key]
|
||||
B --> C[Configure Plugins]
|
||||
C --> D[Start Using Integration]
|
||||
```
|
||||
|
||||
### Installation
|
||||
|
||||
Both plugins can be [downloaded here](https://www.dropbox.com/scl/fo/6pkrp8o1n6rjvawjyrstt/AGGNOGlVn4hAz_BZOngOj68?rlkey=nj9gyz1k0bcjz7sxr0jq5c59l&dl=0)
|
||||
|
||||
Both plugins follow the standard WordPress plugin installation process:
|
||||
|
||||
1. Download the plugin files
|
||||
2. Go to your WordPress admin panel
|
||||
3. Navigate to Plugins > Add New
|
||||
4. Click "Upload Plugin"
|
||||
5. Select the plugin file and click "Install Now"
|
||||
6. Activate the plugin
|
||||
|
||||
### Next Steps
|
||||
|
||||
After installation, each plugin requires specific configuration:
|
||||
|
||||
- [Content Synchronization Setup](./sync-plugin) - Configure how your WordPress content syncs with Evie
|
||||
- [Chat Integration Setup](./chat-plugin) - Set up the AI chat widget for your website
|
||||
|
||||
## Support and Customization
|
||||
|
||||
:::important
|
||||
Aggressive caching in WordPress can cripple correct behaviour of the Chat Plugin
|
||||
:::
|
||||
|
||||
When running into problems:
|
||||
- Enable debugging in WordPress. We have quite extensive logging in both components.
|
||||
- For the chatbot itself, you can check the browser console (at least, on Chrome). A lot of debugging information is available.
|
||||
|
||||
Both plugins are provided as open-source software, allowing for:
|
||||
- Custom modifications to match your needs
|
||||
- Integration with existing WordPress themes
|
||||
- Extended functionality development
|
||||
|
||||
For technical support or questions about customization, please contact our support team.
|
||||
8
docs/Integrations/WordPress/_category_.json
Normal file
8
docs/Integrations/WordPress/_category_.json
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "WordPress Integrations",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Learn about the WordPress integration possibilities of Evie"
|
||||
}
|
||||
}
|
||||
127
docs/Integrations/WordPress/eveai_chat_plugin.md
Normal file
127
docs/Integrations/WordPress/eveai_chat_plugin.md
Normal file
@@ -0,0 +1,127 @@
|
||||
---
|
||||
id: chat-plugin
|
||||
title: Chat Integration Plugin
|
||||
description: Add AI chat capabilities to your WordPress site
|
||||
sidebar_label: Chat Integration
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Chat Integration Plugin (eveai_chat)
|
||||
|
||||
The eveai_chat plugin enables you to add Evie's intelligent chat capabilities to any page or post on your WordPress site, allowing visitors to interact with your content through natural language conversations.
|
||||
|
||||
## Configuration
|
||||
|
||||
After installing and activating the plugin, configure the connection settings:
|
||||
|
||||
|
||||
|
||||
### Connection Settings
|
||||
|
||||
| Setting | Description |
|
||||
|---------|-------------|
|
||||
| Tenant ID | Your unique tenant identifier (found in API key email) |
|
||||
| API Key | Your authentication key (found in API key email) |
|
||||
| Socket URL | Evie's WebSocket endpoint (`https://evie.askeveai.com/`) |
|
||||
| Auth URL | Authentication endpoint (`https://evie.askeveai.com/api`) |
|
||||
|
||||
Click "Save Settings" to store your configuration.
|
||||
|
||||
## Adding Chat Widgets
|
||||
|
||||
Once configured, you can add chat widgets to your pages or posts using a simple shortcode:
|
||||
|
||||
```
|
||||
[eveai_chat language="en" languages="en,nl,fr,de,es" specialist_id="1"]
|
||||
```
|
||||
|
||||
### Shortcode Parameters
|
||||
|
||||
| Parameter | Description | Example |
|
||||
|-----------|-------------|---------|
|
||||
| language | Default chat language | `language="en"` |
|
||||
| languages | Available languages (comma-separated) | `languages="en,nl,fr,de"` |
|
||||
| specialist_id | ID of the Q&A RAG Specialist to use | `specialist_id="1"` |
|
||||
|
||||
Example implementation on a page:
|
||||
|
||||
|
||||
|
||||
## Chat Widget Behavior
|
||||
|
||||
### Language Support
|
||||
- Users can switch languages during conversations via a dropdown menu
|
||||
- Language changes take effect immediately for new messages
|
||||
- Previous messages remain in their original language
|
||||
- Available languages are determined by your Evie tenant configuration
|
||||
|
||||
### Conversation Management
|
||||
- Each page refresh starts a new conversation
|
||||
- Conversations don't persist across page navigations
|
||||
- No usage limits are currently implemented
|
||||
|
||||
### Widget Display
|
||||
- Widget appears where the shortcode is placed in your content
|
||||
- Default height is 75vh (75% of viewport height)
|
||||
- Supports multiple widgets per page
|
||||
- Each widget can have different language and specialist settings
|
||||
- All widgets use the same tenant configuration
|
||||
|
||||
## Implementation Guidelines
|
||||
|
||||
### Best Practices
|
||||
1. **Specialist Selection**:
|
||||
- Use Q&A RAG Specialists only
|
||||
- Ensure specialist doesn't require additional parameters
|
||||
- Verify specialist ID before implementation
|
||||
|
||||
2. **Widget Placement**:
|
||||
- Consider user experience when placing widgets
|
||||
- Test on different screen sizes
|
||||
- Avoid placing multiple widgets too close together
|
||||
|
||||
3. **Language Configuration**:
|
||||
- Set appropriate default language for your audience
|
||||
- Only include languages supported by your tenant
|
||||
- Provide clear language selection options
|
||||
|
||||
### Customization
|
||||
|
||||
The widget's appearance can be customized by modifying the plugin's CSS:
|
||||
|
||||
1. Locate `eveai-chat-style.css` in the plugin directory
|
||||
2. Modify styles to match your website's design
|
||||
3. Test changes across different devices and screen sizes
|
||||
|
||||
:::note
|
||||
Detailed customization instructions are beyond the scope of this documentation. For advanced customization needs, please consult your development team.
|
||||
:::
|
||||
|
||||
## Technical Considerations
|
||||
|
||||
- Widgets are displayed at shortcode location
|
||||
- Multiple widgets can be used within one WordPress instance
|
||||
- All widgets must use the same tenant
|
||||
- Different specialists can be used for different widgets
|
||||
- Mobile responsiveness should be considered when placing widgets
|
||||
- Page refreshes will reset conversations
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A[Configure Plugin Settings] -->|Save| B[Add Shortcode to Page]
|
||||
B --> C[Configure Widget Parameters]
|
||||
C --> D[Test Implementation]
|
||||
D --> E[Customize Appearance]
|
||||
style B fill:#3ecc5f,stroke:#333,stroke-width:2px
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Issue | Possible Solution |
|
||||
|-------|------------------|
|
||||
| Widget not appearing | Verify shortcode syntax |
|
||||
| Connection errors | Check API credentials |
|
||||
| Invalid specialist errors | Verify specialist_id exists and is a Q&A RAG Specialist |
|
||||
| Language not available | Confirm language is enabled in tenant configuration |
|
||||
|
||||
For additional support or custom implementation needs, contact your Evie support representative.
|
||||
121
docs/Integrations/WordPress/eveai_sync_plugin.md
Normal file
121
docs/Integrations/WordPress/eveai_sync_plugin.md
Normal file
@@ -0,0 +1,121 @@
|
||||
---
|
||||
id: sync-plugin
|
||||
title: Content Synchronization Plugin
|
||||
description: Automatically sync your WordPress content with Evie
|
||||
sidebar_label: Content Sync
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Content Synchronization Plugin (eveai_sync)
|
||||
|
||||
The eveai_sync plugin automatically synchronizes your WordPress content with Evie's knowledge base, ensuring that your AI interactions always have access to your latest content.
|
||||
|
||||
## Configuration
|
||||
|
||||
After installing and activating the plugin, you'll need to configure several settings to connect with Evie:
|
||||
|
||||
|
||||
|
||||
### Basic Settings
|
||||
|
||||
| Setting | Description |
|
||||
|---------|----------------------------------------------------------------------|
|
||||
| API URL | The base URL for Evie's API (`https://eveai.askeveai.com/api/`) |
|
||||
| Tenant ID | Your unique tenant identifier (found in your API key email) |
|
||||
| API Key | Your authentication key for the API (found in your API key email) |
|
||||
| Catalog ID | The ID of the Evie catalog where content will be stored |
|
||||
| Default Language | The primary language of your content |
|
||||
| Excluded Categories | Comma-separated list of WordPress categories to exclude from syncing |
|
||||
|
||||
Click "Save Settings" to store your configuration.
|
||||
|
||||
## Initial Content Sync
|
||||
|
||||
When setting up the plugin for the first time, you'll need to perform an initial bulk sync of your existing content:
|
||||
|
||||
1. Configure all settings as described above
|
||||
2. Click the "Start Bulk Sync" button
|
||||
3. Wait for the sync to complete
|
||||
- A log will be displayed after the sync finishes
|
||||
- The process cannot be interrupted once started
|
||||
- All published posts and pages (except excluded categories) will be uploaded to Evie
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A[Configure Settings] -->|Save| B[Start Bulk Sync]
|
||||
B --> C[Upload Content]
|
||||
C --> D[Process Content]
|
||||
D --> E[Sync Complete]
|
||||
style B fill:#3ecc5f,stroke:#333,stroke-width:2px
|
||||
```
|
||||
|
||||
## Automatic Synchronization
|
||||
|
||||
After the initial setup, the plugin automatically maintains synchronization between your WordPress site and Evie:
|
||||
|
||||
### What Gets Synced?
|
||||
|
||||
✅ **Synchronized**:
|
||||
- Published posts and pages
|
||||
- Content updates to existing posts/pages
|
||||
- HTML content and formatting
|
||||
|
||||
❌ **Not Synchronized**:
|
||||
- Draft content
|
||||
- Private or password-protected content
|
||||
- Posts/pages in excluded categories
|
||||
|
||||
### Sync Behaviors
|
||||
|
||||
The plugin handles different content changes automatically:
|
||||
|
||||
| Action in WordPress | Result in Evie |
|
||||
|--------------------|----------------------------------------|
|
||||
| New post/page published | Creates new document in Evie |
|
||||
| Existing content updated | Creates a new document version in Evie |
|
||||
| Content deleted | Marks document as invalid in Evie* |
|
||||
|
||||
*Note: Documents are never deleted from Evie to preserve historical interaction context.
|
||||
|
||||
### Processing Status
|
||||
|
||||
While content synchronization happens automatically, the actual processing in Evie occurs asynchronously:
|
||||
- Content is immediately sent to Evie when changes occur
|
||||
- Processing status can be monitored in Evie's administrative interface
|
||||
- Final processing time depends on network conditions and content complexity
|
||||
|
||||
## Resetting the Integration
|
||||
|
||||
If you need to start fresh (for example, when switching to a different catalog), you can reset the integration:
|
||||
|
||||
1. Click the "Reinitialize Site" button
|
||||
2. All Evie metadata will be removed from your WordPress site
|
||||
3. Sync status for all content will be reset
|
||||
4. You can then reconfigure the plugin and perform a new bulk sync
|
||||
|
||||
:::caution
|
||||
Reinitializing the site only affects the WordPress-Evie connection metadata. It does not delete any content from either WordPress or Evie.
|
||||
:::
|
||||
|
||||
## Best Practices
|
||||
|
||||
To get the most out of the content synchronization:
|
||||
|
||||
1. **Initial Setup**:
|
||||
- Configure and test settings before starting bulk sync
|
||||
- Choose excluded categories carefully
|
||||
|
||||
2. **Content Management**:
|
||||
- Publish content only when it's ready for AI consumption
|
||||
- Maintain consistent content structure for better AI interactions
|
||||
|
||||
3. **Monitoring**:
|
||||
- Regularly check Evie's administrative interface for processing status
|
||||
- Review AI interactions to ensure content is being utilized effectively
|
||||
|
||||
## Technical Considerations
|
||||
|
||||
- The plugin handles HTML content, preserving your content's formatting
|
||||
- No special catalog configuration is required in Evie
|
||||
- There are no size limitations for WordPress sites
|
||||
- Network connectivity affects sync speed and reliability
|
||||
Reference in New Issue
Block a user