Initial commit

2025-12-11 14:43:16 +01:00
commit 7ef62972f3
36 changed files with 23641 additions and 0 deletions
--- a/docs/Integrations/WordPress/eveai_chat_plugin.md
+++ b/docs/Integrations/WordPress/eveai_chat_plugin.md
@@ -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:
+
+![Chat Plugin Settings](/img/wordpress-chat-settings.png)
+
+### 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 Implementation](/img/wordpress-chat-shortcode.png)
+
+## 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.