Writing plugins

How to extend Quivr with your own plugins, for example a new file format or a new kind of alert rule.

Understand how it works

Plugin Protocol v0: the plugin manifest, routes, schemas and fixtures
alerts: the first-party keyword alert plugin
X list connector plugin (x-list): the first-party X list connector plugin and its parity tests

Run a connector plugin: pin a connector plugin and read the health it reports
Write a normalizer: from quivr plugin init to a searchable, observable Record
Write a retrieval plugin: decide how search results are found and ranked, under named profiles
Write an ingestion plugin: decide how articles are cut and embedded, and move a Corpus onto it
pdf-text: the reference PDF normalizer, one Part per page
RSS and Atom connector plugin: the first-party RSS and Atom connector plugin
Quivr Plugin SDK for Go: write, test and certify a source collector or an ingestion plugin in Go
Quivr Plugin SDK for Python: write, test and run a Python normalizer