WP Quick Search User Documentation

This documentation is for site administrators using the WP Quick Search SaaS platform - from creating sites and getting Keys, to WordPress plugin integration and index sync.

1. Install the plugin on your WordPress site (wp-quick-search)

Download the plugin zip package, upload and install it on your WordPress site, and enable the wp-quick-search plugin.

2. Register / Login

If you do not have an account, please register first; if you already have an account, you can log in directly and enter the console.

3. Go to console, add site, get API Key

After logging in, go to User Center / Console, add the WordPress site you want to integrate in My Sites. After creation, a set of independent API Key credentials and security credentials will be generated.

Open Console

4. Connection & Verification

Paste the site API Key from step 3 into the plugin settings, save the settings, and click the Test Connection button to verify correctness. After verification, your site can start building the index.

5. Indexing & Sync (Initial Full + Subsequent Incremental)

For first-time integration, it is recommended to do a full index first; subsequent content updates will be synced incrementally (depending on the modules you enabled and site scale).

• Configure and save in plugin "Search Settings" (default values recommended for first-time use unless you understand their purpose).
• Click the "Start Full Sync" button in the operation card and wait for completion (if accidentally closed, you can continue from where it stopped next time).
• Important: After sync completes, please enable the "Activate Advanced Search" switch in the left card to activate the feature.
• After indexing sync is complete, return to the plugin console to view indexing status and error messages.

Search & Retrieval

After "Full Sync" indexing completes, the plugin will silently take over WP native search without requiring any theme modifications or other integration - everything is automatic.

Statistics & Analytics

Provides search behavior and usage statistics (such as query counts, popular keywords, site usage trends, etc.) for optimizing content structure and conversion.

AI (Optional Module)

When AI-related modules are enabled, the plugin will send chat requests to the platform for processing without requiring any parameter configuration.

Quota & Billing

Different plans correspond to different quotas for document count/query frequency. You can view usage in the console at any time, and it is recommended to upgrade your plan when approaching limits.

View Plans

Ticket Support

If you encounter integration, indexing or billing issues, you can submit a ticket in the console. To help locate the problem faster, it is recommended to include your site domain, site ID, and error screenshots/log snippets (do not expose API Key).

FAQ

• Verification failed: Confirm the site API Key is correctly pasted and the site is enabled in the console.
• Index count is 0: Confirm the site has published content and that indexing sync has completed.
• No search results: First confirm indexing is complete, then check if the "Activate Advanced Search" switch is enabled in the plugin's "Search" settings page.

Data Deletion & Reset

When you need to clear the index or migrate a site, you can execute "Reset Index" from the plugin side, or delete the site from the console to clean server data (the impact scope varies by operation - follow console prompts).

Multi-region / Region (Platform Admin)

The platform supports multiple regions. Administrators need to select the correct region when creating sites on the platform to get nearby data node services.

• If your site targets mainland China users, select "Mainland China" region when creating the site for lower latency and better service stability.
• If your site targets overseas users, please select the appropriate regional node based on language and user location for optimal access speed and service quality.
• Once a site is created, the region cannot be changed - please choose carefully.