Algorithm auditing tools for search engine autocomplete
Project description
suggests
Tools for auditing search engine autocomplete.
Retrieves autocomplete suggestions from Google and Bing and recursively expands them into suggestion trees for algorithm audits. Convert trees to polars edge lists, reduce them to association networks, and plot them with the suggests-plot command or plot_network() in Python. A sleep timer is hard-coded into the recursive crawler (~1 sec) based on my experience — you will get blocked if you do not restrict your crawling speed.
The functionality of this package was demonstrated in the paper listed below. If you use it in your work, please cite our paper!
Robertson R. E., Jiang, S., Lazer, D., & Wilson, C. (2019). Auditing autocomplete: Recursive algorithm interrogation and suggestion networks. In Proceedings of the 11th ACM Conference on Web Science (WebSci 2019). PDF
@inproceedings{robertson2019autocomplete,
author = {Robertson, Ronald E. and Jiang, Shan and Lazer, David and Wilson, Christo},
year = {2019},
title = {Auditing autocomplete: Recursive algorithm interrogation and suggestion networks},
booktitle = {Proceedings of the 11th International ACM Web Science Conference},
series = {WebSci '19},
doi = {10.1145/3292522.3326047},
}
Project Structure
suggests/
├── .github/workflows/ # CI: tests and PyPI publishing
├── .planners/ # Plan files
├── img/ # Network plot images used in this README
├── suggests/ # Python library
│ ├── suggests.py # Suggestion retrieval and recursive tree crawling
│ ├── parsing.py # Response parsing, edge lists, and metanode extraction
│ ├── nets.py # Network construction and plotting
│ ├── logger.py # Package-scoped logging
│ └── scripts/ # CLI commands
│ ├── demo.py # Demo crawl (`demo`)
│ └── plot.py # Network plotting (`suggests-plot`)
├── tests/ # Test suite
│ └── fixtures/ # Sample crawl data (tree JSON and edge-list CSV)
├── CHANGELOG.md # Release history
└── pyproject.toml # Project configuration
Installation
Install with uv:
uv add suggests
Network plotting requires the viz extra:
uv add "suggests[viz]"
For development, install from GitHub:
git clone https://github.com/gitronald/suggests.git
cd suggests
uv sync
CLI Commands
demo
Run a depth-1 demo crawl (dog on Bing) and print the resulting suggestion tree and edge list:
uv run demo
suggests-plot
Render a network plot from any edge-list CSV (requires the viz extra). Wraps plot_network():
uv run suggests-plot --edges edges.csv --root dog --save-to plot.png
Examples
Getting suggestions
import suggests
>>> s = suggests.get_suggests('geese are ', source='google')
2019-05-23 11:28:30,467 | 1897 | INFO | suggests.logger | google | geese are
>>> s['suggests']
['geese are evil', 'geese are mean', 'geese are aggressive', 'geese are jerks', 'geese are the worst', 'geese are scary', 'geese are dinosaurs', 'geese are protected', 'geese are annoying', 'geese are monogamous']
Use the hl parameter for Google (e.g. 'es', 'de', 'fr') to get suggestions in other languages:
>>> s = suggests.get_suggests('los gansos son ', source='google', hl='es')
2026-03-12 11:40:41,677 | 26509 | INFO | suggests | google | los gansos son
>>> s['suggests']
['los gansos son territoriales', 'los gansos son monogamos', 'los gansos son patos', 'los gansos son comestibles', 'los gansos son aves']
For Bing, use the mkt parameter (e.g. 'es-es', 'de-de', 'fr-fr') to get suggestions in other languages:
>>> s = suggests.get_suggests('los gansos son ', source='bing', mkt='es-es')
2026-03-12 11:40:43,764 | 26509 | INFO | suggests | bing | los gansos son
>>> s['suggests']
['los gansos son agresivos', 'que son los gansos', 'sonidos de gansos']
Generating a suggestions tree
Below is a more involved example usage: creating a suggestions network for the query 'abortion', recursing to a maximum depth (breadth-first search steps) of 4.
In [1]: tree = suggests.get_suggests_tree('abortion', source='google', max_depth=4)
2019-05-21 10:10:32,578 | 9943 | INFO | suggests.logger | google | abortion
2019-05-21 10:10:34,092 | 9943 | INFO | suggests.logger | google | abortion laws 2019
2019-05-21 10:10:35,172 | 9943 | INFO | suggests.logger | google | abortion pill
2019-05-21 10:10:36,323 | 9943 | INFO | suggests.logger | google | abortion law
2019-05-21 10:10:37,334 | 9943 | INFO | suggests.logger | google | abortion statistics
2019-05-21 10:10:38,426 | 9943 | INFO | suggests.logger | google | abortion definition
2019-05-21 10:10:39,473 | 9943 | INFO | suggests.logger | google | abortion clinic
2019-05-21 10:10:40,257 | 9943 | INFO | suggests.logger | google | abortion protest day
2019-05-21 10:10:41,439 | 9943 | INFO | suggests.logger | google | abortion facts
...
2019-05-21 10:23:54,633 | 9943 | INFO | suggests.logger | google | statistics on abortion 2019
2019-05-21 10:23:55,742 | 9943 | INFO | suggests.logger | google | statistics on abortion in nigeria
2019-05-21 10:23:57,002 | 9943 | INFO | suggests.logger | google | statistics on abortion uk
2019-05-21 10:23:58,094 | 9943 | INFO | suggests.logger | google | statistics on abortion in the philippines
2019-05-21 10:23:59,332 | 9943 | INFO | suggests.logger | google | statistics on abortion in ireland
2019-05-21 10:24:00,613 | 9943 | INFO | suggests.logger | google | gosnell' abortion doctor movie releases trailer
2019-05-21 10:24:02,088 | 9943 | INFO | suggests.logger | google | anti abortion movie unplanned trailer
2019-05-21 10:24:03,293 | 9943 | INFO | suggests.logger | google | who played the abortion doctor in the movie unplanned
2019-05-21 10:24:04,255 | 9943 | INFO | suggests.logger | google | cast of unplanned wedding
Examining the data
In [2]: tree[0]
Out[2]:
{'qry': 'abortion',
'datetime': '2019-05-21 14:10:31.188217',
'source': 'google',
'data': ['abortion',
[['abortion', 0, [131]],
['abortion<b> laws 2019</b>', 0, [131]],
['abortion<b> pill</b>', 0],
['abortion<b> law</b>', 0, [131]],
['abortion<b> statistics</b>', 0, [131]],
['abortion<b> definition</b>', 0, [131]],
['abortion<b> clinic</b>', 0, [131]],
['abortion<b> protest day</b>', 0, [131]],
['abortion<b> facts</b>', 0, [131]],
['abortion<b> movie</b>', 0]],
{'q': 'VNgAJ8HR9ujuw-N-maKAjD15MEM', 't': {'bpc': False, 'tlw': False}}],
'suggests': ['abortion',
'abortion laws 2019',
'abortion pill',
'abortion law',
'abortion statistics',
'abortion definition',
'abortion clinic',
'abortion protest day',
'abortion facts',
'abortion movie'],
'self_loops': [0],
'tags': {'q': 'VNgAJ8HR9ujuw-N-maKAjD15MEM',
't': {'bpc': False, 'tlw': False}},
'crawl_id': '',
'depth': 0,
'root': 'abortion'}
Converting to edge list
In [3]: edges = suggests.to_edgelist(tree)
In [4]: edges.head()
Out[4]:
root edge source target \
0 abortion (abortion, abortion laws 2019) abortion abortion laws 2019
1 abortion (abortion, abortion pill) abortion abortion pill
2 abortion (abortion, abortion law) abortion abortion law
3 abortion (abortion, abortion statistics) abortion abortion statistics
4 abortion (abortion, abortion definition) abortion abortion definition
rank depth search_engine datetime
0 1 0 google 2019-05-21 14:10:31.188217
1 2 0 google 2019-05-21 14:10:31.188217
2 3 0 google 2019-05-21 14:10:31.188217
3 4 0 google 2019-05-21 14:10:31.188217
4 5 0 google 2019-05-21 14:10:31.188217
Extract association network
Reduce to new information obtained in suggestions. E.g. abortion -> abortion laws 2019 becomes abortion -> laws 2019.
In [5]: edges = suggests.add_parent_nodes(edges)
In [6]: edges = suggests.add_metanodes(edges)
In [7]: show_cols = ['source','target','grandparent','parent','source_add','target_add']
In [8]: edges[show_cols].head()
Out[9]:
source target grandparent parent source_add target_add
0 abortion abortion laws 2019 NaN NaN abortion laws 2019
1 abortion abortion pill NaN NaN abortion pill
2 abortion abortion law NaN NaN abortion law
3 abortion abortion statistics NaN NaN abortion statistics
4 abortion abortion definition NaN NaN abortion definition
5 abortion abortion clinic NaN NaN abortion clinic
6 abortion abortion protest day NaN NaN abortion protest day
7 abortion abortion facts NaN NaN abortion facts
8 abortion abortion movie NaN NaN abortion movie
9 abortion laws 2019 abortion laws 2019 georgia NaN abortion laws 2019 georgia
Plotted in Gephi from an older dataset that is no longer available. The size of nodes corresponds to their PageRank, and node colors indicate communities that were determined using Gephi's default community detection algorithm, the Louvain method:
The same network can be generated programmatically with plot_network(), using the test fixture dataset (tests/fixtures/abortion-20260312-122801-edges.csv). The suggests-plot command (requires the viz extra: uv add "suggests[viz]") wraps plot_network() for any edge-list CSV; the image above was produced with:
uv run suggests-plot \
--edges tests/fixtures/abortion-20260312-122801-edges.csv \
--root abortion --label-quantile 0.98 --label-alpha 0.7 --spacing 2.0 \
--save-to img/abortion_plot_pagerank_python.png
Nodes represent unique search suggestions, and directed edges connect each suggestion to the suggestions it produced. Node sizes are proportional to squared degree (emphasizing highly connected hubs), and colors indicate communities detected using the Louvain method. Only nodes above the 98th percentile of PageRank are labeled, with font sizes scaled by degree. Layout uses igraph's Fruchterman-Reingold algorithm:
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file suggests-0.4.2.tar.gz.
File metadata
- Download URL: suggests-0.4.2.tar.gz
- Upload date:
- Size: 14.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c90047105e0d945b1e7eff97c7637f164420118475823b220578c25ab99d905e
|
|
| MD5 |
372533011f3e15354be74beb88559b61
|
|
| BLAKE2b-256 |
37c5ceb48579e29b97e2c5f5d7999e405dd61940cf687374b8b2cc94b6236d80
|
Provenance
The following attestation bundles were made for suggests-0.4.2.tar.gz:
Publisher:
publish.yml on gitronald/suggests
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
suggests-0.4.2.tar.gz -
Subject digest:
c90047105e0d945b1e7eff97c7637f164420118475823b220578c25ab99d905e - Sigstore transparency entry: 2256454616
- Sigstore integration time:
-
Permalink:
gitronald/suggests@c2899a132a79bb3e144bdf72ccff64609dfa652d -
Branch / Tag:
refs/tags/v0.4.2 - Owner: https://github.com/gitronald
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c2899a132a79bb3e144bdf72ccff64609dfa652d -
Trigger Event:
push
-
Statement type:
File details
Details for the file suggests-0.4.2-py3-none-any.whl.
File metadata
- Download URL: suggests-0.4.2-py3-none-any.whl
- Upload date:
- Size: 17.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f0d0c00211d67848fa78e2b54e37dae630f7df50a94c0670131e85dec9d0f7ab
|
|
| MD5 |
6b570f67732cf59e19a614d6071a43f0
|
|
| BLAKE2b-256 |
91e4ddac1378d54a23c2233d28cc13874143a63ca69c4be20347b82ee77f1ebd
|
Provenance
The following attestation bundles were made for suggests-0.4.2-py3-none-any.whl:
Publisher:
publish.yml on gitronald/suggests
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
suggests-0.4.2-py3-none-any.whl -
Subject digest:
f0d0c00211d67848fa78e2b54e37dae630f7df50a94c0670131e85dec9d0f7ab - Sigstore transparency entry: 2256454634
- Sigstore integration time:
-
Permalink:
gitronald/suggests@c2899a132a79bb3e144bdf72ccff64609dfa652d -
Branch / Tag:
refs/tags/v0.4.2 - Owner: https://github.com/gitronald
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@c2899a132a79bb3e144bdf72ccff64609dfa652d -
Trigger Event:
push
-
Statement type: