Skip to main content
POST
Sweep a cut over a run's answers

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer <key>. Each operation lists the scope its key needs: decisions:evaluate (evaluate and read evaluations), decisions:feedback (your app's feedback) or decisions:develop (everything else, including owner feedback and the review queue). An operation listing no scope takes any scoped key. A key with no scope, or without the operation's, gets 403 INSUFFICIENT_SCOPE.

Path Parameters

decision_id
string
required
Pattern: ^[a-z][a-z0-9_.-]{0,127}$

Body

application/json
run_ids
string[]
required

Runs of one structure, from evaluate with items or cases, as a loss_report side takes them.

Required array length: 1 - 50 elements
Pattern: ^evr_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
aggregation
string
required

The bands aggregation whose cut to sweep: its name, as near_cuts gives it, or its path (aggregations.<name>).

Required string length: 1 - 200
at
number

The cut to sweep, by its current at. Without it, every cut of the aggregation, one at a time.

Response

The sweep

environment
enum<string>
required

The environment of the key that made the call: production or test. Evaluations, feedback, reviews and suggestions are separate per environment; registered structures are shared.

Available options:
production,
test
decision_id
string
required
Pattern: ^[a-z][a-z0-9_.-]{0,127}$
structure_hash
string
required
Pattern: ^sha256:[0-9a-f]{64}$
aggregation
string
required

The bands aggregation swept.

Pattern: ^[a-z][a-z0-9_]{0,63}$
objective
object
required

What this run scored with.

n
integer
required

Cases scored, as loss_report counts them.

Required range: x >= 0
excluded
object
required

Items left out, as loss_report leaves them out.

cuts
object[]
required

One per cut swept, in the aggregation's order; each moves alone.