Skip to main content
For the complete documentation index for agents and LLMs, see llms.txt.

Test a Revision Before It Goes LiveBeta

Beta
This is coming — this page describes a feature that's still being rolled out and may not be available to you yet.

Keep a weaker pipeline version away from your callers by adding a Deployment Gate to the service. The gate tests every new revision before it starts serving: it runs your test cases through the revision and compares the score with the bar you set. If the revision falls short, it stays out of production and the current revision keeps answering. If you've used release gates in a CI/CD workflow, this is the same idea built into the service. To learn how gates and checks work, see Deployment Gates.

Prerequisites​

Add or Edit a Gate​

  1. In Haystack Enterprise Platform, click Gateway in the navigation and open the service, then click the Settings tab.
  2. In the Deployment Gate section, click Add gate. If the service already has a gate, click Edit gate instead.
  3. In the first check, select the Metric Group.
  4. Select the Dataset to replay. You can pick a Dataset only after you pick a Group.
  5. Under the pass criteria, choose the comparison, then enter the threshold and the minimum coverage.
  6. Optional: To add more checks, click Add check and fill in each one.
  7. Click Save gate.

The Deployment Gate section now lists the gate's checks. From there you can edit the gate again or remove it. To remove the gate, click Remove gate and confirm. New revisions then go live without being checked.

A check can go out of date. If the Metric Group changed since you saved the gate, for example its weights changed or a weighted Evaluator has a new latest version, the check says so. To score future revisions against the current Group, click Update to current on that check.

If saving fails, the error appears on the field that caused it. A common cause is a Metric Group without weights: open the Group, set its weights, and save the gate again.

What To Do Next​