Service overview

The following table presents an overview of the supported Services, Resources and Actions in the Python SDK.

Each of the service.resource.action combinations correspond with a method of the Waylay Client.

from waylay import WaylayClient
waylay_client = WaylayClient.from_profile()

# example service=byoml, resource=model, action=list_names
waylay_client.byoml.model.list_names()

See also to the corresponding REST API documentation for query and byoml.

A complete API documentation will be provided soon.

method url description
service resource action
analytics query list GET /config/query List or search Query Configurations
create POST /config/query Create a new Query Configuration
get GET /config/query/{} Fetch the named Query Configuration
remove DELETE /config/query/{} Remove the named Query Configuration
replace PUT /config/query/{} Replace the named Query Configuration
data GET /data/query/{} Execute the timeseries query specified by the named Query Configuration
execute POST /data/query Execute the timeseries query specified in the request
about version GET / Version info of the Analytics Service at this endpoint.
byoml model list GET /models List the metadata of the deployed BYOML Models
list_names GET /models List the names of deployed BYOML Models
create POST /models Build and create a new BYOML Model as specified in the request
replace PUT /models/{} Build and replace the named BYOML Model
get GET /models/{} Fetch the metadata of the named BYOML Model
examples GET /models/{}/examples Fetch the example request input of the named BYOML Model
predict POST /models/{}/predict Execute the predict capability of the named BYOML Model
regress POST /models/{}/regress Execute the regress capability of the named BYOML Model
classify POST /models/{}/classify Execute the classification capability of the named BYOML Model
remove DELETE /models/{} Remove the named BYOML Model
about health GET / Get the health status of the BYOML Service