Changeset 3384813
- Timestamp:
- 10/26/2025 07:05:15 PM (5 months ago)
- File:
-
- 1 edited
-
ask-my-content/trunk/readme.txt (modified) (6 diffs)
Legend:
- Unmodified
- Added
- Removed
-
ask-my-content/trunk/readme.txt
r3384564 r3384813 13 13 == Description == 14 14 15 Ask My Content brings AI-powered question answering to your WordPress site. 16 Instead of giving generic chatbot responses, this plugin indexes your site's 17 content (pages and posts) and uses it to provide accurate, context-aware 18 answers to visitors. 15 Ask My Content brings AI-powered question answering to your WordPress site. Instead of giving generic chatbot responses, this plugin indexes your site's content (pages and posts) and uses it to provide accurate, context-aware answers to visitors. 19 16 20 Unlike standard content search plugins that rely on keyword matching, Ask My 21 Content uses semantic embeddings and retrieval-augmented generation to return 22 direct answers in full sentences. 17 Unlike standard content search plugins that rely on keyword matching, Ask My Content uses semantic embeddings and retrieval-augmented generation to return direct answers in full sentences. 23 18 24 19 **Key Features** 25 * Simple setup – install, activate, and add the chatbot with a shortcode or 26 block. 27 * Retrieval Augmented Generation (RAG) – answers are grounded in your actual 28 site content. 20 * Simple setup – install, activate, and add the chatbot with a shortcode or block. 21 * Retrieval Augmented Generation (RAG) – answers are grounded in your actual site content. 29 22 * Uses OpenAI for embeddings and completions (via a secure Node.js backend). 30 * Change tracking – automatically queues edited pages/posts so you can rerun 31 indexing from the dashboard or `wp amc` when you're ready. 32 * Deleted content removal – immediately notifies the backend when pages or 33 posts are trashed or permanently deleted. 23 * Change tracking – automatically queues edited pages/posts so you can rerun indexing from the dashboard or `wp amc` when you're ready. 24 * Deleted content removal – immediately notifies the backend when pages or posts are trashed or permanently deleted. 34 25 * Lightweight – no heavy admin UI or visual layout tools, just the essentials. 35 * Flexible – works with posts, pages, and optionally header/footer "virtual 36 posts." 37 * Freemium model – the current free version includes generous token usage 38 limits; a future premium version will remove these limits and provide an 39 Ask My Content API key. 26 * Flexible – works with posts, pages, and optionally header/footer "virtual posts." 27 * Freemium model – the current free version includes generous token usage limits; a future premium version will remove these limits and provide an Ask My Content API key. 40 28 41 29 **How it works** 42 1. After activating the plugin, go to **Dashboard → Ask My Content** and press 43 “Start Indexing” (or run `wp amc index`) to send your site content to the 44 backend. 45 2. Content is converted into embeddings (vector representations). 46 3. When a visitor asks a question, the chatbot retrieves the most relevant 47 content snippets. 48 4. OpenAI generates an answer based on that content. 30 1. After activating the plugin, go to **Dashboard → Ask My Content** and press “Start Indexing” (or run `wp amc index`) to send your site content to the backend. 31 2. Add the **Ask My Content** block to an existing or new page (or place the `[ask_my_content]` shortcode) and publish/update the page so the chat interface has a front-end location. 32 3. Content is converted into embeddings (vector representations). 33 4. When a visitor asks a question, the chatbot retrieves the most relevant content snippets from your indexed pages. 34 5. OpenAI generates an answer based on that content. 49 35 50 After you edit content, rerun indexing from **Dashboard → Ask My Content** or 51 via `wp amc index` to push the latest changes. Deleted posts are sent to the 52 backend automatically when they are trashed or removed. 36 After you edit content, rerun indexing from **Dashboard → Ask My Content** or via `wp amc index` to push the latest changes. Deleted posts are sent to the backend automatically when they are trashed or removed. 53 37 54 > 🔒 Note: Your site's content and user questions are securely sent to an 55 > external AI service (OpenAI) for processing. 38 > 🔒 Note: Your site's content and user questions are securely sent to an external AI service (OpenAI) for processing. 56 39 57 40 == Installation == 58 41 59 1. Upload the plugin files to `/wp-content/plugins/ask-my-content`, or install 60 via the WordPress Plugins screen. 42 1. Upload the plugin files to `/wp-content/plugins/ask-my-content`, or install via the WordPress Plugins screen. 61 43 2. Activate the plugin through the 'Plugins' screen in WordPress. 62 3. Optionally configure settings in **Dashboard → Ask My Content** (backend 63 API key, model options). 64 4. Run the initial indexing from **Dashboard → Ask My Content** by pressing 65 “Start Indexing”, or run `wp amc index` from the command line. 44 3. Optionally configure settings in **Dashboard → Ask My Content** (backend API key, model options). 45 4. Run the initial indexing from **Dashboard → Ask My Content** by pressing “Start Indexing”, or run `wp amc index` from the command line. 66 46 5. Add the chatbot to a page using either: 67 68 * The Gutenberg block: "Ask My Content Chatbot"47 * The shortcode: `[ask_my_content]` 48 * The Gutenberg block: "Ask My Content" 69 49 70 50 == Frequently Asked Questions == 71 51 72 52 = Does this plugin use my OpenAI API key? = 73 By default, the plugin uses the developer's OpenAI API key on a secure backend 74 (with generous usage limits). This means you don't need your own OpenAI API 75 key. A future premium version will remove these limits and offer a dedicated 76 Ask My Content API key for unlimited usage. 53 By default, the plugin uses the developer's OpenAI API key on a secure backend (with generous usage limits). This means you don't need your own OpenAI API key. A future premium version will remove these limits and offer a dedicated Ask My Content API key for unlimited usage. 77 54 78 55 = Will this slow down my site? = 79 No. Heavy AI processing (embeddings, search, completions) happens on a 80 separate Node.js backend service. 56 No. Heavy AI processing (embeddings, search, completions) happens on a separate Node.js backend service. 81 57 82 58 = Can I choose what content is indexed? = 83 Currently, posts and pages are indexed automatically. Future versions will 84 allow selecting post types, categories, or custom content. 59 Currently, posts and pages are indexed automatically. Future versions will allow selecting post types, categories, or custom content. 85 60 86 61 = Is my data safe? = … … 88 63 89 64 = Does this plugin support WordPress Multisite? = 90 Not yet. Ask My Content is not currently compatible with WordPress multisite 91 installations, so it must be activated on individual sites (no network-wide 92 support yet). 65 Not yet. Ask My Content is not currently compatible with WordPress multisite installations, so it must be activated on individual sites (no network-wide support yet). 93 66 94 67 = Can I customize the shortcode output? = 95 Yes. The `[ask_my_content]` shortcode accepts optional attributes such as 96 `title`, `sessionId`, `width`, `height`, and the various color tokens 97 (`headerBackground`, `headerTextColor`, `chatBackground`, `chatUserBubble`, 98 `chatBotBubble`, `inputBackground`, `inputTextColor`). They map to the same 99 style variables used by the block. See the inline comment above 100 `askmyco_render_chat_shortcode()` in `ask-my-content.php` for the current list and 101 defaults. 68 Yes. The `[ask_my_content]` shortcode accepts optional attributes such as `title`, `sessionId`, `width`, `height`, and the various color tokens (`headerBackground`, `headerTextColor`, `chatBackground`, `chatUserBubble`, `chatBotBubble`, `inputBackground`, `inputTextColor`). They map to the same style variables used by the block. See the inline comment above `amc_render_chat_shortcode()` in `ask-my-content.php` for the current list and defaults. 102 69 103 70 == Command Line Usage == 104 71 105 The plugin bundles a WP-CLI command suite (`wp amc`) for scripted indexing and 106 status checks. It complements the **Ask My Content Settings** admin screen: 72 The plugin bundles a WP-CLI command suite (`wp amc`) for scripted indexing and status checks. It complements the **Ask My Content Settings** admin screen: 107 73 108 * Use the settings page for a guided UI, manual start/stop buttons, and 109 real-time counters inside the WordPress dashboard. 110 * Use `wp amc` when you need automation (cron jobs, SSH sessions, CI) or want 111 to run indexing without opening a browser. Available commands include: 74 * Use the settings page for a guided UI, manual start/stop buttons, and real-time counters inside the WordPress dashboard. 75 * Use `wp amc` when you need automation (cron jobs, SSH sessions, CI) or want to run indexing without opening a browser. Available commands include: 112 76 * `wp amc index [--include-posts] [--force]` 113 77 * `wp amc status` … … 116 80 = Installing WP-CLI = 117 81 118 Many hosts ship with WP-CLI pre-installed. If yours does not, install it 119 manually: 82 Many hosts ship with WP-CLI pre-installed. If yours does not, install it manually: 120 83 121 84 1. Download the Phar: … … 128 91 `wp --info` 129 92 130 See https://wp-cli.org/#installing for additional options (Homebrew, Docker, 131 Windows packages). 93 See https://wp-cli.org/#installing for additional options (Homebrew, Docker, Windows packages). 132 94 133 95 = Running the command successfully = 134 96 135 Run `wp amc …` from the WordPress installation root (where `wp-config.php` 136 lives) or supply the path explicitly: 97 Run `wp amc …` from the WordPress installation root (where `wp-config.php` lives) or supply the path explicitly: 137 98 138 99 * Change directory, e.g. `cd /srv/www/wordpress` then run `wp amc status` … … 141 102 If you run the command from another folder you will see: 142 103 143 > Warning: No WordPress installation found. If the command 'amc' is in a 144 > plugin or theme, pass --path=`path/to/wordpress`. 104 > Warning: No WordPress installation found. If the command 'amc' is in a plugin or theme, pass --path=`path/to/wordpress`. 145 105 146 106 Point `wp` at your site root and re-run to resolve the error. … … 157 117 158 118 = 0.4.2 = 159 * Initial release – shortcode, block, automatic content sync, AI-powered 160 answers. 119 * Initial release – shortcode, block, automatic content sync, AI-powered answers. 161 120 162 121 == Upgrade Notice == 163 122 164 123 = 0.4.2 = 165 First release. Add the chatbot block or shortcode to any page to enable 166 AI-powered Q&A. 124 First release. Add the chatbot block or shortcode to any page to enable AI-powered Q&A.
Note: See TracChangeset
for help on using the changeset viewer.