Evaluations

Choose your language:

Evaluations run Mankinds tests against a system.

client.evaluations.run(params)

Start an evaluation run.

SDK	client.evaluations.run(params, idempotency_key=None)
Returns	EvaluationRun

Parameters:

Location	Parameter	Type	Required	Default	Description
Body	system_id	string	Required	—	System UUID.
Body	profile	string	Optional	—	Evaluation profile.
Body	connection_id	string	Optional	—	Connection UUID. Uses the system default when omitted.
Body	mode	string	Optional	offline	Evaluation mode.
Body	thematics_config	dict	Optional	—	Offline criteria/thematics configuration.
Body	online_thematics_config	dict	Optional	—	Online criteria/thematics configuration.
Body	sampling	dict	Optional	—	Sampling configuration.
Body	time_range	dict	Optional	—	Time range for online/mixed evaluations.
Body	connector_refs	dict	Optional	—	External connector references. Defaults to an empty object.
SDK option	idempotency_key	string	Optional	—	Sent as the Idempotency-Key header.

The response includes evaluation_id, status, task_id, job and message. Use evaluation_id with client.evaluations.get(...) or client.evaluations.wait(...).

client.evaluations.list(filters)

List evaluations for the organization or for one system.

SDK	client.evaluations.list(filters=None)
Returns	Evaluation[]

Parameters:

Location	Parameter	Type	Required	Default	Description
Query	system_id	string	Optional	—	Restrict results to one system.
Query	limit	integer	Optional	—	Maximum number of evaluations. Minimum 1, maximum 200.
Query	offset	integer	Optional	0	Pagination offset.

client.evaluations.get(evaluationId)

Read one evaluation.

SDK	client.evaluations.get(evaluation_id)
Returns	Evaluation

Parameters:

Location	Parameter	Type	Required	Description
Path	evaluation_id	string	Required	Evaluation UUID.

client.evaluations.cancel(evaluationId)

Cancel a running evaluation.

SDK	client.evaluations.cancel(evaluation_id)
Returns	StatusResponse

Parameters:

Location	Parameter	Type	Required	Description
Path	evaluation_id	string	Required	Evaluation UUID.

client.evaluations.wait(evaluationId, options)

SDK helper that polls client.evaluations.get(...) until the evaluation reaches a terminal state.

SDK	client.evaluations.wait(evaluation_id, timeout_ms=..., interval_ms=..., on_poll=None)
Returns	Evaluation

Parameters:

Location	Parameter	Type	Required	Default	Description
SDK	evaluation_id	string	Required	—	Evaluation UUID.
SDK	timeout_ms	integer	Optional	1800000	Maximum wait time in milliseconds.
SDK	interval_ms	integer	Optional	5000	Poll interval in milliseconds.
SDK	on_poll	callable	Optional	—	Callback called with each evaluation payload.

Raises PollTimeoutError on timeout and JobFailedError if the terminal status is failed, canceled or timed out.