Skip to content

Developers

RecSys is an auditable recommendation system suite with deterministic ranking and versioned ship/rollback.

Who this is for

  • Developers / platform engineers integrating the suite
  • Application engineers wiring one recommendation surface end-to-end
  • Recommendation engineers validating ranking changes

What you will get

  • The fastest path to a runnable local setup
  • A minimal “first integration” checklist (one surface + logging + first eval report)
  • Links to the canonical API, contracts, and on-call runbooks

Key terms

  • Tenant: a configuration + data isolation boundary (usually one organization).
  • Surface: where recommendations are shown (home, PDP, cart, ...).
  • Request ID: the join key that ties together responses, exposures, and outcomes.
  • Exposure log: what was shown (audit trail + evaluation input).

Quick paths

Follow this path in order:

  1. Get a non-empty recommendation response + one exposure log:
  2. Quickstart (minimal, ~10 minutes)
  3. Integrate one surface in your app (for example: home_feed):
  4. How-to: integrate recsys-service into an application
  5. How-to: Integration checklist (one surface)
  6. Emit exposure logs and outcome logs with the same request_id:
  7. Data contracts
  8. Exposure logging and attribution
  9. Produce your first report and make a ship/hold decision:
  10. How-to: run evaluation and make ship decisions
  11. Do one rollback drill (so you trust the lever before you need it):
  12. Operational reliability and rollback

Integration checklist

Use the canonical checklist (with anchors you can share in PRs/issues):

Quick sanity check:

  • request_id is stable across exposure + outcome logs
  • join-rate is not near-zero
  • at least one KPI and one guardrail metric exists

Need guided help?