client wrapper to cloud data science API

accessible preferably through wizata_dsapi.api() using os variables, you can also create an instance using init() please contact your administrator to receive configuration and connection details

Attributes

Name	Type	Description
domain	str	URL of data science API
client_id	str	azure authentication - client id
client_secret	str	azure authentication - your client secret API key
scope	str	azure authentication - scope
tenant_id	str	azure authentication - tenant
protocol	str	default - https
username	str	azure authentication - deprecated - username
password	str	azure authentication - deprecated - password

Methods

abort()

send an abort request for executions and return a result message

Name	Type	Default	Description
executions	list		must be a list containing uuid or Execution.

access_check()

call the who am I request, to read proper headers and get specific information.

return: roles, twins

add_template_property()

add a property to an existing template.

Name	Type	Default	Description
template			template object, UUID or str key.
property_name	str		name of the property to add.
property_type	str	datapoint	VarType value as string (e.g. datapoint, string, float, integer, ...).
is_required	bool	True	whether the property is required on registration.
return: created TemplateProperty.

authenticate()

perform authentication on client side

await_execution()

wait for an execution to reach a terminal status (completed, failed or aborted).

Name	Type	Default	Description
execution	ExecutionLog		ExecutionLog returned by experiment() or run().
timeout	int	180	maximum seconds to wait before raising TimeoutError.
poll_interval	int	5	seconds between status checks.
return: ExecutionLog with terminal status. Raises TimeoutError if execution does not complete within timeout. Raises RuntimeError if execution finished with failed or aborted status.

batch_query()

query a dataframe from API in batches, splitting a large time range into smaller steps. Same parameters as query() with an additional step parameter.

Name	Type	Default	Description
step	timedelta		size of each batch as a timedelta (e.g. timedelta(days=1)).
datapoints	list	None	list of datapoints to fetch.
start	datetime	None	start datetime of range to fetch.
end	datetime	None	end datetime of range to fetch.
interval	int	None	interval in milliseconds.
agg_method	str	mean
template	str	None	template to fetch.
twin	str	None	hardware ID of twin to fetch based on template.
null	str	None	By default at 'drop' and dropping NaN values. If not intended behavior please set it to 'ignore' or 'all'.
filters	dict	None	dict of filters.
options	dict	None	dict of options.
group	dict	None	can be use to set group system and event retrieving instructions (dict or list[dict]).
field		None	by default 'value' if none, accept str or list (e.g. value, reliability, eventId, ...)
bucket	str	None	specify on which bucket the query applies.
tags	dict	None
verbose	bool	True	print progress information during batch processing.
return: concatenated dataframe with results from all batches.

build_image()

build an image of a pipeline, store it on the image repository and return its pipeline image id.

Name	Type	Default	Description
key	str		pipeline key.
return: image id.

create()

create and save an object on the server

Name	Type	Default	Description
obj			object from any supported entity (see info()) or python callable function (Script)
return: id of created object

create_component()

create a component based on its ID.

Name	Type	Default	Description
component	SolutionComponent

delete()

delete an object on the server

Name	Type	Default	Description
obj			object to delete including all content

delete_component()

delete component

Name	Type	Default	Description
component_id	UUID

delete_model()

delete a model version from the repository.

Name	Type	Default	Description
identifier	str		full identifier including alias (e.g. 'my_model@alias' or 'my_model.twin@alias').

download_file()

download a model extra file from the repository.

Name	Type	Default	Description
model	ModelInfo	None	model (ModelInfo), alternatively can use identifier
file	ModelFile	None	file (ModelFile), alternatively can use path
identifier	str	None	identifier including alias of the model.
path	str	None	path name of the file including the extension.
return: bytes content.

download_image()

download a pipeline image from the repository

Name	Type	Default	Description
pipeline_image_id	str		id of image
return: packaged (unzipped) as a PipelineImage

download_model()

download a model image directly from the repository, auto-select alias if necessary.

Name	Type	Default	Description
identifier	str		exact identifier including alias of the model or no alias to auto-select active version.
return: ModelInfo with trained_model loaded, extra file must be downloaded separately.

experiment()

experiment and train models with a pipeline.

existing experiment is required (use create or upsert_experiment(key, name)).
if your pipeline is templated please provide a twin.
please provide all variables and parameters required through properties.
return an execution
check status with "wizata_dsapi.api().get(execution).status"
see plots with "wizata_dsapi.api().plots(execution)"

Name	Type	Default	Description
pipeline			pipeline identified by its id (uuid or wizata_dsapi.Pipeline) or key (str) .
experiment		None	existing experiment identified by its id (uuid or wizata_dsapi.Experiment) or key (str).
twin		None	twin identified by its id (uuid or wizata_dsapi.Twin) or hardware ID (str)(optional).
image	str	None	pipeline image id to use.
properties	dict	None	dictionary containing override for variables or additional parameters for your script.
train	bool	True	train machine learning model on model steps.
plot	bool	True	if False plot steps are ignored.
write	bool	False	if False write steps are ignored.
version	str	None

get()

get record content from DS API.

get will look first for obj then for id then for key (e.g. if id and key specified, key is ignored )

Name	Type	Default	Description
obj		None	a wizata_dsapi.`<Entity>()` with UUID set - fetch using technical UUID
id	UUID	None	a UUID of a specific object (use in combination of entity)
key	str	None	a logical key of a specific object (e.g. hardware id for DataPoint and Twin (use in combination of entity)
entity		None	plural name of the entity or class (use in combination of entity)(e.g. scripts, plots, mlmodels, dataframes...)
script_name		None
experiment_key		None
pipeline_key		None
model_key		None
template_key		None
twin_hardware_id		None
datapoint_hardware_id		None
return: object with all properties or None if not found.

get_business_labels()

get a name / uuid dictionary with all business labels in platform.

get_categories()

get a name / uuid dictionary with all categories in platform.

get_components()

get components

Name	Type	Default	Description
label_id	UUID	None	filter on a specific label
twin_id	UUID	None	filter on a specific twin
template_id	UUID	None	filter on a specific template
owner_id	UUID	None	filter on a specific owner_id
organization_only	bool	False	work only with organization components (by default - False)
name	str	None	filter on a specific name (contains)

get_datapoint_mappings()

get datapoint mapping from a registration.

Name	Type	Default	Description
registration

get_registrations()

retrieve all registrations for

Name	Type	Default	Description
template			template object, UUID or str key.
return: list of twin registration.

get_ts_query()

Get a Query string to Timeseries Database.

Name	Type	Default	Description
datapoints	list	None	list of datapoints to fetch.
start	datetime	None	start datetime of range to fetch
end	datetime	None	end datetime of range to fetch
interval	int	None	interval in milliseconds.
agg_method	str	mean
template	str	None	template to fetch.
twin	str	None	hardware ID of twin to fetch based on template.
null	str	None	By default at 'drop' and dropping NaN values. If not intended behavior please set it to 'ignore' or 'all'.
filters	dict	None	dict of filters.
options	dict	None	dict of options.
return: dataframe

get_units()

get a name / uuid dictionary with all units in platform.

info()

print insights regarding version and supported operations

lists()

lists all elements of a specific entity.

Name	Type	Default	Description
entity			plural name of the entity or class (e.g. scripts, plots, mlmodels, dataframes...)
return: list of all elements with at least the id property.

load_model()

load a model pickle or torch from the repository ready to be used.

Name	Type	Default	Description
model			ModelInfo to load
return: ModelInfo with the trained model.

plot()

Fetch and show plot.

Name	Type	Default	Description
plot_id	str	None	Plot Id
plot	Plot	None	Wizata Plot Object
figure		None	JSON Figure
return: plotly figure

plots()

get all plot for an execution.

Name	Type	Default	Description
execution			id or Execution.
return: list of plots.

query()

Query a dataframe from API.

Name	Type	Default	Description
datapoints	list	None	list of datapoints to fetch.
start	datetime	None	start datetime of range to fetch
end	datetime	None	end datetime of range to fetch
interval	int	None	interval in milliseconds.
agg_method	str	mean
template	str	None	template to fetch.
twin	str	None	hardware ID of twin to fetch based on template.
null	str	None	By default at 'drop' and dropping NaN values. If not intended behavior please set it to 'ignore' or 'all'.
filters	dict	None	dict of filters.
options	dict	None	dict of options.
group		None	can be use to set group system and event retrieving instructions (dict or list[dict]).
field		None	by default 'value' if none, accept str or list (e.g. value, reliability, eventId, ...)
bucket	str	None	specify on which bucket the query applies.
tags	dict	None
return: dataframe

remove_template_property()

remove a property from an existing template by name.

Name	Type	Default	Description
template			template object or str key.
property_name	str		name of the property to remove.

register_twin()

register a twin on a specific template using a map.

Name	Type	Default	Description
template			template object, UUID or str key.
twin			twin object, UUID or str key.
properties	dict		dict where key = template property and value = datapoint name or const value (str, int, float, relative or epoch datetime).
override		True	by default at True - allow overriding any existing subscription

run()

run a pipeline.

existing models are used for simulation and prediction.
caution this might affect data inside platform or trigger automation.
if your pipeline is templated please provide a twin.
please provide all variables and parameters required through properties.
return an execution
check status with "wizata_dsapi.api().get(execution).status"
check results in platform (dashboard/explorer) or perform queries.

Name	Type	Default	Description
pipeline			pipeline identified by its id (uuid or wizata_dsapi.Pipeline) or key (str).
twin		None	twin identified by its id (uuid or wizata_dsapi.Twin) or hardware ID (str).
properties	dict	None	dictionary containing override for variables or additional parameters for your script.
image	str	None	pipeline image id to use.
train	bool	False	train machine learning model on model steps.
plot	bool	False	if False plot steps are ignored.
write	bool	True	if False write steps are ignored.
version	str	None	version of python environment to use if different than local environment.

search_execution()

search executions using filters, sorting and pagination via POST.

Name	Type	Default	Description
search_query		None	dict or SearchQuery with filters, sort, page, size, groups, groupSummaries, serviceName.
return: PagedQueryResult with ExecutionLog results and optional group statistics.

search_datapoints()

get datapoints with a paged query.

Name	Type	Default	Description
page	int	1	numero of the page - default 1.
size	int	20	quantity per page - default 20 max 100.
sort	str	id	column to sort results - default id.
direction	str	asc	sorting direction by default asc, accept also desc.
hardware_id	str	None	filter on a specific hardware ID name or partial name.
categories	list	None	list of UUID or Category.
business_types	list	None	list of BusinessType or str.
twin		None	uuid or Twin element to search datapoints.
recursive	bool	False	set to True in combination of a twin to look inside all sub-twins recursively.
return: PagedQueryResults, check total for number of potential results and results for the list of entity.

search_executions()

get executions with a paged query.

Name	Type	Default	Description
page	int	1	numero of the page - default 1.
size	int	20	quantity per page - default 20 max 100.
sort	str	id	column to sort results - default id.
direction	str	asc	sorting direction by default asc, accept also desc.
pipeline_id	UUID	None	filter on a specific pipeline.
twin_id	UUID	None	filter on a specific twin.
template_id	UUID	None	filter on a specific template.
status	ExecutionStatus	None	filter on a specific status.
return: PagedQueryResults, check total for number of potential results and results for the list of entity.

search_insights()

get insights with a paged query.

Name	Type	Default	Description
page	int	1	numero of the page - default 1.
size	int	20	quantity per page - default 20 max 100.
sort	str	id	column to sort results - default id.
direction	str	asc	sorting direction by default asc, accept also desc.
datapoint_id	str	None	id of the datapoint on which filtering the insights.
twin_id	str	None	id of the twin on which filtering the insights.
component_id	list	None	id of the component on which filtering the insights.
return: PagedQueryResults, check total for number of potential results and results for the list of entity.

search_models()

get all information related to models stored on Wizata.

return: ModelList structure model list

search_twins()

get twins with a paged query.

Name	Type	Default	Description
page	int	1	numero of the page - default 1.
size	int	20	quantity per page - default 20 max 100.
sort	str	id	column to sort results - default id.
direction	str	asc	sorting direction by default asc, accept also desc.
hardware_id	str	None	filter on a specific hardware ID name or partial name.
name	str	None	name or part of twin name.
parents	list	None	list of all possible parents (Twin, UUID, or str UUID).
return: PagedQueryResults, check total for number of potential results and results for the list of entity.

send_alerts()

send alerts through backend

Name	Type	Default
message	str
recipients	list
alert_type	AlertType	AlertType.SMS
subject	str
cc	list	None

unregister_twin()

un-register a twin from a specific template.

Name	Type	Default	Description
template			template object, UUID or str key.
twin			twin object, UUID or str key.

update()

update and save an object on DS API

Name	Type	Default	Description
obj			object to update on DS API (see info()) or python callable function (Script)

update_component()

update a component based on its ID.

Name	Type	Default	Description
component	SolutionComponent

upload_file()

upload a model extra file to the repository.

please use upload_model for a trained_model

Name	Type	Default	Description
content			the bytes content of the file.
model	ModelInfo	None	model (ModelInfo), alternatively can use identifier
file	ModelFile	None	file (ModelFile), alternatively can use path
identifier	str	None	identifier including alias of the model.
path	str	None	path name of the file including the extension.
return: bytes content.

upload_model()

upload a model within the model repository.

by default use model_info.trained_model and convert it to a pickle
for already torch or pickle please pass the bytes_content
model_info.file_format must be set properly to 'pkl' or 'pt'

Name	Type	Default	Description
model_info	ModelInfo		model info, with at least key (+twin, +property, +alias) and trained_model.
bytes_content		None	bytes[] of your torch or pickle model.

upsert()

upsert on object on the server

work with Script, MLModel or directly a function name

Name	Type	Default	Description
obj			object to upsert on the server
return: ID of the object created or updated

upsert_datapoint()

Upsert a datapoint (ignore ID, use the key)

Name	Type	Default	Description
datapoint	DataPoint
return: upsert datapoint.

upsert_experiment()

Upsert an experiment.

Name	Type	Default	Description
key	str		unique key identifying the experiment.
name	str		display name of the experiment.
pipeline		None	pipeline to set at creation only - cannot be updated.
twin		None	twin uuid, hardware id or twin.
return: upserted experiment.

upsert_pipeline()

Upsert a template (ignore ID, use the key)

Name	Type	Default	Description
pipeline	Pipeline
return: upserted template.

upsert_template()

Upsert a template.

Name	Type	Description
key	str	unique key identifying the template.
name	str	display name of the template
return: upserted template.

upsert_twin()

Upsert a twin (ignore ID, use the key)

Name	Type	Default	Description
twin	Twin
return: upsert twin.

who_am_i()

decrypt current JWT token used to get information about current user.

return: