API reference

This page is intentionally simple for now. Replace with generated stubs later if preferred.

ImageHashIndex

Main in-memory index.

$index = new ImageHashIndex();

add()

Add a precomputed hash.

$index->add(string $id, string $hash): void

Example:

$index->add('image-1', 'f123456789abcdef');

search()

Search by hash.

$index->search(string $hash, int $maxDistance = 10, int $limit = 10): array

Example:

$matches = $index->search('f123456789abcdef', maxDistance: 5, limit: 20);

save()

Save the index to disk.

$index->save(string $path): void

load()

Load a saved index.

$index = ImageHashIndex::load(string $path);

Result shape

Expected result shape:

[
    [
        'id' => 'image-1',
        'distance' => 0,
    ],
    [
        'id' => 'image-2',
        'distance' => 2,
    ],
]