Initial commit
This commit is contained in:
Josako
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