API#

class API#

Backend API.

Parameters
sessionhttpx.Client

The HTTP session object

__init__(session: Client)#
__new__(*args, **kwargs)#

Attributes

API.session

API.original_host

Methods

API.create_alert_rule(monitor_id, alert_rule)

Create alert rule.

API.create_alert_webhook(name, https_url, ...)

Create alert webhook.

API.create_checks(model_id, checks[, ...])

Create checks.

API.create_model(model[, raise_on_status])

Create model.

API.create_model_notes(model_id, notes[, ...])

Create model notes.

API.create_model_version(model_id, model_version)

Create model version.

API.create_monitor(check_id, monitor[, ...])

Create monitor.

API.create_pager_duty_alert_webhook(name, ...)

Create alert webhook.

API.delete_check_by_name()

API.delete_model_by_id(model_id[, ...])

Delete model by its numerical identifier.

API.delete_model_by_name(model_name[, ...])

Delete model by its name.

API.delete_model_checks_by_name(model_id, ...)

Delete model checks by their names.

API.delete_model_note(note_id[, raise_on_status])

Delete model note.

API.delete_model_version_by_id(model_version_id)

Delete a model by version ID.

API.delete_model_version_by_name(model_name, ...)

Delete a model by version ID.

API.fetch_alert_rule(alert_rule_id[, ...])

Create alert rule.

API.fetch_all_model_checks_by_id(model_id[, ...])

Fetch all model checks.

API.fetch_all_model_checks_by_name(model_name)

Fetch all model checks.

API.fetch_all_model_versions(model_id[, ...])

Fetch model versions.

API.fetch_dashboard([raise_on_status])

Fetch dashboard.

API.fetch_model_by_id(model_id[, ...])

Fetch model record by its numerical identifier.

API.fetch_model_by_name(model_name[, ...])

Fetch model record by its name.

API.fetch_model_notes(model_id[, ...])

Fetch list of model notes.

API.fetch_model_version(model_version_id[, ...])

Fetch the model version.

API.fetch_model_version_by_id(model_version_id)

Fetch the model version by its ID.

API.fetch_model_version_by_name(model_name, ...)

Fetch the model version by its name.

API.fetch_model_version_schema(model_version_id)

Fetch model version schema.

API.fetch_model_version_time_window_statistics(...)

Fetch model version time window statistics.

API.fetch_monitor(monitor_id[, raise_on_status])

Create monitor.

API.get_model_version_production_data(...[, ...])

Get production data for a model version on a specific window.

API.get_model_version_reference_data(...[, ...])

Get reference data for a model version.

API.get_samples_count(model_version_id[, ...])

Get the amount of samples uploaded.

API.instantiate(host[, token])

Create instance of API.

API.log_labels(model_id, data[, raise_on_status])

Update production samples.

API.retrieve_backend_version()

Return current active backend version.

API.say_hello([raise_on_status])

Verify connectivity.

API.set_schedule_time(model_id, timestamp[, ...])

Set new scheduling time for all monitors of a model.

API.update_model_version(model_version_id, data)

Update model version.

API.upload_reference(model_version_id, reference)

Upload reference data.

API.upload_samples(model_version_id, samples)

Upload production samples.