Feedback

Submit Enrich Ground Truth

Submit ground-truth re-ranking for an enrich event.

An enrich output ranks candidates per enriched field, each candidate carrying a stable id. This endpoint records the client's own ranking of those candidates (by id) as ground truth, for later ranking-quality metrics.

Per field, rankings gives each candidate a 1-based rank (lower = better); ties and gaps are allowed, and candidates left out are treated as unranked. Every id must appear in that field's enrich output. Re-submitting overwrites.

Non-enrich events return 400, matching POST /v3/events/{eventID}/feedback, which reports an unsupported function type the same way. A body that is structurally invalid (missing path, empty rankings, rank < 1, duplicate ids) also returns 400; a body that is well-formed but does not match the output (unknown field path, unknown candidate id) returns 422.

post/v3/events/{eventID}/enrich-feedback

Path parameters

eventIDstring required

The unique identifier of the enrich event.

Request body

Response

The request has succeeded.

eventIDstring required

The event the ground truth was recorded against.

functionTypestring required

Always enrich.

createdAtstring date-time required

When the ground truth was written.

Changes

Changed in 1 of the 42 revisions of this API.1