Find scenes by fingerprint
find_by_fingerprintRead-only
Match file hashes (MD5, OSHASH, PHASH) against stash-box catalogues to identify scenes and return detailed records from every catalogue holding the fingerprint.
Instructions
Identify a file from the hashes held for it, across every configured stash-box catalogue. MD5 and OSHASH name the bytes of a file; PHASH states a likeness a re-encode, a crop or another scene from one shoot can satisfy. Each record reached is answered as one card, read on every catalogue that holds it.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prefer | No | The order the catalogues are preferred in where they disagree on a field. Left out, the registry's own order stands, and every card states the order applied. | |
| sources | No | ||
| sections | No | The blocks read beside the record's own fields, which come back whatever is written here. Each name adds a block, and 'basic' asks for those fields alone. | |
| fingerprints | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asked | Yes | ||
| notes | Yes | ||
| cached | No | ||
| matches | Yes | ||
| unmatched | Yes | The hashes put to a catalogue that answered, which reached no record there. A catalogue named as unasked says nothing about them either way. | |
| per_source | Yes | ||
| match_count | Yes | One per card here. Every hash that reached a record names it on one card, and a record reached both by an exact hash and by a perceptual one stands as two, since the two claim different things about it. Read records_named for how many files were named, which counts each once. | |
| not_searched | Yes | Hashes and the catalogues that answered without searching their algorithm, so they were never put to those. Nobody looked there, which is no evidence about the files behind them. | |
| resemblances | Yes | Matches a perceptual hash reached, each a likeness and no claim about any file's bytes. | |
| unattributed | Yes | Records the catalogues answered with that carry none of the hashes asked. Which hash reached them is unknown, so they stand as no match and are counted apart. | |
| records_named | Yes | Distinct records an exact hash named. Two hashes reaching one record count once, and a perceptual match names no record. |