Skip to main content

Postgres indexing utilities to implement high-throughput queries with on-the-fly deduplication

Project description

dedup-pg

A library with functions useful for implementing a MinHash-based deduplication indexing layer in Postgres, or any relational database.

Use cases

In cases where you have to search for specific items in a dataset derived from noisy data, it is likely that there are duplicates which hurt retrieval quality. We can estimate the similarity between such items by hashing their components in a way to approximate their Jaccard similarity. This can be useful for deduplication before item ingestion into an online production database.

However, if your system has special constraints, particularly multi-tenancy where you cannot simply delete items for every user (because some users might not have access to certain duplicates), it becomes more infeasible to compute Jaccard similarity pair-wise per query. This library helps solve this by using locality-sensitive hashing to bucket items that are likely to be above a specified Jaccard similarity.

In short, it makes query-time deduplication possible and efficient for search systems with special needs such as multi-tenant retrieval-augmented generation (RAG).

Usage

Below is an example of usage for deduplicating textual chunks.

from collections import defaultdict

from dedup_pg import DedupIndex
from dedup_pg.helpers import n_grams

# A corpus of named items we want to deduplicate
corpus = [
    ("key1", "The quick brown fox jumps over the lazy dog"),
    ("key2", "T e qui k bnown fox jump  over t e  azy  og"),
    ("key3", "An entirely different sentence!"),
]

# Our deduplication index - this can be Postgres-backed with configuration
lsh = DedupIndex()

# Using n=3 character n-grams is a strong choice for deduplicating textual chunks
n_gram_corpus = [(key, n_grams(text, n=3)) for key, text in corpus]

# Index bands for each key which help us determine duplicates
duplicate_map = defaultdict(list)
for key, n_gram in n_gram_corpus:
    bands = lsh.bands(n_gram)
    lsh_items = lsh.items(bands)
    cluster_key = lsh.index(lsh_items)

    duplicate_map[cluster_key].append(key)

# `key1` and `key2` are in the same cluster in contrast to `key3`
print(duplicate_map)

For ease-of-use, we give two options for interfacing with the Postgres backend. Option 1 is to upload the LSH bands yourself as (cluster_key/foreign_key, band_index, band_hash) rows, then store the cluster_key for the table you want to perform deduplicated queries in. Option 2 is using the provided backends, which are a work-in-progress.

Alternatives

This library is the easiest way to implement deduplication in Postgres, and has been successfully used in production (at the company I'm working at). Most similar libraries are built for local usage and have non-compact serialization incompatible with Postgres.

However, datasketch and rensa are good alternatives if you would like something different.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dedup_pg-0.2.1.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dedup_pg-0.2.1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file dedup_pg-0.2.1.tar.gz.

File metadata

  • Download URL: dedup_pg-0.2.1.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.19

File hashes

Hashes for dedup_pg-0.2.1.tar.gz
Algorithm Hash digest
SHA256 3ddcd3b9ae78bf2ad660869879853aa7893a6bb6449f369ef29a5294d1934ad0
MD5 9357ea072d2f58d4baec2fa2194216ac
BLAKE2b-256 e0d40f9c36ed7b7b4ef6bd8e8b77076688a1a4b413c88af45f3579047047ae32

See more details on using hashes here.

File details

Details for the file dedup_pg-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: dedup_pg-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.19

File hashes

Hashes for dedup_pg-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27429935fa18ab9fbc7ea7f707495589285de518adf3decc66611ba53cdce5ba
MD5 c2e0c1f06d791b3c8a553351edd2dae3
BLAKE2b-256 32fe628fe1de7b7e365915f02ba16371c4345c2164f11850b3e27a45047dec65

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page