Admin

Request backfill

Reprocess a Corpus's past Versions with a selected active ingestion plugin, to fill vector spaces of the generation the Corpus is routed to, typically a new evaluation space. The scope is the Corpus and, optionally, a window on when Quivr accepted its Versions. Only Versions segmented by the selected plugin whose segments all hold a vector in the served space and miss one in a target space are processed; live enrichment fills the target spaces for newer Versions once the backfill has started. A dry run is required. dry_run true answers 200 with the estimate and records it under the idempotency key. The same body with dry_run false then accepts the backfill as a queued Operation (202, Location). Without a dry run recorded under that key and scope, the answer is 409 dry_run_required. An estimated cost above the deployment's backfill.max_cost_without_confirmation needs confirm_cost true, otherwise 409 cost_confirmation_required. The same key with another scope is 409 idempotency_conflict, and an accepted key replays its Operation. A Corpus whose previous backfill has not finished is 409 backfill_in_progress. The backfill runs on its own task queue at the deployment's backfill.rate, pinned to the Pipeline Plan active when it starts. It can be paused, resumed and canceled, and resumes from its checkpoint after a restart. It never creates Record Versions or content events. Versions whose projected segments the plugin would cut differently are skipped and counted (segmentation_differs), and a rebuild re-segments them. Requires plugins:admin, on a key of the Corpus's Organization that grants the Corpus.

post/v0/admin/backfills

Request

  • Base URL
    https://docs.quivr.thevibecompany.co (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

idempotency_keystring required
corpus_idstring required
accepted_afterstring date-time

Only Versions Quivr accepted at or after this time; absent, from the first.

accepted_beforestring date-time

Only Versions Quivr accepted before this time; absent, up to now.

registration_idstring

The ingestion plugin registration to run; absent, the active plan's default. Any ingestion member of the active plan is accepted; a registration outside it is 409 registration_not_active.

spacesstring[]

The vector spaces to fill, which the plugin declares and the deployment serves or evaluates; absent, the deployment's evaluation spaces the plugin owns.

dry_runboolean required

true reports the estimate and records it; false starts the backfill a dry run with the same key and scope preceded.

confirm_costboolean

Accept an estimated cost above the deployment's backfill.max_cost_without_confirmation.

Response

The dry run's estimate, recorded under the key.

registration_idstring required
spacesstring[] required
versionsinteger required

Versions in scope that miss a vector in a target space.

segmentsinteger required

Their segments, which the plugin embeds.

input_tokensinteger required

Estimated tokens the plugin embeds, one per four code points of segment text.

estimated_secondsnumber double required

How long the backfill should take, at the deployment's backfill.rate or the recent throughput, whichever is slower.

duration_basis'rate' | 'recent_backfills' | 'recent_plugin_calls' required

What the duration comes from.

estimated_cost_usdnumber double

Estimated cost in US dollars, rounded up to the cent, of the target spaces that declare an input_price in the plugin manifest; a space without one adds nothing. Absent when none declares one, so the cost is unknown.

confirmation_requiredboolean required

The cost exceeds backfill.max_cost_without_confirmation, so starting the backfill needs confirm_cost.

Changes

No recorded changes to this operation across all 1 revision of this API.