API reference · Account
A shadow test's report, from the dashboard
GET/api/account/shadow/{id}/{action}Signed in session
action is report. A 404 at every path while the operator has not turned shadow testing on.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | |
| action (path)required | string | One of "report", "switch", "revert", "stop", "auto". |
Answer 200
The report.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| object | "shadow.report" | |
| model | string | |
| status | string | |
| threshold | number | |
| min_samples | integer | |
| confidence | number | |
| candidates | array of object | |
| candidates[] | string | |
| candidates[] | boolean | |
| candidates[] | object | |
| candidates[] | integer | |
| candidates[] | integer | |
| candidates[] | integer | |
| candidates[] | integer | |
| candidates[] | object | |
| candidates[] | string | |
| candidates[] | integer | The sample count. |
| candidates[] | integer | |
| candidates[] | number or null | |
| candidates[] | object or null | The 95% Wilson score interval; null with nothing compared. |
| candidates[] | number | |
| candidates[] | number | |
| candidates[] | number or null | The suite method: the original model's pass rate on the suite. |
| candidates[] | boolean | |
| candidates[] | integer or null | |
| candidates[] | object | |
| candidates[] | integer | What the replays were billed. |
| candidates[] | integer | What the same requests were billed on the original. |
| candidates[] | number or null | |
| candidates[] | integer | Embeddings or the judge, billed. |
| candidates[] | object | |
| candidates[] | integer or null | |
| candidates[] | integer or null | |
| candidates[] | object | |
| candidates[] | integer or null | |
| candidates[] | integer or null | |
| candidates[] | array of object | |
| candidates[] | boolean |
Errors
- 401OpenAI shaped error.
- 404OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.