PHPackages                             padosoft/product-image-discovery - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Image & Media](/categories/media)
4. /
5. padosoft/product-image-discovery

ActiveLibrary[Image & Media](/categories/media)

padosoft/product-image-discovery
================================

Laravel package for conservative product image discovery, verification, scoring, download, and manual review workflows.

v1.0.0(2w ago)135↓100%1Apache-2.0PHPPHP ^8.3CI passing

Since Apr 29Pushed 2w agoCompare

[ Source](https://github.com/padosoft/product_image_discovery)[ Packagist](https://packagist.org/packages/padosoft/product-image-discovery)[ RSS](/packages/padosoft-product-image-discovery/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (6)Dependencies (19)Versions (17)Used By (1)

Product Image Discovery
=======================

[](#product-image-discovery)

[![Latest Version on Packagist](https://camo.githubusercontent.com/c44801d0e63def39bd08ec5126ce1da27ba841415dbf034194d7836e3fb8c2e7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7061646f736f66742f70726f647563742d696d6167652d646973636f766572792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/padosoft/product-image-discovery)[![PHP](https://camo.githubusercontent.com/f46c300b5c77864d0cce1f4f9568a9c0cd14371eaf8ba6a974e08b487b7ffdeb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e332532422d3737376262342e7376673f7374796c653d666c61742d737175617265)](https://www.php.net/)[![Laravel](https://camo.githubusercontent.com/17d33f3731e4506ad548689d60521b32c3c7231d1c07cf78ed81ed59078a4775/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d31332e782d6666326432302e7376673f7374796c653d666c61742d737175617265)](https://laravel.com/)[![License](https://camo.githubusercontent.com/f1dad44cad980acf16bfe77a9ac3167dd791de088f3151822b82c0ed54a53424/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f7061646f736f66742f70726f647563742d696d6167652d646973636f766572792e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Tests](https://camo.githubusercontent.com/20627a5106382fbff237ff2a28f57e70ccdafc71f0c71cc9ef146e839473b14a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74657374732d504850556e69742532302532422532304e6f64652d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](#testing)

[![Product Image Discovery banner](resources/banner.png)](resources/banner.png)

Table of Contents
-----------------

[](#table-of-contents)

- [Responsible Use Disclaimer](#responsible-use-disclaimer)
- [Why This Package](#why-this-package)
- [Quick Start (5 minutes, junior-friendly)](#quick-start-5-minutes-junior-friendly)
- [Supported Search Providers](#supported-search-providers)
- [What It Does](#what-it-does)
- [Architecture](#architecture)
- [Web Admin UI](#web-admin-ui)
- [Request Flow](#request-flow)
- [Installation](#installation)
- [Live Smoke Test From A Fresh Laravel App](#live-smoke-test-from-a-fresh-laravel-app)
- [Debug Flow Command](#debug-flow-command)
- [Quickstart](#quickstart)
- [EAN / Barcode Matching](#ean--barcode-matching)
- [Real Product Payload Examples](#real-product-payload-examples)
- [Configuration](#configuration)
- [Trusted Sources](#trusted-sources)
- [Optional Playwright Sidecar](#optional-playwright-sidecar)
- [AI And Vision](#ai-and-vision)
- [Testing](#testing)
- [Database Tables](#database-tables)
- [Safety Notes](#safety-notes)
- [Admin UI Guidance](#admin-ui-guidance)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License & credits](#license--credits)

Find the right product image, not just any image.

`padosoft/product-image-discovery` is a Laravel package for discovering, verifying, scoring and preparing product images from supplier data, search providers and trusted sources. It is built for catalog teams, ERPs, PIMs and marketplaces where the expensive mistake is not "we found no image"; the expensive mistake is publishing the wrong image for a product-color variant.

The package gives you a conservative pipeline, an API for ingestion and review, database-backed configuration, queue-ready jobs, audit events and an optional Playwright sidecar for pages that need browser rendering.

Responsible Use Disclaimer
--------------------------

[](#responsible-use-disclaimer)

Use this package only for lawful, authorized product image discovery workflows. Do not use it to abuse third-party services, bypass access controls, overload websites, violate robots.txt or source terms, or collect images from sources where you do not have explicit permission or another valid legal basis. Configure trusted sources, rate limits and manual review policies conservatively, and use it only on websites, suppliers, brand sources or search providers that you are allowed to access for this purpose.

Why This Package
----------------

[](#why-this-package)

- Conservative by design: it optimizes for low false positives.
- Product-color aware: the main identity is `client_id + erp_model_color_id`.
- Explainable decisions: candidates carry source, score, quality and audit context.
- Laravel native: service provider, config, migrations, Eloquent models, form requests, resources, Sanctum-friendly middleware and queue jobs.
- Provider-ready: search providers are configured in the database and resolved through a manager.
- Browser optional: Playwright runs in a separate Node sidecar and is not required for basic usage.
- AI-assisted, not AI-dependent: optional LLM/vision verification can enrich decisions without making the core fragile.
- Testable offline: the default test suite uses SQLite, fake providers and deterministic sidecar tests.

Quick Start (5 minutes, junior-friendly)
----------------------------------------

[](#quick-start-5-minutes-junior-friendly)

Goal: from a fresh Laravel 13 app to a passing end-to-end discovery request, **without paid keys**, copy-pasting nine blocks in order. The pipeline runs synchronously and returns a stored candidate from a bundled fake provider, so you can see the full flow before plugging in any external API.

> Prerequisites: PHP 8.3+, Composer, a clean Laravel 13 app, ~5 minutes. No queue worker, no Redis, no Node, no API keys.

**1. Require the package**

```
composer require padosoft/product-image-discovery
```

**2. Publish config**

```
php artisan vendor:publish --tag=product-image-discovery-config
```

**3. Publish migrations**

```
php artisan vendor:publish --tag=product-image-discovery-migrations
```

**4. Create the SQLite database file**

```
touch database/database.sqlite
```

On Windows PowerShell:

```
New-Item -ItemType File database/database.sqlite -Force
```

**5. Migrate**

```
php artisan migrate
```

**6. Seed default settings + provider templates**

```
php artisan db:seed --class="Padosoft\ProductImageDiscovery\Database\Seeders\ProductImageDiscoveryDefaultsSeeder"
```

**7. Minimal `.env` overrides** (append four lines)

```
DB_CONNECTION=sqlite
DB_DATABASE=database/database.sqlite
QUEUE_CONNECTION=sync
PRODUCT_IMAGE_DISCOVERY_ROUTE_PREFIX=api/product-image-discovery
```

**8. Activate the bundled fake provider + issue a token via tinker**

```
php artisan tinker
```

Inside Tinker, paste this single block:

```
\Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::updateOrCreate(
    ['code' => 'fake-smoke'],
    [
        'name' => 'Fake Smoke Provider',
        'driver' => 'fake',
        'config' => [
            'supports_image_search' => true,
            'image_results' => [[
                'title' => 'Demo result',
                'page_url' => 'https://example.test/p/demo',
                'image_url' => 'data:image/jpeg;base64,'.base64_encode(str_repeat('a', 120000)),
                'source_domain' => 'example.test',
                'width' => 1200,
                'height' => 1200,
                'provider_metadata' => [
                    'inline_image_base64' => base64_encode(str_repeat('a', 120000)),
                    'inline_extension' => 'jpg',
                ],
            ]],
        ],
        'priority' => 1,
        'timeout_seconds' => 10,
        'is_active' => true,
    ],
);

use Laravel\Sanctum\HasApiTokens;
$user = \App\Models\User::factory()->create(['email' => 'pid-quickstart@example.test']);
echo $user->createToken('pid-quickstart', ['product-image-discovery:write','product-image-discovery:read'])->plainTextToken.PHP_EOL;
```

Copy the printed token. Exit tinker.

> If `App\Models\User` does not use `Laravel\Sanctum\HasApiTokens`, add the trait first — see step 4 in [Live Smoke Test From A Fresh Laravel App](#live-smoke-test-from-a-fresh-laravel-app).

**9. Hit the API** (replace `YOUR_TOKEN`)

```
php artisan serve
```

In another terminal:

```
curl -X POST "http://127.0.0.1:8000/api/product-image-discovery/requests" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 1,
    "erp_model_id": "DEMO-1",
    "erp_model_color_id": "DEMO-1-BLACK",
    "brand": "Demo",
    "model_code": "DEMO-1",
    "color_name": "Black"
  }'
```

You should receive `{"ok":true, "request_id":1, "status":"queued"}`.

✅ Done — you just ran the full ingest → search → extract → verify → download → quality pipeline locally with a deterministic fake provider. Next steps:

- **Enable a real provider** (Brave, Tavily, Exa.ai, Firecrawl, WebSearchAPI.ai, DuckDuckGo, SearchAPI.io, You.com): see [Supported Search Providers](#supported-search-providers) below.
- **Run the live debug flow** with a real product payload: see [Debug Flow Command](#debug-flow-command).
- **Full host-app walkthrough** with Sanctum scopes and Brave: see [Live Smoke Test From A Fresh Laravel App](#live-smoke-test-from-a-fresh-laravel-app).

Supported Search Providers
--------------------------

[](#supported-search-providers)

> **Since v1.0.0, the search layer is consumed via the standalone composer package [`padosoft/laravel-ai-search-providers`](https://github.com/padosoft/laravel-ai-search-providers).**This repo declares it as a hard dependency in `composer.json`; the package ships every driver listed below, the `SearchProviderInterface` contract, the `SearchProviderManager` orchestrator, the DTOs, the Eloquent model and the create-table migration. `product-image-discovery` only exposes a backwards-compatible `ProductImageSearchProvider` Eloquent subclass that hard-codes the legacy `product_image_search_providers` table, so existing host apps and the sister [`padosoft/product_image_discovery_admin`](https://github.com/padosoft/product_image_discovery_admin) package keep working unchanged. For full driver documentation, the `Http::fake` test pattern, custom-driver extension and the package Quick Start, jump to the package README at .

The package currently bundles **9 search providers** — 1 deterministic for tests + 8 live drivers covering global, EU-friendly, free-tier and scrape-friendly options. All providers are stored in the same `product_image_search_providers` table and resolved through a single `SearchProviderManager`, so swapping one for another is a row update.

ProviderDriverImage searchSite filterFree tierDocsFake (deterministic)`fake`✅✅—n/a — bundled for testsBrave Search`brave`✅✅2000 / monthTavily`tavily`✅✅ (`include_domains`)1000 credits / monthExa.ai`exa`✅ (`extras.imageLinks`)✅ (`includeDomains`)Free trial creditsFirecrawl`firecrawl`✅ (`sources:["images"]`)✅ (via `site:` operator)500 credits / monthWebSearchAPI.ai`websearchapi`❌ (web-only)✅ (`includeDomains`)Free trial creditsDuckDuckGo (HTML lite)`duckduckgo`❌✅ (via `site:` operator)No key requiredSearchAPI.io`searchapi`✅ (`engine=google_images`)✅ (via `site:` operator)Free trial creditsYou.com`youcom`❌ (web-only)✅ (`include_domains`)Free trial credits> Templates for `serpapi` and `google_custom_search` were originally seeded but Google's Custom Search JSON API was [closed to new customers in 2026](https://support.google.com/programmable-search/answer/12397162) and new Programmable Search Engines can no longer index the full web — see the [Roadmap](#roadmap) for the Vertex AI Search / Agent Search adapter slated as a separate sub-package.

> ⚠️ Provider configs are redacted in audit logs. Always store secrets in `.env` and let the seeders/tinker scripts populate `api_key_encrypted`, never expose API keys through user-facing endpoints.

### Brave Search

[](#brave-search)

```
BRAVE_SEARCH_API_KEY=your-key
```

Activate the seeded provider:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'brave')->firstOrFail();
$p->api_key_encrypted = env('BRAVE_SEARCH_API_KEY');
$p->is_active = true;
$p->save();
```

### Tavily

[](#tavily)

JSON search API with first-class image support (`images[]`) and `include_domains` site filtering.

```
TAVILY_API_KEY=your-key
TAVILY_URL=https://api.tavily.com
```

Activate:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'tavily')->firstOrFail();
$p->api_key_encrypted = env('TAVILY_API_KEY');
$p->is_active = true;
$p->save();
```

### Exa.ai

[](#exaai)

`POST /search` with `contents.extras.imageLinks` per result, flattened into one candidate per image URL. Site filter via `includeDomains`. Auth via `x-api-key` header.

```
EXA_API_KEY=your-key
EXA_URL=https://api.exa.ai
```

Activate:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'exa')->firstOrFail();
$p->api_key_encrypted = env('EXA_API_KEY');
$p->is_active = true;
$p->save();
```

The `image_links_per_result` config key (default `5`) caps how many `imageLinks` Exa returns per result and how many candidates the provider emits per Exa result.

### Firecrawl

[](#firecrawl)

`POST /v2/search` with `sources:[{type:"images"}]` (or `[{type:"web"}]` for `searchWeb()`). Bearer auth. Site filter propagated as `includeDomains` array. Returns `data.images[]` with `imageUrl`, `imageWidth`, `imageHeight`, and the source page `url`.

```
FIRECRAWL_API_KEY=your-key
FIRECRAWL_URL=https://api.firecrawl.dev
```

Activate:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'firecrawl')->firstOrFail();
$p->api_key_encrypted = env('FIRECRAWL_API_KEY');
$p->is_active = true;
$p->save();
```

### WebSearchAPI.ai

[](#websearchapiai)

`POST /ai-search` with Bearer auth. Google-backed organic web results with optional AI content extraction. Site filter via `includeDomains`. **Web-only**: WebSearchAPI does not expose a dedicated image search endpoint, so `supportsImageSearch()` returns `false` and `SearchProviderManager` skips this driver for image queries (the extraction pipeline can still harvest images from the returned pages).

```
WEBSEARCHAPI_API_KEY=your-key
WEBSEARCHAPI_URL=https://api.websearchapi.ai
```

Activate:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'websearchapi')->firstOrFail();
$p->api_key_encrypted = env('WEBSEARCHAPI_API_KEY');
$p->is_active = true;
$p->save();
```

### DuckDuckGo (HTML lite)

[](#duckduckgo-html-lite)

Free, no-API-key fallback for web search. Posts to `https://html.duckduckgo.com/html/` and parses the response with `\DOMDocument` + `\DOMXPath`. Result `.result__a` links use the `//duckduckgo.com/l/?uddg=` redirect form — the provider decodes them transparently and returns the real destination URL. **No image search**: `supportsImageSearch()` returns `false`, so `SearchProviderManager` skips it for image queries automatically.

```
# Optional override (defaults to https://html.duckduckgo.com):
DUCKDUCKGO_URL=https://html.duckduckgo.com
```

Activate:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'duckduckgo')->firstOrFail();
$p->base_url = 'https://html.duckduckgo.com';
$p->is_active = true;
$p->save();
```

> Use it sparingly and respect DuckDuckGo's terms — it is best as a low-volume fallback, not a primary driver. DuckDuckGo applies anti-bot rate limits to shared/datacenter IPs; the live E2E test self-skips in CI and on 403/429/503 responses.

### SearchAPI.io

[](#searchapiio)

Single `GET /api/v1/search` endpoint that switches between `engine=google_images` (image search → `images[]` with `original.link`, `original.{width,height}`, `thumbnail`, `source.{link,name}`) and `engine=google` (web search → `organic_results[]`). Bearer auth. Site filter appended as `site:` operator in the query. Added by [`padosoft/laravel-ai-search-providers v1.2.0`](https://github.com/padosoft/laravel-ai-search-providers/releases/tag/v1.2.0).

```
SEARCHAPI_API_KEY=your-key
SEARCHAPI_URL=https://www.searchapi.io
```

Activate:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::query()->create([
    'code' => 'searchapi',
    'name' => 'SearchAPI.io',
    'driver' => 'searchapi',
    'base_url' => 'https://www.searchapi.io',
    'api_key_encrypted' => env('SEARCHAPI_API_KEY'),
    'config' => ['country' => 'us', 'language' => 'en'],
    'priority' => 90,
    'timeout_seconds' => 30,
    'is_active' => true,
]);
```

### You.com

[](#youcom)

`GET /v1/search` against `https://ydc-index.io` with `X-API-Key` header. Parses `results.web[]` (and optionally `results.news[]`) with `title`, `url`, `description`, `snippets[]`, `thumbnail_url`, `page_age`, `favicon_url`. Site filter propagated as `include_domains` (comma-separated). **Web-only** as of 2026-05: You.com does not expose a dedicated image-search endpoint, so `supportsImageSearch()` returns `false` and `SearchProviderManager` skips this driver for image queries automatically — `thumbnail_url` is still surfaced per result, and the extraction pipeline can still harvest images from the returned pages. Added by [`padosoft/laravel-ai-search-providers v1.2.0`](https://github.com/padosoft/laravel-ai-search-providers/releases/tag/v1.2.0).

```
YOUCOM_API_KEY=your-key
YOUCOM_URL=https://ydc-index.io
```

Activate:

```
$p = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::query()->create([
    'code' => 'youcom',
    'name' => 'You.com',
    'driver' => 'youcom',
    'base_url' => 'https://ydc-index.io',
    'api_key_encrypted' => env('YOUCOM_API_KEY'),
    'config' => ['country' => 'US', 'safesearch' => 'moderate'],
    'priority' => 100,
    'timeout_seconds' => 30,
    'is_active' => true,
]);
```

### Fake provider

[](#fake-provider)

Deterministic, no network. Use it for local smoke tests, CI and unit tests. See the [Quick Start](#quick-start-5-minutes-junior-friendly) above for an example configuration that feeds an inline base64 image directly into the download/quality steps.

What It Does
------------

[](#what-it-does)

- Ingests product identity payloads from ERP, PIM or catalog systems.
- Generates targeted search queries from brand, model, SKU, supplier SKU, EAN and color.
- Searches configurable providers.
- Extracts image candidates from search results, structured data, Open Graph tags and gallery-like markup.
- Deduplicates candidates by stable fingerprints.
- Scores candidates against product identity, source trust and image quality.
- Downloads and stores accepted candidate assets.
- Routes uncertain matches to manual review.
- Records audit events for decisions and retries.

Architecture
------------

[](#architecture)

The package is split into small layers so you can replace the parts that touch infrastructure:

- **API layer**: `/api/product-image-discovery/...` endpoints for request ingestion, search, candidate review and configuration.
- **Persistence layer**: migrations and Eloquent models for requests, candidates, source pages, settings, trusted sources, providers and audit events.
- **Pipeline layer**: queue jobs for ingest, search, extraction, verification, download and quality assessment.
- **Search layer**: provider definitions, database repository, provider manager and provider factories.
- **Decision layer**: deterministic scoring, anti-false-positive checks and quality thresholds.
- **Sidecar layer**: optional Node service for rendering JavaScript-heavy product pages with Playwright.

Web Admin UI
------------

[](#web-admin-ui)

Need a ready-made back office for this package? The professional Laravel admin is already available as a sister repository:

**[`padosoft/product_image_discovery_admin`](https://github.com/padosoft/product_image_discovery_admin)**

It provides an operational dashboard, request review queues, candidate comparison, protected image previews, approve/reject/retry actions, provider and trusted-source configuration, debug-flow execution, health checks, report inspection, API workbench tooling, CSV export, saved demo filters and a GitHub Actions release gate.

[![Product Image Discovery Admin dashboard](resources/ProductImageSearch-dashboard.png)](resources/ProductImageSearch-dashboard.png)

Request Flow
------------

[](#request-flow)

 ```
flowchart TD
    A[ERP / PIM / Catalog sends product payload] --> B[POST /api/product-image-discovery/requests]
    B --> C[Validate payload with StoreProductImageDiscoveryRequest]
    C --> D[Upsert discovery request by client_id + erp_model_color_id]
    D --> E[Store full payload in raw_payload]
    E --> F[Dispatch configured ingest job]
    F --> G[IngestProductImageDiscoveryJob]
    G --> H{Payload or request id?}
    H -->|Raw payload| I[Normalize ProductIdentityData]
    H -->|Request id| J[Resume persisted request]
    I --> K[Mark request queued]
    J --> K
    K --> L[Dispatch SearchProductImageJob]
    L --> M[Generate deterministic search queries]
    M --> N[SearchProviderManager executes active providers]
    N --> O{Results found?}
    O -->|No| P[Mark no_candidates_found]
    O -->|Yes| Q[Store search context and mark candidates_found]
    Q --> R[Dispatch ExtractCandidateSourcesJob]
    R --> S[Create source pages and candidate images]
    S --> T[Deduplicate by request_id + fingerprint]
    T --> U[Dispatch VerifyCandidateImageJob]
    U --> V[Score source, text, structured data and hard rejection reasons]
    V --> W[Dispatch DownloadCandidateImageJob]
    W --> X[Download or persist inline image data]
    X --> Y[Dispatch AssessImageQualityJob]
    Y --> Z[Measure dimensions, size and quality signals]
    Z --> AA{Decision threshold}
    AA -->|Strong match| AB[Candidate quality_passed / ready for selection]
    AA -->|Uncertain| AC[Manual review]
    AA -->|Weak or unsafe| AD[Rejected with reason]
    AB --> AE[Audit event + API review endpoints]
    AC --> AE
    AD --> AE
```

      Loading Installation
------------

[](#installation)

Requirements:

- PHP 8.3 or newer.
- Laravel 13.
- Composer.
- A database supported by Laravel. SQLite is enough for a local smoke test.
- A queue driver. `sync` is easiest for a first test; Redis/Horizon is better for production.

### 1. Require the package

[](#1-require-the-package)

```
composer require padosoft/product-image-discovery
```

If you are testing directly from GitHub before Packagist is updated, add the repository first:

```
composer config repositories.product-image-discovery vcs https://github.com/padosoft/product_image_discovery.git
composer require padosoft/product-image-discovery:0.1.0
```

### 2. Review the env examples

[](#2-review-the-env-examples)

The repository ships two examples:

- `.env.example`: useful for a fresh Laravel demo app or for package development.
- `sidecar/.env.example`: useful when running the optional Node/Playwright sidecar.

For a local smoke test, the important host-app values are:

```
DB_CONNECTION=sqlite
DB_DATABASE=database/database.sqlite
QUEUE_CONNECTION=sync
FILESYSTEM_DISK=local
PRODUCT_IMAGE_DISCOVERY_ROUTE_PREFIX=api/product-image-discovery
PRODUCT_IMAGE_DISCOVERY_STORAGE_DISK=local
PRODUCT_IMAGE_DISCOVERY_DEBUG_STOP_ON_FIRST_GOOD=true
PRODUCT_IMAGE_DISCOVERY_DEBUG_GOOD_SCORE_THRESHOLD=65
```

### 3. Publish the config

[](#3-publish-the-config)

```
php artisan vendor:publish --tag=product-image-discovery-config
```

This creates:

```
config/product-image-discovery.php

```

### 4. Publish the migrations

[](#4-publish-the-migrations)

```
php artisan vendor:publish --tag=product-image-discovery-migrations
```

### 5. Run migrations

[](#5-run-migrations)

```
php artisan migrate
```

### 6. Seed default settings and provider templates

[](#6-seed-default-settings-and-provider-templates)

```
php artisan db:seed --class="Padosoft\ProductImageDiscovery\Database\Seeders\ProductImageDiscoveryDefaultsSeeder"
```

The seeder creates default matching thresholds, quality settings and disabled provider templates such as Brave, SerpAPI and Google Custom Search.

### 7. Configure Sanctum abilities

[](#7-configure-sanctum-abilities)

The API middleware expects token abilities like:

```
product-image-discovery:read
product-image-discovery:write
product-image-discovery:review
product-image-discovery:settings
product-image-discovery:admin

```

For a back-office integration, give operators `read` and `review`; give system ingestion tokens `write`; reserve `settings` and `admin` for trusted maintainers.

### 8. Configure queues

[](#8-configure-queues)

By default, jobs use dedicated queue names:

```
'queues' => [
    'ingest' => 'image-discovery-ingest',
    'search' => 'image-discovery-search',
    'extract' => 'image-discovery-extract',
    'verify' => 'image-discovery-verify',
    'download' => 'image-discovery-download',
    'quality' => 'image-discovery-quality',
],
```

Run your Laravel queue workers as usual:

```
php artisan queue:work
```

If you use Horizon, map these queues in `config/horizon.php`.

Live Smoke Test From A Fresh Laravel App
----------------------------------------

[](#live-smoke-test-from-a-fresh-laravel-app)

This path is intentionally explicit so a junior developer can prove the package works in a real Laravel application without setting up Redis, MySQL or a paid search API.

### 1. Create a clean Laravel app

[](#1-create-a-clean-laravel-app)

```
composer create-project laravel/laravel product-image-discovery-demo "^13.0"
cd product-image-discovery-demo
```

### 2. Install the package from GitHub tag `v0.1.0`

[](#2-install-the-package-from-github-tag-v010)

```
composer config repositories.product-image-discovery vcs https://github.com/padosoft/product_image_discovery.git
composer require padosoft/product-image-discovery:0.1.0
```

### 3. Configure `.env`

[](#3-configure-env)

Create the SQLite database file:

```
touch database/database.sqlite
```

On Windows PowerShell:

```
New-Item -ItemType File database/database.sqlite -Force
```

Set these values in the Laravel app `.env`:

```
APP_URL=http://127.0.0.1:8000
DB_CONNECTION=sqlite
DB_DATABASE=database/database.sqlite
QUEUE_CONNECTION=sync
FILESYSTEM_DISK=local
PRODUCT_IMAGE_DISCOVERY_ROUTE_PREFIX=api/product-image-discovery
PRODUCT_IMAGE_DISCOVERY_STORAGE_DISK=local
PRODUCT_IMAGE_DISCOVERY_DEBUG_STOP_ON_FIRST_GOOD=true
PRODUCT_IMAGE_DISCOVERY_DEBUG_GOOD_SCORE_THRESHOLD=65
```

Then generate the app key:

```
php artisan key:generate
```

### 4. Install Sanctum tables and enable API tokens

[](#4-install-sanctum-tables-and-enable-api-tokens)

```
php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"
```

In `app/Models/User.php`, make sure the model uses Sanctum tokens:

```
use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens;
}
```

Keep any existing traits such as `HasFactory` and `Notifiable`; just add `HasApiTokens`.

### 5. Publish package files and migrate

[](#5-publish-package-files-and-migrate)

```
php artisan vendor:publish --tag=product-image-discovery-config
php artisan vendor:publish --tag=product-image-discovery-migrations
php artisan migrate
php artisan db:seed --class="Padosoft\ProductImageDiscovery\Database\Seeders\ProductImageDiscoveryDefaultsSeeder"
```

### 6. Create a test API token

[](#6-create-a-test-api-token)

```
php artisan tinker
```

Inside Tinker:

```
$user = \App\Models\User::factory()->create(['email' => 'pid-demo@example.test']);

$token = $user->createToken('pid-demo', [
    'product-image-discovery:read',
    'product-image-discovery:write',
    'product-image-discovery:review',
    'product-image-discovery:settings',
    'product-image-discovery:admin',
])->plainTextToken;

$token;
```

Copy the printed token for the `Authorization: Bearer ...` header.

### 7. Add a deterministic fake provider

[](#7-add-a-deterministic-fake-provider)

This provider lets you test the whole API and queue path without a paid search API:

```
php artisan tinker
```

Inside Tinker:

```
\Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::updateOrCreate(
    ['code' => 'fake-smoke'],
    [
        'name' => 'Fake Smoke Provider',
        'driver' => 'fake',
        'base_url' => 'https://example.test',
        'config' => [
            'supports_image_search' => true,
            'supports_site_filter' => true,
            'image_results' => [[
                'title' => 'Nike Air Force 1 07 White White',
                'page_url' => 'https://www.nike.com/t/air-force-1-07-mens-shoes-jBrhbr',
                'image_url' => 'data:image/jpeg;base64,'.base64_encode(str_repeat('a', 120000)),
                'source_domain' => 'nike.com',
                'width' => 1200,
                'height' => 1200,
                'provider_metadata' => [
                    'inline_image_base64' => base64_encode(str_repeat('a', 120000)),
                    'inline_extension' => 'jpg',
                ],
            ]],
        ],
        'priority' => 1,
        'timeout_seconds' => 10,
        'is_active' => true,
    ],
);
```

### 8. Start the app

[](#8-start-the-app)

```
php artisan serve
```

### 9. Send a real API request

[](#9-send-a-real-api-request)

Replace `YOUR_TOKEN` with the Sanctum token from step 6:

```
curl -X POST "http://127.0.0.1:8000/api/product-image-discovery/requests" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 1,
    "erp_model_id": "NIKE-AF1-07",
    "erp_model_color_id": "NIKE-AF1-07-CW2288-111",
    "brand": "Nike",
    "supplier": "Nike",
    "supplier_sku": "CW2288-111",
    "model_code": "Air Force 1 07",
    "color_code": "CW2288-111",
    "color_name": "White",
    "category": "Sneakers",
    "material": "Leather"
  }'
```

The same payload is available as a ready-to-edit JSON file:

```
curl -X POST "http://127.0.0.1:8000/api/product-image-discovery/requests" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data @examples/requests/nike-air-force-1-live.json
```

You should receive a JSON response with `ok: true` and a `request_id`. Because `QUEUE_CONNECTION=sync`, the pipeline runs during the request cycle.

Check the stored request:

```
curl "http://127.0.0.1:8000/api/product-image-discovery/requests/1" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

### 10. Optional: activate Brave for a real external search

[](#10-optional-activate-brave-for-a-real-external-search)

Add your key to `.env`:

```
BRAVE_SEARCH_API_KEY=your-real-key
```

Then activate the seeded Brave provider:

```
php artisan tinker
```

Inside Tinker:

```
$provider = \Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'brave')->firstOrFail();
$provider->api_key_encrypted = env('BRAVE_SEARCH_API_KEY');
$provider->is_active = true;
$provider->save();
```

Disable the fake provider when you want only live search results:

```
\Padosoft\ProductImageDiscovery\Models\ProductImageSearchProvider::where('code', 'fake-smoke')->update(['is_active' => false]);
```

Debug Flow Command
------------------

[](#debug-flow-command)

The package includes a console command for full live debugging from a request JSON file. It runs the same pipeline jobs as the queue flow and streams a step-by-step console trace: ingest, generated queries, sites/images found, candidate verification order, every candidate examined, score components, deterministic evidence, optional AI output, download path, hash, quality analysis, errors and final decision.

Before verification, the command ranks candidates with deterministic scoring, so constrained runs start from the strongest product identity match and avoid spending live AI calls on obvious wrong-color or wrong-model candidates first. Use `--report=...` to keep the complete JSON report on disk; use `--json` when you need machine-readable output instead of the live console trace.

Where to run it:

- Inside a host Laravel app that installed the package, use `php artisan ...`.
- Inside this package repository, there is no `artisan` file. Use Orchestra Testbench through `vendor/bin/testbench`.

What you see on screen:

- ASCII art header, so debug runs are easy to spot in terminal history.
- Request ingest: JSON file path, `client_id`, `erp_model_color_id`, brand, model and color identity.
- Search step: provider used, generated queries, executed query attempts, query weights, result count and provider attempts.
- Found sites and images: source domain, page URL, image URL, title and image dimensions for each provider result.
- Extraction step: candidate ids and source pages retained from the search results.
- Candidate plan: deterministic debug rank and the exact order in which candidates will be examined.
- Per-candidate verification: candidate URL, source page, source policy, score components, final score, matches, mismatches, strong matches and rejection reason.
- AI verification output when enabled: provider, model, status, match flags, confidence, brand/model/color/type/quality booleans, AI rejection reason, notes and errors.
- Download step: selected candidate id, remote image URL, local storage path, MIME type, bytes and SHA-256 hash.
- Quality analysis: pass/fail, quality score, dimensions, MIME type and quality issues.
- Final decision: request status, selected/best candidate id, final score, verified match count and report path.
- Audit events: persisted event type, level, candidate id and JSON context for later inspection.

```
php artisan product-image-discovery:debug-flow examples/requests/herno-cappa-nylon-ultralight-cammello.json
```

That `php artisan` form only works from a Laravel app root. If you run it from the package root and see `Could not open input file: artisan`, use the Testbench commands in the Herno example below.

Useful options:

```
php artisan product-image-discovery:debug-flow examples/requests/herno-cappa-nylon-ultralight-cammello.json \
  --fresh \
  --max-candidates=10 \
  --report=storage/app/product-image-discovery/debug/herno-flow.json
```

- `--fresh`: deletes the existing request for the same `client_id + erp_model_color_id` before running.
- `--max-candidates=10`: limits how many discovered candidates are verified in this debug run.
- `--report=...`: writes the complete JSON report to disk while still printing the formatted console output.
- `--json`: prints only the JSON report and disables the live console trace.
- `--no-download`: skips download and quality assessment.
- `--download-all`: downloads and quality-assesses every verified candidate; by default only the best verified candidate is downloaded.
- `--clean-storage`: deletes the `product-image-discovery/{request_id}` storage directory before downloading, useful when repeating debug runs.
- `--stop-on-first-good`: stops verifying more candidates after a good verified candidate is found.
- `--exhaustive`: verifies every candidate up to `--max-candidates`, ignoring the early-stop setting.
- `--good-score=65`: overrides the score threshold used by early stop.
- `--migrate`: runs migrations first, useful in local demo/Testbench environments.
- `--no-env-brave`: disables automatic creation of a `brave-live-debug` provider from `BRAVE_SEARCH_API_KEY`.
- `--fail-on-no-match`: exits with a failure code when no candidate reaches `verified_match`.

Early stop is controlled by:

```
PRODUCT_IMAGE_DISCOVERY_DEBUG_STOP_ON_FIRST_GOOD=true
PRODUCT_IMAGE_DISCOVERY_DEBUG_GOOD_SCORE_THRESHOLD=65
```

With early stop enabled, the command stops candidate verification when a verified candidate is good enough because it comes from an auto-publish/trusted source, the source domain contains the brand, or its final score reaches the configured threshold. Use `--exhaustive` when you intentionally want to inspect all candidates up to `--max-candidates`.

`--fresh` also cleans the storage directory for the matching old request ids and the new debug request id. This matters especially when running from the package with Testbench: the database is often SQLite in-memory, so request ids can restart from `1` while physical files under `vendor/orchestra/testbench-core/laravel/storage/...` remain from older debug or live test runs.

To inspect and download every verified candidate in a broad run, combine:

```
php artisan product-image-discovery:debug-flow examples/requests/herno-cappa-nylon-ultralight-cammello.json \
  --exhaustive \
  --download-all \
  --max-candidates=10
```

### Herno Live Debug Example

[](#herno-live-debug-example)

The repository includes a real fashion request example without any source page or image URL:

```
examples/requests/herno-cappa-nylon-ultralight-cammello.json

```

It describes:

- Brand: `Herno`
- Model/code: `PI002223D`
- Product: `Cappa In Nylon Ultralight Cammello`
- Color: `Cammello`
- Category: `Donna > Maglie e camicie > Felpe e maglie`
- Material: `100% Nylon`

Run it in a host Laravel app:

```
php artisan product-image-discovery:debug-flow examples/requests/herno-cappa-nylon-ultralight-cammello.json \
  --fresh \
  --max-candidates=10 \
  --report=storage/app/product-image-discovery/debug/herno-flow.json
```

Run it from this package with Testbench on Windows PowerShell:

```
$env:APP_KEY = 'base64:' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(('a' * 32)))
$env:DB_CONNECTION='sqlite'
$env:DB_DATABASE=':memory:'
$request = (Resolve-Path .\examples\requests\herno-cappa-nylon-ultralight-cammello.json).Path
$report = Join-Path (Get-Location) 'storage\debug\herno-flow.json'
& 'C:\Users\lopad\.config\herd\bin\php84\php.exe' vendor\bin\testbench product-image-discovery:debug-flow $request --migrate --fresh --max-candidates=10 --report=$report
```

Run it from this package with Testbench on macOS/Linux shell:

```
export APP_KEY="$(php -r 'echo "base64:".base64_encode(str_repeat("a", 32));')"
export DB_CONNECTION=sqlite
export DB_DATABASE=':memory:'
request="$(pwd)/examples/requests/herno-cappa-nylon-ultralight-cammello.json"
report="$(pwd)/storage/debug/herno-flow.json"
php vendor/bin/testbench product-image-discovery:debug-flow "$request" --migrate --fresh --max-candidates=10 --report="$report"
```

With `BRAVE_SEARCH_API_KEY` configured, the command auto-creates a `brave-live-debug` provider and shows the live Brave image results. Search queries prefer product-code + color combinations before bare product-code searches, so fashion variants such as `PI002223D CAMMELLO` are tried before broader `PI002223D` searches. With AI enabled and `PRODUCT_IMAGE_DISCOVERY_AI_ATTACH_REMOTE_IMAGE=true`, it also sends each verified candidate image URL to the configured vision model and prints the full AI verification result.

The AI verifier is instructed to inspect the actual attached image first. Numeric vendor color ids in URLs or DOM metadata are not treated as color names: if the image visibly looks camel/tan/beige/cammello, the model can mark the requested color as equivalent; if the image visibly shows a different product or color, for example white shoes, it should mark `match=false`, `variant_safe=false`, `color_match=false` and `product_type_match=false`.

In the local Herno run, the trace found the official `us.herno.com` image, downloaded it under `product-image-discovery/{request_id}/{candidate_id}.jpg`, quality-checked it, printed the SHA-256 hash, and kept the request in `manual_review` because the source was not configured as auto-publishable. External results and AI wording can change, so treat the report as the source of truth for each run.

Downloaded image paths:

- The command prints the logical path stored on the configured Laravel disk, for example `product-image-discovery/1/4.jpg`.
- In a host Laravel app with `PRODUCT_IMAGE_DISCOVERY_STORAGE_DISK=local`, that file is physically under the app storage directory, for example `storage/app/private/product-image-discovery/1/4.jpg`.
- When running from this package with Testbench, the Laravel app is Testbench's skeleton app, so the physical file is under `vendor/orchestra/testbench-core/laravel/storage/app/private/product-image-discovery/1/4.jpg`.
- If you change `PRODUCT_IMAGE_DISCOVERY_STORAGE_DISK`, inspect the root configured for that disk in the host app's `config/filesystems.php`.

Console screenshots:

[![Debug flow command ingest and search trace](resources/artisan-command-01.png)](resources/artisan-command-01.png)

[![Debug flow command candidate ranking and scoring trace](resources/artisan-command-02.png)](resources/artisan-command-02.png)

Quickstart
----------

[](#quickstart)

Send a product-color payload:

```
curl -X POST "https://your-app.test/api/product-image-discovery/requests" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 10,
    "erp_model_color_id": "SHOE-123-BLACK",
    "erp_model_id": "SHOE-123",
    "brand": "Example Brand",
    "supplier": "Main Supplier",
    "sku": "SHOE-123-BLK-42",
    "supplier_sku": "SUP-9988",
    "model_code": "SHOE-123",
    "color_code": "BLK",
    "color_name": "Black",
    "ean": "8050000000000",
    "season": "FW26",
    "category": "Sneakers",
    "material": "Leather"
  }'
```

Example response:

```
{
  "ok": true,
  "request_id": 1,
  "erp_model_color_id": "SHOE-123-BLACK",
  "status": "queued"
}
```

Search requests:

```
curl "https://your-app.test/api/product-image-discovery/requests/search?status=manual_review" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

Approve a candidate:

```
curl -X POST "https://your-app.test/api/product-image-discovery/requests/1/candidates/5/approve" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
```

Reject a candidate:

```
curl -X POST "https://your-app.test/api/product-image-discovery/requests/1/candidates/5/reject" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"reason": "wrong_color", "notes": "The image shows the white variant."}'
```

EAN / Barcode Matching
----------------------

[](#ean--barcode-matching)

`ean` is optional, but when your ERP/PIM/supplier has the real product barcode it is one of the strongest identity signals in the package.

Accepted payload aliases:

```
ean
barcode
bar_code
gtin
gtin13
gtin14

```

The API normalizes these aliases into the stored `ean` field. When `ean` is present:

- search query generation tries the brand + EAN query first with the highest weight;
- source patterns can use `{ean}`;
- textual matches against the discovered page/image metadata count as a strong product identity match;
- structured data matches against `gtin`, `gtin8`, `gtin12`, `gtin13`, `gtin14` or `ean` count as a strong match;
- a structured GTIN/EAN mismatch is treated as a wrong-product risk;
- even an exact EAN match does not override crucial contradictions such as wrong visible color, wrong product type, wrong brand, permission limits or low-quality image evidence.

Do not invent barcodes for smoke tests. Leave `ean`/`barcode` empty unless the value comes from the real catalog, supplier or product feed.

Real Product Payload Examples
-----------------------------

[](#real-product-payload-examples)

These examples are realistic ERP/PIM payloads for products that also exist on public fashion sites. The request intentionally does not include an image URL or product page URL: discovering that page/image is the job of the package. Ecommerce pages can change, go out of stock or block automated access, so treat these as smoke-test payloads rather than permanent fixtures. Do not invent EANs: leave `ean` empty unless your ERP/PIM has the real barcode.

Ready-to-edit request files are available in:

```
examples/requests/

```

- `erp-product-image-discovery-request.example.json`: generic ERP/PIM template without image/source URLs.
- `nike-air-force-1-live.json`: concrete Nike smoke-test payload.
- `herno-cappa-nylon-ultralight-cammello.json`: concrete Herno fashion payload for live discovery/debug flow testing.

### Nike Air Force 1 07, White/White

[](#nike-air-force-1-07-whitewhite)

Source page: [Nike Air Force 1 07 men's shoes](https://www.nike.com/t/air-force-1-07-mens-shoes-jBrhbr)

```
{
  "client_id": 1,
  "erp_model_id": "NIKE-AF1-07",
  "erp_model_color_id": "NIKE-AF1-07-CW2288-111",
  "brand": "Nike",
  "supplier": "Nike",
  "supplier_sku": "CW2288-111",
  "model_code": "Air Force 1 07",
  "color_code": "CW2288-111",
  "color_name": "White",
  "category": "Sneakers",
  "material": "Leather"
}
```

### Nike Air Force 1 07, White/White, LuisaViaRoma item

[](#nike-air-force-1-07-whitewhite-luisaviaroma-item)

Source page: [LuisaViaRoma Nike Air Force 1 07 sneakers](https://www.luisaviaroma.com/en-us/p/nike/women/82I-U3C014)

```
{
  "client_id": 1,
  "erp_model_id": "NIKE-AF1-07-WOMEN",
  "erp_model_color_id": "LVR-82I-U3C014",
  "brand": "Nike",
  "supplier": "LuisaViaRoma",
  "supplier_sku": "82I-U3C014",
  "model_code": "Air Force 1 07",
  "color_code": "82I-U3C014",
  "color_name": "White",
  "category": "Sneakers",
  "material": "Calf leather"
}
```

### adidas Originals Samba OG, White/Black, LuisaViaRoma item

[](#adidas-originals-samba-og-whiteblack-luisaviaroma-item)

Source page: [LuisaViaRoma adidas Originals Samba OG sneakers](https://www.luisaviaroma.com/en-us/p/adidas-originals/men/80I-T57018)

```
{
  "client_id": 1,
  "erp_model_id": "ADIDAS-SAMBA-OG",
  "erp_model_color_id": "LVR-80I-T57018",
  "brand": "adidas Originals",
  "supplier": "LuisaViaRoma",
  "supplier_sku": "80I-T57018",
  "model_code": "Samba OG",
  "color_code": "80I-T57018",
  "color_name": "White/Black",
  "category": "Sneakers",
  "material": "Calf leather"
}
```

### New Balance 550, White/Grey, LuisaViaRoma item

[](#new-balance-550-whitegrey-luisaviaroma-item)

Source page: [LuisaViaRoma New Balance 550 sneakers](https://www.luisaviaroma.com/en-us/p/new-balance/men/78I-AM9016)

```
{
  "client_id": 1,
  "erp_model_id": "NEW-BALANCE-550",
  "erp_model_color_id": "LVR-78I-AM9016",
  "brand": "New Balance",
  "supplier": "LuisaViaRoma",
  "supplier_sku": "78I-AM9016",
  "model_code": "550",
  "color_code": "78I-AM9016",
  "color_name": "White/Grey",
  "category": "Sneakers",
  "material": "Leather and synthetic"
}
```

Amazon is not used as a default example because product pages are highly personalized, protected and terms-sensitive. Use official brand pages or trusted fashion retailers first.

Configuration
-------------

[](#configuration)

The main config file is `config/product-image-discovery.php`.

Important options:

- `route_prefix`: default `api/product-image-discovery`.
- `route_middleware`: default `['api', 'auth:sanctum']`.
- `abilities`: Sanctum ability names used by the package middleware.
- `models`: override Eloquent models if your app extends package models.
- `jobs.ingest`: override the entry job if you need custom orchestration.
- `queues`: queue names per pipeline phase.
- `storage.disk`: disk used for candidate assets.
- `defaults`: search, quality and decision thresholds.

Trusted Sources
---------------

[](#trusted-sources)

Trusted source records let you prefer domains that are known to publish correct product images for a client or brand. A trusted source should improve confidence, but it should not bypass hard checks such as wrong color, wrong model, placeholder image or low-quality asset.

Optional Playwright Sidecar
---------------------------

[](#optional-playwright-sidecar)

Some ecommerce pages render images only after JavaScript runs. The package keeps browser rendering out of PHP and delegates it to an optional Node sidecar.

Start the sidecar:

```
cd sidecar
npm install
npm start
```

Sidecar endpoints:

- `GET /health`
- `POST /render`

Environment variables:

```
SIDECAR_HOST=127.0.0.1
SIDECAR_PORT=3100
SIDECAR_SHARED_SECRET=change-me
SIDECAR_DEFAULT_TIMEOUT_MS=15000
SIDECAR_MAX_TIMEOUT_MS=30000

```

The sidecar uses Playwright when available and falls back to static HTTP+HTML extraction when browser rendering is unavailable.

AI And Vision
-------------

[](#ai-and-vision)

The package includes an optional Laravel AI SDK integration for AI-assisted candidate verification. The core pipeline does not require an LLM: deterministic source/text/quality checks still run first, and AI output is stored as supporting evidence in `ai_analysis`.

This keeps local development, CI and production ingestion stable even when a model provider is unavailable.

The config defaults to Regolo through [`padosoft/laravel-ai-regolo`](https://github.com/padosoft/laravel-ai-regolo), while still supporting OpenAI, Anthropic and OpenRouter as alternate Laravel AI providers. AI verification is disabled by default, so the core pipeline remains deterministic and offline-friendly until you opt in with credentials.

```
PRODUCT_IMAGE_DISCOVERY_AI_ENABLED=false
PRODUCT_IMAGE_DISCOVERY_AI_PROVIDER=regolo
PRODUCT_IMAGE_DISCOVERY_AI_TIMEOUT=45
PRODUCT_IMAGE_DISCOVERY_AI_FAIL_SILENTLY=true
PRODUCT_IMAGE_DISCOVERY_AI_ATTACH_REMOTE_IMAGE=false
PRODUCT_IMAGE_DISCOVERY_AI_VISION_MODEL=
PRODUCT_IMAGE_DISCOVERY_AI_DESCRIPTION_MODEL=Llama-3.3-70B-Instruct
REGOLO_API_KEY=
REGOLO_URL=https://api.regolo.ai/v1
REGOLO_BASE_URL=
OPENAI_API_KEY=
OPENAI_URL=https://api.openai.com/v1
OPENAI_BASE_URL=
ANTHROPIC_API_KEY=
ANTHROPIC_URL=https://api.anthropic.com/v1
ANTHROPIC_BASE_URL=
OPENROUTER_API_KEY=
OPENROUTER_URL=https://openrouter.ai/api/v1
OPENROUTER_BASE_URL=
```

To enable AI verification:

```
PRODUCT_IMAGE_DISCOVERY_AI_ENABLED=true
PRODUCT_IMAGE_DISCOVERY_AI_PROVIDER=regolo
REGOLO_API_KEY=your-key
REGOLO_URL=https://api.regolo.ai/v1
PRODUCT_IMAGE_DISCOVERY_AI_DESCRIPTION_MODEL=Llama-3.3-70B-Instruct
```

For Anthropic:

```
PRODUCT_IMAGE_DISCOVERY_AI_ENABLED=true
PRODUCT_IMAGE_DISCOVERY_AI_PROVIDER=anthropic
ANTHROPIC_API_KEY=your-key
PRODUCT_IMAGE_DISCOVERY_AI_VISION_MODEL=claude-sonnet-4-5-20250929
PRODUCT_IMAGE_DISCOVERY_AI_DESCRIPTION_MODEL=claude-haiku-4-5-20251001
```

For OpenRouter:

```
PRODUCT_IMAGE_DISCOVERY_AI_ENABLED=true
PRODUCT_IMAGE_DISCOVERY_AI_PROVIDER=openrouter
OPENROUTER_API_KEY=your-key
OPENROUTER_URL=https://openrouter.ai/api/v1
PRODUCT_IMAGE_DISCOVERY_AI_VISION_MODEL=your-openrouter-vision-model-id
```

By default, remote image attachments are disabled and the verifier sends product/candidate metadata only. Set `PRODUCT_IMAGE_DISCOVERY_AI_ATTACH_REMOTE_IMAGE=true` when you want the selected provider/model to inspect the candidate image URL directly. Keep this opt-in because not every provider/model supports remote image attachments.

Regolo is the package default because it gives Laravel applications an Italian/EU sovereign AI path through the same `laravel/ai` API. If you switch to Anthropic, OpenAI or OpenRouter, set model names supported by that provider.

Testing
-------

[](#testing)

Install PHP dependencies:

```
composer install
```

Run all PHP suites:

```
vendor/bin/phpunit --testsuite Unit,Feature,E2E
```

Run sidecar tests:

```
cd sidecar
npm test
```

The current local verification used Herd PHP 8.4:

```
& 'C:\Users\lopad\.config\herd\bin\php84\php.exe' vendor\bin\phpunit --testsuite Unit,Feature,E2E
```

In a fresh offline environment, live sidecar/search/AI checks are skipped cleanly unless their credentials or URLs are provided. The current local verification with real `BRAVE_SEARCH_API_KEY`, real `ANTHROPIC_API_KEY` and remote AI image attachments enabled is:

```
72 tests, 319 assertions, 1 skipped

```

The skipped test is the live sidecar contract. Set `SIDECAR_E2E_URL` to test against a real running sidecar. Live search and AI checks require their provider credentials.

Run the live AI verifier explicitly when you have a real Regolo, Anthropic, OpenRouter or OpenAI key in `.env`:

```
& 'C:\Users\lopad\.config\herd\bin\php84\php.exe' vendor\bin\phpunit --testsuite E2E --filter LiveProductImageAiVerifierTest
```

With `PRODUCT_IMAGE_DISCOVERY_AI_ATTACH_REMOTE_IMAGE=true`, this live test sends a real product image URL to the provider and should pass with `1 test`, `9 assertions`.

Database Tables
---------------

[](#database-tables)

- `product_image_discovery_requests`
- `product_image_discovery_candidates`
- `product_image_discovery_source_pages`
- `product_image_discovery_settings`
- `product_image_trusted_sources`
- `product_image_search_providers`
- `product_image_discovery_events`

Safety Notes
------------

[](#safety-notes)

- Use the package only for lawful, authorized discovery activity and only on sources you are allowed to access.
- Respect robots.txt and source terms.
- Prefer official supplier, brand or trusted retailer sources.
- Do not publish images when license, ownership or product correctness is unclear.
- Keep manual review in the flow for uncertain matches.
- Treat watermarks, text overlays, placeholders and low-resolution images as quality risks.

Admin UI Guidance
-----------------

[](#admin-ui-guidance)

This package stays headless. If you want to integrate a review/configuration experience inside an existing ecommerce admin, use [docs/ADMIN\_UI\_UX\_GUIDELINES.md](docs/ADMIN_UI_UX_GUIDELINES.md). It describes the recommended vanilla JavaScript screens, components, filters, debug report viewer, guided debug-flow runner, provider credential status and API calls.

Roadmap
-------

[](#roadmap)

**Recent additions (since v0.1.0):**

- **v1.0.0**: search layer extracted into the standalone package [`padosoft/laravel-ai-search-providers`](https://github.com/padosoft/laravel-ai-search-providers) (Packagist v1.0.x). This repo now depends on it via composer; the existing `ProductImageSearchProvider` Eloquent model is preserved as a thin subclass for BC.
- 8 live search providers wired through a single `SearchProviderManager`: `brave`, `tavily`, `exa`, `firecrawl`, `websearchapi`, `duckduckgo`, `searchapi`, `youcom`. The drivers are maintained in the standalone [`padosoft/laravel-ai-search-providers`](https://github.com/padosoft/laravel-ai-search-providers) composer package (currently v1.2.x). Historical rollout is tracked in [docs/ROADMAP\_SEARCH\_PROVIDERS.md](docs/ROADMAP_SEARCH_PROVIDERS.md).
- Shared `AbstractHttpSearchProvider` so new drivers add ~80 LOC of provider-specific code.
- GitHub Actions CI for PHP 8.3 / 8.4 + Node sidecar.
- Junior-friendly [Quick Start](#quick-start-5-minutes-junior-friendly) that brings a fresh Laravel 13 app to a successful API response in 5 minutes without external keys.
- Optional Regolo, Anthropic, OpenAI and OpenRouter providers for AI-assisted candidate verification.
- EAN / GTIN / barcode alias normalization with strong-match scoring.

**Planned:**

- First-party SerpAPI and Google Custom Search drivers (templates already seeded).
- Richer AI review signals while keeping deterministic checks as the publication gate.
- Perceptual-hashing duplicate detection.
- Image enhancement pipeline behind explicit config.
- Host-admin UI integration examples (sister repo: [`padosoft/product_image_discovery_admin`](https://github.com/padosoft/product_image_discovery_admin)).
- Runtime enforcement of `rate_limit_per_minute` (currently advisory only).

Contributing
------------

[](#contributing)

Pull requests are welcome. Before opening one:

1. Keep changes focused.
2. Add or update tests for behavior changes.
3. Run the PHP suite.
4. Run the sidecar suite if you touched `sidecar/`.
5. Update docs when behavior, configuration or architecture changes.

License & credits
---------------------

[](#license--credits)

Apache-2.0. See [LICENSE](LICENSE).

Sister packages in the Padosoft AI stack:

- `padosoft/laravel-ai-regolo` -- first-class Regolo (Italian sovereign AI) provider for `laravel/ai`.
- `padosoft/laravel-flow` -- saga / workflow orchestration for Laravel.
- `padosoft/eval-harness` -- RAG + agent evaluation harness.
- `padosoft/laravel-pii-redactor` -- PII redaction middleware for AI prompts.

Each is independently usable. None requires the others. Pick what you need.

###  Health Score

46

—

FairBetter than 92% of packages

Maintenance96

Actively maintained with recent releases

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 92% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

7

Last Release

17d ago

Major Versions

v0.3.0 → v1.0.02026-05-23

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/10467699?v=4)[Lorenzo](/maintainers/lopadova)[@lopadova](https://github.com/lopadova)

---

Top Contributors

[![lopadova](https://avatars.githubusercontent.com/u/10467699?v=4)](https://github.com/lopadova "lopadova (23 commits)")[![ImgBotApp](https://avatars.githubusercontent.com/u/31427850?v=4)](https://github.com/ImgBotApp "ImgBotApp (2 commits)")

---

Tags

aiai-scoringlaravelproduct-searchlaravelaisanctumscrapinghorizonplaywrightproduct imagesimage-discoveryimage-verification

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/padosoft-product-image-discovery/health.svg)

```
[![Health](https://phpackages.com/badges/padosoft-product-image-discovery/health.svg)](https://phpackages.com/packages/padosoft-product-image-discovery)
```

###  Alternatives

[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9732.3M121](/packages/roots-acorn)[psalm/plugin-laravel

Psalm plugin for Laravel

3325.1M337](/packages/psalm-plugin-laravel)[laravel/pulse

Laravel Pulse is a real-time application performance monitoring tool and dashboard for your Laravel application.

1.7k14.1M120](/packages/laravel-pulse)[laravel/ai

The official AI SDK for Laravel.

9782.1M153](/packages/laravel-ai)[laravel/mcp

Rapidly build MCP servers for your Laravel applications.

76318.2M110](/packages/laravel-mcp)[flarum/core

Delightfully simple forum software.

261.4M2.2k](/packages/flarum-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)