sdkDeterministic

Run icp canary gate

pipeline.runIcpCanaryGate

Run the canary quality gate for a brief after ICP scoring a sample. Computes the shared list-quality scorecard, persists latestScorecard, and returns pass/fail evidence so Scout can scale, pause, or ask for another ICP tuning round.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

briefIdrequired

string

Campaign brief id.

requireIcpScoredRows

boolean

Default true. When true, returns a reason instead of scoring unscored rows.

Example

TypeScripttypescript

await pipeline.runIcpCanaryGate({
  "briefId": "00000000-0000-4000-8000-000000000000"
})

Response

The operation is available, but its typed response schema has not been published yet.

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.