Tags¶
Use tags to browse the docs by role and topic.
alternatives¶
api¶
- Admin API
- Auth and tenancy
- Compatibility policy
- Errors
- Examples
- Integrate recsys-service
- OpenAPI / Swagger UI
- Recommend request fields
architecture¶
artifact-mode¶
artifacts¶
- Artifacts and manifest lifecycle
- Data modes
- Operate pipelines
- Production-like run (artifact/manifest)
- Roll back artifacts safely
- Stale manifest
- recsys-pipelines docs
backfill¶
benchmark¶
benchmarks¶
build-vs-buy¶
business¶
- Alternatives & build vs buy
- Benchmarks & methodology
- Business representative
- Buyer guide
- Buyer journey (5 minutes)
- Capability matrix
- Commercial license
- Commercial procurement artifacts
- Commercial use
- Customer onboarding checklist
- DPA and SCC terms
- Decision playbook (ship/hold/rollback)
- Decision readiness matrix
- Docs map
- Evaluation license
- Evaluation reasoning and pitfalls
- Evidence
- Executive summary
- Experimentation model
- FAQ
- For businesses (buyers and stakeholders)
- Home
- How it works
- Interpretation cheat sheet
- Known limitations
- Licensing
- Minimum pilot setup (one surface)
- Online A/B in production
- Operational reliability & rollback
- Order form
- Pilot plan
- Pricing
- Pricing definitions
- Procurement checklist
- Procurement pack
- ROI and risk model
- Responsibilities (RACI)
- Run eval and make ship decisions
- SLA and support schedule
- Security pack
- Security posture snapshot
- Security, privacy, compliance
- Self-serve procurement
- Start an evaluation
- Start here
- Subprocessors and distribution details
- Success metrics
- TCO & effort
- Trust center
- Use cases
- Value model (ROI)
- What is RecSys?
checklist¶
- Customer onboarding checklist
- Evaluation checklist (recommendation engineer)
- Production readiness checklist
cli¶
commercial¶
compatibility¶
components¶
config¶
- Configuration reference
- Rollback config rules
- Surface namespaces
- recsys-eval
- recsys-pipelines
- recsys-service
contributing¶
customization¶
data-contracts¶
- Events (eval)
- Exposure/outcome/assignment schemas
- Field catalog
- Join logic
- Overview
- Verify joinability
database¶
datasets¶
db-only¶
decision¶
deployment¶
determinism¶
developer¶
- Add a signal end-to-end
- Admin API
- Artifacts and manifest lifecycle
- Auth and tenancy
- CLI reference
- Candidate vs ranking
- Capability matrix
- Cold start strategies
- Components
- Configuration reference
- Cookbook: integrate with a content feed
- Cookbook: integrate with a webshop
- Cookbook: integrate with an event bus (streaming)
- DB-only seeding
- Data modes
- Developer
- Developer
- Developers
- Docs map
- Evaluation reasoning and pitfalls
- Events (eval)
- Examples
- Exposure logging & attribution
- FAQ
- Field catalog
- Home
- How it works
- How-to guides
- Integrate recsys-service
- Integration checklist
- Integration cookbooks
- Integration spec
- Local end-to-end (20–30 minutes)
- Minimal integration (one surface)
- Minimal pilot (DB-only)
- Minimum components by goal
- Minimum instrumentation spec
- Minimum pilot setup (one surface)
- OpenAPI / Swagger UI
- Overview
- Quickstart (full validation)
- Quickstart (minimal)
- Recommend request fields
- Reference
- Repo layout
- Schema
- Start an evaluation
- Start here
- Start here
- Suite architecture
- Surface namespaces
- Troubleshooting for integrators
- Tutorials
- Verify determinism
- recsys-eval
- recsys-eval
- recsys-pipelines
- recsys-pipelines
- recsys-service
docs¶
- Canonical content map
- Contribute to docs
- Docs per release policy
- Docs style guide
- Docs templates
- Docs versioning
- Docs: enterprise feel baseline
- Documentation quality gates
- Linking and naming style reference
- Persona journey tests and scoring rubric
- Run docs locally
- Style guide
- Ttechnical writer / documentation lead
ethics¶
evaluation¶
- Decision playbook (ship/hold/rollback)
- Evaluation checklist (recommendation engineer)
- Evaluation license
- Evaluation modes
- Evaluation reasoning and pitfalls
- Evaluation validity
- Events (eval)
- Evidence
- Experimentation model
- Exposure logging & attribution
- Exposure/outcome/assignment schemas
- Failure modes & diagnostics
- Field catalog
- Integration checklist
- Integration spec
- Interpretation cheat sheet
- Interpreting metrics and reports
- Known limitations
- Limitations and risks
- Minimum instrumentation spec
- Offline gate in CI
- Online A/B in production
- Overview
- Pilot plan
- ROI and risk model
- RecSys engineering hub
- Recommendation systems expert
- Run eval and make ship decisions
- Start an evaluation
- Success metrics
- Tune ranking safely
- Validate logging and joinability
- Verify joinability
- recsys-eval docs
executive-summary¶
experimentation¶
explanation¶
- Artifacts and manifest lifecycle
- Candidate vs ranking
- Capability matrix
- Cold start strategies
- Customization map
- Data modes
- Ethics & fairness
- Evaluation modes
- Evaluation reasoning and pitfalls
- Evaluation validity
- Experimentation model
- Explanation
- Exposure logging & attribution
- Guarantees & non-goals
- How it works
- Pipelines operational invariants
- Suite Context
- Suite architecture
- Surface namespaces
- Ttechnical writer / documentation lead
- recsys-algo
fairness¶
glossary¶
governance¶
how-to¶
- Add a signal end-to-end
- Backfill safely
- Cookbook: integrate with a content feed
- Cookbook: integrate with a webshop
- Cookbook: integrate with an event bus (streaming)
- Decision playbook (ship/hold/rollback)
- Deploy with Helm
- How-to guides
- Integrate recsys-service
- Integration checklist
- Integration cookbooks
- Minimal integration (one surface)
- Minimum pilot setup (one surface)
- Offline gate in CI
- Online A/B in production
- Operate pipelines
- Operate pipelines daily
- Roll back artifacts safely
- Run eval and make ship decisions
- Troubleshooting for integrators
ia¶
instrumentation¶
integration¶
- Cookbook: integrate with a content feed
- Cookbook: integrate with a webshop
- Cookbook: integrate with an event bus (streaming)
- Customization map
- Developer
- Developer
- Integrate recsys-service
- Integration
- Integration checklist
- Integration cookbooks
- Integration spec
- Minimal integration (one surface)
- Troubleshooting for integrators
interpretation¶
joinability¶
legal¶
licensing¶
- Buyer guide
- Commercial license
- Commercial use
- Decision readiness matrix
- Evaluation license
- Licenses readme
- Licensing
- Order form
- Pricing
- Pricing definitions
- Procurement checklist
- Self-serve procurement
limitations¶
links¶
logging¶
metrics¶
ml¶
- Candidate vs ranking
- Capability matrix
- Cold start strategies
- Evaluation checklist (recommendation engineer)
- Evaluation reasoning and pitfalls
- Experimentation model
- Home
- RecSys engineering hub
- Recommendation systems expert
- Run eval and make ship decisions
- recsys-eval
operations¶
ops¶
- Admin API
- Artifacts and manifest lifecycle
- Backfill safely
- Baseline benchmarks
- CLI reference
- Components
- Cookbook: integrate with an event bus (streaming)
- Customer onboarding checklist
- Data modes
- Database migration issues
- Database reference
- Deploy with Helm
- Empty recs
- Exposure logging & attribution
- Failure modes & diagnostics
- Home
- How it works
- How to reproduce the baseline benchmarks
- How-to guides
- Migrations
- Minimum components by goal
- Offline gate in CI
- Operate pipelines
- Operate pipelines daily
- Operational reliability & rollback
- Performance & capacity
- Pipelines operational invariants
- Production readiness checklist
- Production-like run (artifact/manifest)
- Responsibilities (RACI)
- Roll back artifacts safely
- Rollback config rules
- SRE / on-call
- Schema
- Security, privacy, compliance
- Service not ready
- Stale manifest
- Start here
- Trust center
- recsys-eval
- recsys-pipelines
- recsys-pipelines
- recsys-service
overview¶
- Buyer guide
- Buyer journey (5 minutes)
- Capability matrix
- Components
- Developers
- Docs map
- Evidence
- Explanation
- FAQ
- For businesses (buyers and stakeholders)
- Home
- How-to guides
- Known limitations
- Licensing
- Minimum components by goal
- Operational reliability & rollback
- Overview
- Pricing
- Procurement pack
- Project
- ROI and risk model
- SRE / on-call
- Start an evaluation
- Start here
- Success metrics
- Suite Context
- Suite architecture
- Trust center
- Tutorials
- Use cases
- Value model (ROI)
- What is RecSys?
- What’s new
performance¶
- Baseline benchmarks
- Benchmarks & methodology
- How to reproduce the baseline benchmarks
- Performance & capacity
persona¶
- Business representative
- Developer
- Developer
- Recommendation systems expert
- Ttechnical writer / documentation lead
personas¶
pilot¶
pipelines¶
planning¶
platform¶
pricing¶
privacy¶
procurement¶
- Business representative
- Commercial procurement artifacts
- DPA and SCC terms
- Decision readiness matrix
- Executive summary
- Procurement checklist
- Security posture snapshot
- Self-serve procurement
- Subprocessors and distribution details
project¶
- Canonical content map
- Code of conduct
- Contributing
- Docs per release policy
- Docs style guide
- Docs templates
- Docs versioning
- Glossary
- Governance
- Licenses readme
- Message map
- Project
- Repo layout
- Security policy
- Support model
- What’s new
quality¶
quickstart¶
- Customer onboarding checklist
- Developers
- Docs map
- FAQ
- Local end-to-end (20–30 minutes)
- Minimal pilot (DB-only)
- Minimum components by goal
- Pilot plan
- Quickstart (full validation)
- Quickstart (minimal)
- Start here
ranking¶
recsys¶
recsys-algo¶
- Candidate vs ranking
- Cold start strategies
- Concepts
- Examples
- Ranking reference
- Releases
- Scoring model spec
- Store ports
- Tune ranking safely
- Verify determinism
- recsys-algo
recsys-engineering¶
- Add a signal end-to-end
- Evaluation checklist (recommendation engineer)
- RecSys engineering hub
- Scoring model spec
recsys-eval¶
- Architecture
- CI gates
- Concepts
- Data contracts
- Decision playbook (ship/hold/rollback)
- Default evaluation pack
- Evaluation validity
- Events (eval)
- Experimentation model
- Exposure logging & attribution
- Integration
- Interleaving
- Interpretation cheat sheet
- Interpreting results
- Local end-to-end (20–30 minutes)
- Metrics
- OPE
- Offline gate in CI
- Online A/B in production
- Overview
- Roadmap
- Run eval and make ship decisions
- Runbooks
- Scaling
- Security & privacy
- Style guide
- Troubleshooting
- recsys-eval
- recsys-eval
- recsys-eval docs
recsys-pipelines¶
- ADR-XXXX: title
- Add artifact type
- Add event field
- Architecture
- Architecture Decision Records (ADR)
- Artifact schema
- Artifacts and manifest lifecycle
- Artifacts and versioning
- Backfill safely
- CLI
- Config
- Data engineer
- Data lifecycle
- Debug failures
- Dev workflow
- Documentation approach
- Engineer
- Event schema
- Exit codes
- Glossary
- Job-per-container mode
- Limit exceeded
- Local end-to-end (20–30 minutes)
- Local quickstart
- Operate pipelines
- Operate pipelines daily
- Output layout
- Overview
- Pipeline failed
- Pipelines operational invariants
- Product / stakeholders
- Production-like run (artifact/manifest)
- Releasing
- Roll back artifacts safely
- Roll back the manifest
- Run a backfill
- Run incremental
- SLOs and freshness
- SRE / on-call
- Schedule pipelines
- Stale artifacts
- Start here
- Style guide
- Validation and guardrails
- Validation failed
- Windows and backfills
- recsys-pipelines
- recsys-pipelines
- recsys-pipelines docs
recsys-service¶
- Admin API
- Artifacts and manifest lifecycle
- Auth and tenancy
- Cookbook: integrate with a content feed
- Cookbook: integrate with a webshop
- Cookbook: integrate with an event bus (streaming)
- DB-only seeding
- Database migration issues
- Deploy with Helm
- Empty recs
- Examples
- Exposure logging & attribution
- Integrate recsys-service
- Integration cookbooks
- Integration spec
- Local end-to-end (20–30 minutes)
- Migrations
- Minimal pilot (DB-only)
- OpenAPI / Swagger UI
- Production-like run (artifact/manifest)
- Quickstart (full validation)
- Quickstart (minimal)
- Recommend request fields
- Rollback config rules
- Schema
- Service not ready
- Stale manifest
- Surface namespaces
- recsys-service
reference¶
- Admin API
- Auth and tenancy
- CLI reference
- Compatibility policy
- Configuration reference
- DB-only seeding
- Database reference
- Datasets
- Documentation quality gates
- Errors
- Events (eval)
- Examples
- Exposure/outcome/assignment schemas
- Field catalog
- Glossary
- Glossary
- Integration spec
- Interpretation cheat sheet
- Join logic
- Migrations
- Minimal integration (one surface)
- Minimum instrumentation spec
- OpenAPI / Swagger UI
- Overview
- Recommend request fields
- Reference
- Repo layout
- Schema
- Scoring model spec
- Security pack
- Style guide
- recsys-eval
- recsys-eval
- recsys-pipelines
- recsys-pipelines
- recsys-service
release¶
risk¶
rollback¶
runbook¶
- Database migration issues
- Empty recs
- Limit exceeded
- Pipeline failed
- Rollback config rules
- Runbooks
- Service not ready
- Stale artifacts
- Stale manifest
- Validation failed
scope¶
scoring¶
security¶
- Auth and tenancy
- Commercial procurement artifacts
- DPA and SCC terms
- Integration checklist
- Limitations and risks
- Procurement checklist
- Procurement pack
- Production readiness checklist
- SLA and support schedule
- Security & privacy
- Security pack
- Security policy
- Security posture snapshot
- Security, privacy, compliance
- Subprocessors and distribution details
- Trust center
serving¶
sla¶
start-here¶
style¶
support¶
tco¶
templates¶
troubleshooting¶
trust¶
tuning¶
tutorial¶
- Datasets
- Local end-to-end (20–30 minutes)
- Minimal pilot (DB-only)
- Production-like run (artifact/manifest)
- Quickstart (full validation)
- Quickstart (minimal)
- Tiny dataset
- Verify determinism
- Verify joinability
tutorials¶
versioning¶
workflows¶
Read next¶
- Start here: Start here
- Quickstart (10 minutes): Quickstart (10 minutes)