diff --git a/docs/addons/superdav-ai-agent/index.mdx b/docs/addons/superdav-ai-agent/index.mdx index e6c7a6aa9a..166151ec04 100644 --- a/docs/addons/superdav-ai-agent/index.mdx +++ b/docs/addons/superdav-ai-agent/index.mdx @@ -9,7 +9,7 @@ import AddonBanner from '@site/src/components/AddonBanner'; # Superdav AI Agent -Superdav AI Agent is an advanced WordPress AI assistant that extends Gratis AI Agent with theme-aware skills, enhanced internet search capabilities, site builder features, and optional automation integrations. Version 1.18.0 adds Google Calendar read tools, contact and attendee mapping, human approval gates, reminder deduplication, TextBee SMS notifications, managed Superdav service provisioning, and a separately distributed Advanced companion package for trusted developer workflows. +Superdav AI Agent is an advanced WordPress AI assistant that extends Gratis AI Agent with theme-aware skills, enhanced internet search capabilities, site builder features, customer-facing chat modes, documentation knowledge imports, and optional automation integrations. Version 1.19.0 adds static documentation knowledge imports, anonymous public chat, embeddable documentation chat widgets, customer simple chat mode, a customer chat setup tool, and calendar SMS reminder setup/orchestration on top of the v1.18.0 calendar, approval, notification, managed-service, and Advanced companion workflows. ## Key Features @@ -32,6 +32,12 @@ Superdav AI Agent is an advanced WordPress AI assistant that extends Gratis AI A - **Reminder records and deduplication** — track reminders that have already been sent so repeat automation runs do not notify the same recipient twice - **TextBee SMS notifications** — send configured text-message notifications through TextBee when an SMS provider is enabled - **Managed Superdav service provisioning** — connect supported sites to hosted Superdav endpoints with automatic setup instead of manual endpoint configuration +- **Static documentation knowledge imports** — build a searchable knowledge base from configured documentation sites for docs-aware answers +- **Anonymous public chat** — allow approved visitors to ask limited questions without a WordPress login +- **Embeddable docs chat widgets** — place a documentation-aware assistant on public docs, help, or product pages +- **Customer simple chat mode** — present a focused customer-facing assistant with simplified controls and safer defaults +- **Customer chat setup tool** — guide administrators through the settings needed for a public or customer-facing assistant +- **Calendar SMS reminder orchestration** — configure calendar-driven text-message reminders with approval, mapping, and deduplication controls - **Advanced companion package** — separately distributed trusted-developer tools for filesystem, database, WP-CLI, REST dispatcher, plugin builder, git snapshot, user-management, and benchmark workflows ## Requirements @@ -47,13 +53,13 @@ Superdav AI Agent is an advanced WordPress AI assistant that extends Gratis AI A 1. Upload the plugin files to `/wp-content/plugins/superdav-ai-agent` 2. Activate the plugin through the **Plugins** screen in WordPress 3. Ensure Gratis AI Agent is also activated -4. Navigate to **Gratis AI Agent → Settings** and configure your internet search provider, managed Superdav service connection, Google Calendar, or TextBee credentials as needed +4. Navigate to **Gratis AI Agent → Settings** and configure your internet search provider, managed Superdav service connection, Google Calendar, TextBee credentials, public chat mode, customer chat widget, or documentation import sources as needed The WordPress.org package contains the core Superdav AI Agent features. The Advanced companion package is built and distributed separately for environments where trusted developer tools are explicitly installed and authorised. ## Quick Start -Once activated, Superdav AI Agent automatically enhances your Gratis AI Agent installation with theme-aware skills and additional capabilities. Open the **Gratis AI Agent** panel in the WordPress admin sidebar and start using the new features. +Once activated, Superdav AI Agent automatically enhances your Gratis AI Agent installation with theme-aware skills and additional capabilities. Open the **Gratis AI Agent** panel in the WordPress admin sidebar to use internal assistant features, or use the customer chat setup tool when you want a public or customer-facing assistant. **Example instructions:** @@ -77,6 +83,18 @@ Review tomorrow's configured Google Calendar events and draft reminders for atte Send an SMS reminder after I approve the message. ``` +``` +Import our documentation site into the assistant knowledge base. +``` + +``` +Create a public docs chat widget for the product help centre. +``` + +``` +Set up customer simple chat mode for anonymous visitors. +``` + ## Theme-Aware Skills Superdav AI Agent automatically detects your active theme and installed plugins, loading the appropriate theme-aware skill into the assistant's context. Available skills include: @@ -101,17 +119,30 @@ Superdav AI Agent v1.10.0 adds **Tavily** as an alternative to Brave Search for See [Internet Search](../../user-guide/configuration/internet-search) for configuration instructions. +## Documentation Knowledge and Customer Chat + +Superdav AI Agent v1.19.0 adds customer-facing assistant experiences that can answer from approved documentation sources: + +- **Static documentation imports** fetch configured documentation sites and add their content to the assistant knowledge base, making public support answers more consistent with your published docs. +- **Anonymous public chat** lets visitors ask approved questions without requiring a WordPress account. Keep public tools read-only and limit them to documentation or customer-support use cases. +- **Embeddable docs chat widgets** can be placed on documentation, help-centre, or product pages so customers can ask questions in context. +- **Customer simple chat mode** reduces the interface to a focused customer assistant instead of the full administrator chat panel. +- **Customer chat setup tool** walks administrators through the required public-chat, widget, knowledge-source, and safety settings. + +Recommended setup: import trusted documentation sources first, review the generated knowledge counts, enable customer simple chat mode, then embed the docs widget on a limited page before making it broadly available. + ## Calendar, Approval, and Notification Workflows -Superdav AI Agent v1.18.0 expands automation workflows beyond content and site-building tasks: +Superdav AI Agent v1.18.0 expanded automation workflows beyond content and site-building tasks, and v1.19.0 adds setup/orchestration controls for calendar-driven SMS reminders: - **Google Calendar tools** let the agent read configured calendars and event details when calendar credentials are available. - **Contact and attendee helpers** map event participants to WordPress users or known contacts before preparing reminders or follow-up tasks. - **Human approval gates** allow an automation to pause until an authorised user reviews the proposed action. - **Reminder records** prevent duplicate calendar or notification reminders when an automation is retried or scheduled repeatedly. - **TextBee SMS support** enables text-message notifications when the TextBee provider is configured. +- **Calendar SMS reminder setup** helps administrators connect calendar selections, attendee/contact mappings, SMS provider settings, approval requirements, and reminder deduplication into one reminder workflow. -Use these tools for schedule-aware assistance, attendee follow-up, and reminder workflows that still require human review before sensitive messages are sent. +Use these tools for schedule-aware assistance, attendee follow-up, and reminder workflows that still require human review before sensitive messages are sent. For customer-facing reminders, test with an administrator-owned number before enabling recurring calendar SMS orchestration. ## Site Builder Contact Forms @@ -160,6 +191,9 @@ All settings are under **Gratis AI Agent → Settings** in the WordPress admin. | **Managed Superdav Service** | Connect supported sites to the hosted Superdav service with automatic endpoint provisioning | | **Google Calendar Credentials** | Configure calendar access so the agent can read calendars and events | | **TextBee SMS Provider** | Configure TextBee credentials for approved SMS notification workflows | +| **Static Documentation Sources** | Add documentation URLs or sources that should be imported into the assistant knowledge base | +| **Public / Customer Chat Mode** | Enable anonymous public chat, customer simple chat mode, and the embeddable docs chat widget | +| **Calendar SMS Reminder Setup** | Connect calendar selections, contact mappings, approvals, and SMS settings for reminder orchestration | ## Advanced Companion Package @@ -167,6 +201,14 @@ Superdav AI Agent v1.18.0 adds a separately distributed Advanced companion packa Advanced tools include filesystem operations, database access, WP-CLI, REST dispatcher workflows, plugin builder utilities, git snapshots, user-management helpers, and benchmark tooling. Keep these tools limited to trusted administrators and review approval-gate configuration before enabling them on production sites. +## Improvements in v1.19.0 + +- **Static documentation knowledge imports** — build searchable assistant knowledge from approved documentation sites +- **Public and customer chat modes** — support anonymous public chat, customer simple chat mode, embeddable documentation chat widgets, and the customer chat setup tool +- **Calendar SMS reminder setup** — orchestrate calendar selections, attendee/contact mapping, approvals, deduplication, and TextBee SMS settings for reminder workflows +- **Public docs chat reliability** — improve public docs chat behaviour, packaging validation, and bundled DI cache packaging for more reliable releases +- **Chat and provider fixes** — improve retry and recovery states, embedded assistant Markdown rendering, provider/model handling, knowledge count queries, calendar SMS mappings, and tool permission defaults + ## Improvements in v1.18.0 - **Google Calendar support** — read configured calendars and events for schedule-aware automations diff --git a/docs/user-guide/administration/gratis-ai-agent-settings.md b/docs/user-guide/administration/gratis-ai-agent-settings.md index 055761ec2c..36767ab992 100644 --- a/docs/user-guide/administration/gratis-ai-agent-settings.md +++ b/docs/user-guide/administration/gratis-ai-agent-settings.md @@ -5,7 +5,7 @@ sidebar_position: 22 # Gratis AI Agent Settings -The **Settings → Advanced** screen in Gratis AI Agent provides administrator-level configuration for backend integrations. This page documents feedback forwarding, search provider keys, managed Superdav service setup, Google Calendar controls, TextBee SMS settings, and network-wide feature flags. +The **Settings → Advanced** screen in Gratis AI Agent provides administrator-level configuration for backend integrations. This page documents feedback forwarding, search provider keys, managed Superdav service setup, Google Calendar controls, TextBee SMS settings, public/customer chat controls, static documentation imports, calendar SMS reminder setup, and network-wide feature flags. ## Accessing Settings @@ -109,6 +109,52 @@ Superdav AI Agent v1.18.0 adds TextBee as an SMS provider for configured notific Send a test message only to an administrator-owned number, then confirm approval-gate behaviour before enabling scheduled or attendee-facing reminders. +## Public and Customer Chat Configuration + +Superdav AI Agent v1.19.0 adds settings for customer-facing assistant experiences. Use these controls when visitors or customers should be able to ask limited questions without the full administrator chat panel. + +| Field | Description | +|---|---| +| **Enable Anonymous Public Chat** | Allows approved unauthenticated visitors to open a public chat experience. Keep enabled tools limited to read-only support or documentation answers. | +| **Customer Simple Chat Mode** | Uses a simplified customer-facing chat interface instead of the full internal assistant panel. | +| **Docs Chat Widget / Embed Code** | Provides the widget or embed settings for placing a documentation-aware assistant on help, product, or documentation pages. | +| **Customer Chat Setup Tool** | Opens a guided setup flow for public-chat mode, widget placement, documentation sources, and safety settings. | + +Recommended setup: + +1. Configure the assistant name, branding, and public-chat scope. +2. Enable **Customer Simple Chat Mode** for customer-facing pages. +3. Use the **Customer Chat Setup Tool** to review allowed tools, anonymous access, and widget placement. +4. Test the widget in a private or staging page before adding it to public navigation. +5. Review a sample anonymous conversation and confirm the assistant answers only from approved sources or safe public context. + +## Static Documentation Knowledge Imports + +Static documentation imports let administrators build a searchable knowledge base from approved documentation sites. Use them before publishing a docs chat widget so the assistant can answer from current product documentation. + +| Field | Description | +|---|---| +| **Documentation Import Sources** | Lists documentation sites, sections, or source URLs that may be imported. Use only trusted public or internal documentation sources that the assistant is allowed to quote. | +| **Run Documentation Import** | Starts or refreshes the static documentation import job. | +| **Knowledge Counts / Import Status** | Shows how many documents or chunks were imported and whether the last import completed successfully. | +| **Docs Chat Knowledge Scope** | Selects which imported documentation collections the public docs widget may use. | + +After each import, check the knowledge count and test representative questions in the docs chat widget. Refresh imports after major documentation releases so customer-facing answers match the current docs. + +## Calendar SMS Reminder Setup + +Superdav AI Agent v1.19.0 adds setup controls for calendar-driven SMS reminder orchestration. These controls combine calendar access, attendee/contact mapping, SMS provider settings, approval gates, and reminder deduplication. + +| Field | Description | +|---|---| +| **Calendar Reminder Workflow** | Enables calendar-driven reminder orchestration for selected calendars or event types. | +| **Reminder Calendar Selection** | Chooses which configured calendars may trigger reminder workflows. | +| **Attendee / Contact Mapping** | Controls how event attendees are matched to WordPress users, customer records, or known contacts before SMS reminders are prepared. | +| **Require Approval Before SMS** | Pauses reminder sends until an authorised administrator approves the proposed message. Recommended for customer-facing reminders. | +| **Reminder Deduplication** | Records sent reminders so retries or scheduled runs do not notify the same contact repeatedly. | + +Before enabling recurring reminders, send a test reminder to an administrator-owned number, confirm attendee mapping, approve the proposed message, and verify that reminder records prevent duplicate sends. + ## Feature Flags Also introduced in v1.9.0, the **Settings → Feature Flags** tab provides toggle switches for optional functionality. Each flag is either enabled or disabled network-wide; there is no per-site override at this time. @@ -146,6 +192,9 @@ Superdav AI Agent v1.18.0 introduces human approval gates and reminder records f | **Reminder Deduplication** | On | Records sent reminders so retries or scheduled runs do not send duplicate notifications. | | **Enable Calendar Tools** | Off until configured | Allows the agent to read configured Google calendars and events. | | **Enable SMS Notifications** | Off until configured | Allows approved workflows to send TextBee SMS notifications after credentials are saved. | +| **Enable Public Chat** | Off | Allows anonymous public chat when public-chat settings and safety controls are configured. | +| **Enable Customer Simple Chat** | Off | Shows the simplified customer-facing chat mode instead of the internal administrator assistant. | +| **Enable Docs Chat Widget** | Off | Allows the embeddable documentation chat widget to answer from selected imported documentation sources. | ### Applying Changes diff --git a/docs/user-guide/configuration/built-in-agents.md b/docs/user-guide/configuration/built-in-agents.md index 4b809424e5..22f7eeb3af 100644 --- a/docs/user-guide/configuration/built-in-agents.md +++ b/docs/user-guide/configuration/built-in-agents.md @@ -5,7 +5,7 @@ sidebar_position: 12 # Built-in Agents -Gratis AI Agent v1.9.0 ships five built-in agents, each pre-configured with a focused set of tools, a tailored system prompt, and starter suggestions matched to common tasks in that area. Switching between agents changes what the assistant can do and how it responds — without any configuration on your part. Superdav AI Agent v1.18.0 can add schedule-aware tools, reminder records, approval gates, and SMS notifications to these workflows when the related integrations are configured. +Gratis AI Agent v1.9.0 ships five built-in agents, each pre-configured with a focused set of tools, a tailored system prompt, and starter suggestions matched to common tasks in that area. Switching between agents changes what the assistant can do and how it responds — without any configuration on your part. Superdav AI Agent v1.19.0 can add customer-facing assistant modes, documentation-chat knowledge, schedule-aware tools, reminder records, approval gates, and SMS notifications to these workflows when the related integrations are configured. ## What Is an Agent? @@ -30,7 +30,7 @@ You can also switch agents mid-conversation — the new agent's system prompt ta **Focus:** Creating and editing posts, pages, and contact forms. -**Available tools:** `create_post`, `update_post`, `batch_create_posts`, `set_featured_image`, `create_contact_form`, `get_option`, `list_post_types`. With Superdav AI Agent v1.18.0 integrations enabled, configured calendar context, approval gates, reminders, and SMS notification tools may also be available to approved workflows. +**Available tools:** `create_post`, `update_post`, `batch_create_posts`, `set_featured_image`, `create_contact_form`, `get_option`, `list_post_types`. With Superdav AI Agent v1.19.0 integrations enabled, configured calendar context, approval gates, reminders, SMS notification tools, customer-chat setup, and documentation knowledge tools may also be available to approved workflows. **What it does well:** - Drafting and publishing blog posts from a brief or outline @@ -38,12 +38,14 @@ You can also switch agents mid-conversation — the new agent's system prompt ta - Building contact and enquiry forms - Setting featured images on posts from a URL or search - Drafting event follow-up messages from configured Google Calendar context, then pausing for approval before sending notifications +- Drafting customer-facing help copy that aligns with imported documentation knowledge **Starter suggestions:** - *Write a 500-word blog post about the benefits of WordPress multisite.* - *Create an About, Services, and Contact page and publish them.* - *Add a booking enquiry form to the Contact page.* - *Draft a reminder for attendees on tomorrow's configured calendar event and wait for approval before sending it.* +- *Write a short customer-facing answer based on our imported documentation.* --- @@ -51,7 +53,7 @@ You can also switch agents mid-conversation — the new agent's system prompt ta **Focus:** End-to-end website creation from a single prompt. -**Available tools:** `create_site_plan`, `execute_site_plan`, `get_plan_progress`, `handle_plan_error`, `create_post`, `batch_create_posts`, `register_post_type`, `create_menu`, `add_menu_item`, `inject_custom_css`, `apply_theme_json_preset`, `install_ability`, `recommend_plugin`, `create_contact_form`. With Superdav AI Agent v1.18.0, configured managed-service, approval, reminder, calendar, and SMS tools may be available where administrators enable them. +**Available tools:** `create_site_plan`, `execute_site_plan`, `get_plan_progress`, `handle_plan_error`, `create_post`, `batch_create_posts`, `register_post_type`, `create_menu`, `add_menu_item`, `inject_custom_css`, `apply_theme_json_preset`, `install_ability`, `recommend_plugin`, `create_contact_form`. With Superdav AI Agent v1.19.0, configured managed-service, approval, reminder, calendar, SMS, public-chat, docs-widget, and customer-chat setup tools may be available where administrators enable them. **What it does well:** - Generating a multi-phase site build plan for a described business type @@ -60,6 +62,7 @@ You can also switch agents mid-conversation — the new agent's system prompt ta - Installing recommended plugins as part of the build - Creating contact forms directly from the chat interface (Superdav AI Agent v1.10.0+) - Coordinating launch reminders or attendee follow-up without duplicate notifications when approval gates and reminder records are enabled +- Preparing customer chat and docs widget pages after administrators configure public chat and documentation imports **Starter suggestions:** - *Build a photography portfolio site with a gallery post type, a booking page, and a contact form.* @@ -67,6 +70,7 @@ You can also switch agents mid-conversation — the new agent's system prompt ta - *Set up a freelance consulting site with service pages, a portfolio section, and a blog.* - *Add a contact form to the Contact page using the site builder.* - *After the site launch checklist is approved, send an SMS reminder to the configured stakeholder contact.* +- *Create a help page with an embedded docs chat widget for customer questions.* --- @@ -109,32 +113,40 @@ You can also switch agents mid-conversation — the new agent's system prompt ta **Focus:** Answering questions about site content, settings, and WordPress configuration. -**Available tools:** `get_option`, `list_options`, `list_post_types`, `list_taxonomies`, `list_menus`, `list_available_abilities` +**Available tools:** `get_option`, `list_options`, `list_post_types`, `list_taxonomies`, `list_menus`, `list_available_abilities`. With Superdav AI Agent v1.19.0 public/customer chat enabled, support workflows may also use imported documentation knowledge and customer simple chat settings selected by an administrator. **What it does well:** - Looking up current site settings and options - Explaining what post types, taxonomies, and menus are configured on the site - Answering "what does this setting do?" questions by reading live values - Serving as a read-only diagnostic layer before making changes +- Answering customer documentation questions from approved imported knowledge sources when used through a docs chat widget **Starter suggestions:** - *What plugins and settings are currently active on this site?* - *List all the custom post types registered on this site.* - *What navigation menus exist and where are they assigned?* +- *Answer this customer question using the imported docs knowledge base.* --- ## Superdav Automation Integrations -When Superdav AI Agent v1.18.0 integrations are configured, built-in agents can participate in safer schedule-aware automation workflows: +When Superdav AI Agent v1.19.0 integrations are configured, built-in agents can participate in customer-facing and safer schedule-aware automation workflows: +- **Static documentation imports** allow customer-facing answers to use approved documentation knowledge instead of relying only on the current chat context. +- **Anonymous public chat** lets visitors ask limited questions without a WordPress login when administrators enable public access. +- **Embeddable docs chat widgets** place a documentation-aware assistant on help-centre, product, or documentation pages. +- **Customer simple chat mode** gives customers a focused assistant interface with safer defaults than the internal administrator panel. +- **Customer chat setup** guides administrators through widget, public access, knowledge-source, and safety configuration before publishing. - **Google Calendar read tools** allow agents to inspect configured calendars and events before drafting follow-up work. - **Contact and attendee mapping** helps match event participants to WordPress users or known contacts. - **Human approval gates** pause sensitive actions until an authorised user reviews and confirms them. - **Reminder records** prevent duplicate notifications when scheduled jobs retry or repeat. - **TextBee SMS notifications** send configured text messages only when SMS credentials and workflow permissions are enabled. +- **Calendar SMS reminder setup** connects calendar selection, attendee/contact mapping, approval, deduplication, and SMS provider settings for reminder orchestration. -Recommended workflow: ask the agent to prepare the message or action, review the approval prompt, then allow the approved action to resume. For recurring reminders, keep reminder deduplication enabled so the same event or contact is not notified repeatedly. +Recommended workflow for documentation chat: import trusted docs, review the knowledge counts, test the customer simple chat experience, then embed the docs widget on a limited page before publishing it widely. Recommended workflow for reminders: ask the agent to prepare the message or action, review the approval prompt, then allow the approved action to resume. For recurring reminders, keep reminder deduplication enabled so the same event or contact is not notified repeatedly. ---