Impulse

Set thresholds

Set thresholds (e.g. min. confidence rating, or min. anomaly score) for an impulse.

post/api/{projectId}/impulse/{impulseId}/set-thresholds

Request

Path parameters

projectIdinteger required

Project ID

impulseIdinteger required

Impulse ID

Request body

allowCreatingRegenerateModelTestingJobsboolean required

Whether a call to this function is allowed to create jobs to regenerate model testing results (e.g. object detection datasets, or large datasets). This option is here because further calls to setImpulseThresholds are blocked while model testing jobs are running (so e.g. live classification has this to FALSE).

forceRunRegenerateModelTestingInJobboolean

If set, this'll force the creation of a job to regenerate the model testing results.

Response

OK

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

hadModelTestingResultsboolean required

Whether there were model testing results available before calling this function.

regenerateModelTestingStatus'not_regenerated' | 'regenerated' | 'started_job' | 'requires_job' required

Altering thresholds invalidates model testing results. We try to regenerate the results where possible. You'll get either "not_regenerated" (e.g. no model testing results, or dataset does not support fast regeneration, like for object detection models); "regenerated" (regeneration successful); "started_job" (regenerate is possible, but requires a job, that was kicked off - e.g. for large test sets); "requires_job" (requires a job, but "allowCreatingRegenerateModelTestingJobs" was false - start a new job manually via regenerateModelTestingSummary). If a job was started then "regenerateModelTestingResultsJobId" is set.

regenerateModelTestingResultsJobIdinteger

If there previously were model testing results, and your dataset supports fast re-generation of model testing results (e.g. no object detection blocks), but your dataset is too big to re-generate results inline (e.g. >20K test set samples) - then a job is kicked off to regenerate the results. This field contains the job ID.

Changes

No recorded changes to this operation across all 1 revision of this API.