# ppl/module-search-intelligence

> Standalone search intelligence for Magento 2 with canonical search results, query understanding, MySQL candidate collection, explainable ranking and optional Discovery Filters integration.

`composer require ppl/module-search-intelligence`

Canonical URL: https://packagento.com/ppl/module-search-intelligence

## At a glance

- **Vendor**: Pawel Pliousnin Digital Solutions (https://packagento.com/ppl.md)
- **Latest version**: 1.2.0 — released 2026-07-08
- **Pricing**: $249.00/year, subscription
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

This is a paid package. The Packagento install flow is licence-gated, so a Composer install needs a licence + project + project credentials in place first.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Purchase the package.** Open https://packagento.com/ppl/module-search-intelligence, add it to your cart, and complete checkout. A licence is minted automatically once payment clears.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require ppl/module-search-intelligence:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Standalone search intelligence for Magento 2 with canonical search results, query understanding, MySQL candidate collection, explainable ranking and optional Discovery Filters integration.

## README

PPL Search Intelligence owns intelligent Magento search results with query understanding, indexed product signals, MySQL candidate collection, explainable ranking, redirects, zero-result recovery, and optional Discovery Filters integration.

### What It Adds
- Canonical search page and overlay product basis
- Indexing, backend routing, Redis/OpenSearch/MySQL options, query rules, behavior/ranking tuning, and profiler diagnostics
- Synonyms, corrections, zero-result recovery, redirect rules, and Test Lab screens

### Requirements And Dependencies
- PHP: >=8.1
- Magento packages: magento/framework, magento/module-advanced-search, magento/module-backend, magento/module-catalog, magento/module-catalog-inventory, magento/module-catalog-search, magento/module-config, magento/module-configurable-product, magento/module-cron, magento/module-customer, magento/module-eav, magento/module-inventory-sales, magento/module-inventory-sales-api, magento/module-message-queue, magento/module-review, magento/module-sales, magento/module-search, magento/module-store
- PPL packages: ppl/module-hub
- Conflict: do not enable together with `Ppl_ScoredSearch` because the modules try to control the same search surface.

### Installation
Install the required PPL packages in dependency order. Composer will skip packages that are already installed:

```bash
composer require ppl/module-hub ppl/module-search-intelligence
bin/magento module:enable Ppl_Hub Ppl_SearchIntelligence
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean
```

Manual app/code installation: copy the dependency modules and this module into `app/code/Ppl` in this order: `Ppl/Hub -> Ppl/SearchIntelligence`. Then run the same Magento commands starting with `bin/magento module:enable`.

### First Use
- Disable Ppl_ScoredSearch before enabling SearchIntelligence because both modules own search surfaces.
- Build the SearchIntelligence index before enabling the master switch, storefront suggestions, or search page ownership.
- Run SearchIntelligence index/rebuild commands or admin operations after installation.
- Pair with DiscoveryFilters only when you want filtered facets inside the SearchIntelligence product basis.

Admin entry: `PPL Hub > PPL Search Intelligence`.

### Integrations And Boundaries
- Optionally cooperates with Ppl_DiscoveryFilters through the neutral ppl_searchintelligence_filter_integration event.
- Uses Ppl_Hub for navigation and for the neutral capability contract that shares search-page ownership and the materialized result set with Discovery Filters — SI reads the Discovery Filters index and publishes its result set through Hub capabilities, not sibling-module internals — plus Magento search/catalog modules for runtime data. Async indexing uses Magento_MessageQueue and requires a configured queue broker such as RabbitMQ when async mode is enabled.
- Stable: run the documented PPL release gates (setup:upgrade, di:compile, PHPUnit, SCD, production mode) in your environment before publishing this package.

### Localization
The package includes translation CSV files for 12 locales: de_DE, en_US, es_ES, fr_FR, it_IT, ja_JP, nl_NL, pl_PL, pt_BR, ru_RU, tr_TR, zh_CN.

### Customer Documentation
Customer-facing User Guides and Marketplace Long Descriptions are maintained outside the Magento module package in the repository-level `docs/user_guides` and `docs/long_descriptions` folders. The module package itself intentionally keeps only this technical README plus developer-relevant files.

### Support
Support contact: pliousnin@ppl-ds.com. Include the module version, Magento version, enabled PPL companion modules, and the relevant admin or storefront screenshot when reporting an issue.

## Changelog

### 1.2.0

- Initial release.
- Added query understanding, MySQL candidate provider, explainable ranking and product signal rebuilds.
- Added admin Test Lab, hub-only configuration sections, CLI commands, cron jobs and core schema tables.
- Added optional configurable storefront suggestions, Discovery Filters integration and read-only internal provider status.
- Search result pages use Search Intelligence as the canonical product basis for product list rendering, Discovery Filters, toolbar totals, pagination and sorting.
- Added overlay fast-path payload mapping, action payload slimming, optional payload pruning and profiler payload parity.
- Added behavior-aware ranking gates that consume aggregated behavior signals; storefront behavior collection, impression tracking and purchase/return attribution are owned by the optional Ppl_Tracking module.
- Added Smart Discovery P0 payload support as an additive, read-only overlay field.
- Added Test Lab timing help and request-path details while keeping winner/loser row backgrounds neutral and limiting colored highlights to metric cells.
- Routed Search Intelligence <-> Discovery Filters cooperation through neutral Ppl_Hub capabilities: SI exposes the canonical search product set via the Hub SearchPageProductSetProviderInterface bridge and reads facet/filter data via the Hub FilterIndexReaderInterface, instead of reading a sibling module's tables.
- Declared an explicit magento/module-cron dependency and Magento_Cron load-order sequence so the bundled cron jobs (index bootstrap/rebuild, signal rebuild, knowledge-pack compile, result-set purge, async dispatch/advance) load deterministically.
- Normalized every ranking component to a common [0,1] scale before weighting, retuned the shipped default weights, and added a data patch that calibrates stored per-scope weight overrides onto the new scale so existing merchant tuning is preserved.
- Added optional async index rebuilds that fan a catalog rebuild out to the Magento message queue (one message per product batch, version-swapped only when complete) with a transactional outbox, per-minute dispatch/advance cron jobs and a broker-availability probe; falls back to the synchronous rebuild when no broker is configured.
- Extended product signal scoring with freshness (recency), return-rate, click-through and search-conversion terms and lifted the signal scale cap so strong products no longer saturate.
- Added search smoke/profile/recall diagnostic and corpus/benchmark/seed CLI commands that exercise the live SI + Discovery Filters result path through the Hub filter-index reader.

## Recent Versions

| Version | Released |
|---|---|
| 1.2.0 | 2026-07-08 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| ext-ctype | * |
| ext-curl | * |
| ext-hash | * |
| ext-mbstring | * |
| magento/framework | >=103.0.7 <104.0.0 |
| magento/module-advanced-search | >=100.4.0 <101.0.0 |
| magento/module-backend | >=102.0.0 <103.0.0 |
| magento/module-catalog | >=104.0.0 <105.0.0 |
| magento/module-catalog-inventory | >=100.4.0 <101.0.0 |
| magento/module-catalog-search | >=102.0.0 <103.0.0 |
| magento/module-checkout | >=100.4.0 <101.0.0 |
| magento/module-config | >=101.2.0 <102.0.0 |
| magento/module-configurable-product | >=100.4.0 <101.0.0 |
| magento/module-cron | >=100.4.0 <101.0.0 |
| magento/module-customer | >=103.0.0 <104.0.0 |
| magento/module-eav | >=102.1.0 <103.0.0 |
| magento/module-inventory-sales | >=1.2.0 <2.0.0 |
| magento/module-inventory-sales-api | >=1.2.0 <2.0.0 |
| magento/module-message-queue | >=100.4.0 <101.0.0 |
| magento/module-review | >=100.4.0 <101.0.0 |
| magento/module-sales | >=103.0.0 <104.0.0 |
| magento/module-search | >=101.1.0 <102.0.0 |
| magento/module-store | >=101.1.0 <102.0.0 |
| magento/module-ui | >=101.2.0 <102.0.0 |
| magento/module-wishlist | >=101.2.0 <102.0.0 |
| php | >=8.1 |
| ppl/module-hub | ^1.2 |
| psr/log | ^1.0 \|\| ^2.0 \|\| ^3.0 |
| symfony/console | ^6.4 \|\| ^7.0 |
| symfony/process | ^6.4 \|\| ^7.0 |

### Conflict

| Package | Constraint |
|---|---|
| ppl/scored_search | ^1.2 |

## Quality

Latest release (1.2.0) passes the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 147 | 147 warnings (ruleset: Magento2), 2 auto-fixable with phpcbf |
| PHPMD | Warning | 24 | 24 rule violations (UnusedFormalParameter:20, UnusedPrivateMethod:4) |
| Cpd | Warning | 23 | 23 duplicated chunks spanning 776 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | N/A | 0 | no resolvable dependency tree to audit: Your requirements could not be resolved to an installable set of packages. Problem 1 |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Subscription — $249.00/year, auto-renews until cancelled. Includes all minor + patch upgrades within the licensed major. One licence per project; cancelling stops auto-renewal but the existing licence keeps working until its end date.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["ppl/module-search-intelligence"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

Pawel Pliousnin Digital Solutions is a Magento 2 vendor on Packagento. See https://packagento.com/ppl.md for their full catalogue.