Search code, repositories, users, issues, pull requests...

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	AddResourceTag 200 response	-

create_model

ModelMetadataResponse create_model(org_id, model_name, time_period)

Create a model with a given name and a time period

Create a model

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.model_metadata_response import ModelMetadataResponse
from whylabs_client.model.model_type import ModelType
from whylabs_client.model.time_period import TimePeriod
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | The organization ID
    model_name = "Credit-Score-1" # str | The name of a model
    time_period = TimePeriod("P1D") # TimePeriod | The \\[TimePeriod\\] for data aggregation/alerting for a model
    model_type = ModelType("CLASSIFICATION") # ModelType | The \\[ModelType\\] of the dataset (optional)
    model_id = "model-123" # str, none_type |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Create a model with a given name and a time period
        api_response = api_instance.create_model(org_id, model_name, time_period)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->create_model: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a model with a given name and a time period
        api_response = api_instance.create_model(org_id, model_name, time_period, model_type=model_type, model_id=model_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->create_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str	The organization ID
model_name	str	The name of a model
time_period	TimePeriod	The \[TimePeriod\] for data aggregation/alerting for a model
model_type	ModelType	The \[ModelType\] of the dataset	[optional]
model_id	str, none_type		[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The \[ModelMetadataResponse\] if operation succeeds	-

deactivate_model

ModelMetadataResponse deactivate_model(org_id, model_id)

Mark a model as inactive

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.model_metadata_response import ModelMetadataResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | The organization ID
    model_id = "model-123" # str | The model ID

    # example passing only required values which don't have defaults set
    try:
        # Mark a model as inactive
        api_response = api_instance.deactivate_model(org_id, model_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->deactivate_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str	The organization ID
model_id	str	The model ID

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The \[ModelMetadataResponse\] if operation succeeds	-

delete_entity_schema

Response delete_entity_schema(org_id, dataset_id)

Delete the entity schema config for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the entity schema config for a given dataset.
        api_response = api_instance.delete_entity_schema(org_id, dataset_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->delete_entity_schema: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	DeleteEntitySchema 200 response	-

delete_entity_schema_column

Response delete_entity_schema_column(org_id, dataset_id, column_id)

Delete the entity schema of a single column for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    column_id = "feature-123" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the entity schema of a single column for a given dataset.
        api_response = api_instance.delete_entity_schema_column(org_id, dataset_id, column_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->delete_entity_schema_column: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
column_id	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	DeleteEntitySchemaColumn 200 response	-

delete_entity_schema_metric

Response delete_entity_schema_metric(org_id, dataset_id, metric_name)

Delete the schema of a single metric for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    metric_name = "estimated_performance_median" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Delete the schema of a single metric for a given dataset.
        api_response = api_instance.delete_entity_schema_metric(org_id, dataset_id, metric_name)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->delete_entity_schema_metric: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
metric_name	str

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	DeleteEntitySchemaMetric 200 response	-

delete_resource_tag

Response delete_resource_tag(org_id, dataset_id, resource_tag)

Delete a resource tag to a dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.resource_tag import ResourceTag
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    resource_tag = ResourceTag(
        key="key_example",
        value="value_example",
    ) # ResourceTag | 

    # example passing only required values which don't have defaults set
    try:
        # Delete a resource tag to a dataset.
        api_response = api_instance.delete_resource_tag(org_id, dataset_id, resource_tag)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->delete_resource_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
resource_tag	ResourceTag

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	DeleteResourceTag 200 response	-

get_entity_schema

EntitySchema get_entity_schema(org_id, dataset_id)

Get the entity schema config for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.entity_schema import EntitySchema
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get the entity schema config for a given dataset.
        api_response = api_instance.get_entity_schema(org_id, dataset_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->get_entity_schema: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str

Return type

EntitySchema

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	GetEntitySchema 200 response	-

get_entity_schema_column

ColumnSchema get_entity_schema_column(org_id, dataset_id, column_id)

Get the entity schema of a single column for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.column_schema import ColumnSchema
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    column_id = "feature-123" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get the entity schema of a single column for a given dataset.
        api_response = api_instance.get_entity_schema_column(org_id, dataset_id, column_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->get_entity_schema_column: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
column_id	str

Return type

ColumnSchema

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	GetEntitySchemaColumn 200 response	-

get_model

ModelMetadataResponse get_model(org_id, model_id)

Get a model metadata

Returns various metadata about a model

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.model_metadata_response import ModelMetadataResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | The name of an organization
    model_id = "model-123" # str | The ID of a model

    # example passing only required values which don't have defaults set
    try:
        # Get a model metadata
        api_response = api_instance.get_model(org_id, model_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->get_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str	The name of an organization
model_id	str	The ID of a model

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A \[ModelMetadataResponse\] object if operation succeeds	-

get_named_metric_schemas

[NamedMetricSchema] get_named_metric_schemas(org_id, dataset_id)

Get all of the named metrics for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.named_metric_schema import NamedMetricSchema
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get all of the named metrics for a given dataset.
        api_response = api_instance.get_named_metric_schemas(org_id, dataset_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->get_named_metric_schemas: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str

Return type

[NamedMetricSchema]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	GetNamedMetricSchemas 200 response	-

list_models

ListModelsResponse list_models(org_id)

Get a list of all of the model ids for an organization.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.list_models_response import ListModelsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | Your company's unique organization ID

    # example passing only required values which don't have defaults set
    try:
        # Get a list of all of the model ids for an organization.
        api_response = api_instance.list_models(org_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->list_models: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str	Your company's unique organization ID

Return type

ListModelsResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of model summary items	-

list_resource_tags

[ResourceTag] list_resource_tags(org_id, dataset_id)

List resource tags for a dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.resource_tag import ResourceTag
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 

    # example passing only required values which don't have defaults set
    try:
        # List resource tags for a dataset.
        api_response = api_instance.list_resource_tags(org_id, dataset_id)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->list_resource_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str

Return type

[ResourceTag]

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ListResourceTags 200 response	-

put_entity_schema

Response put_entity_schema(org_id, dataset_id, entity_schema)

Save the entity schema config for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.entity_schema import EntitySchema
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    entity_schema = EntitySchema(
        columns={
            "key": ColumnSchema(
                classifier="input",
                data_type="fractional",
                discreteness="discrete",
                tags=[
                    "tags_example",
                ],
            ),
        },
        metadata=SchemaMetadata(
            version=1,
            updated_timestamp=1234567890123,
            author="user",
        ),
        metrics={
            "key": MetricSchema(
                label="Estimated prediction median",
                column="estimated_prediction",
                default_metric="default_metric_example",
                builtin_metric="median",
            ),
        },
    ) # EntitySchema | 

    # example passing only required values which don't have defaults set
    try:
        # Save the entity schema config for a given dataset.
        api_response = api_instance.put_entity_schema(org_id, dataset_id, entity_schema)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->put_entity_schema: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
entity_schema	EntitySchema

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	PutEntitySchema 200 response	-

put_entity_schema_column

Response put_entity_schema_column(org_id, dataset_id, column_id, column_schema)

Save the entity schema of a single column for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.column_schema import ColumnSchema
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    column_id = "feature-123" # str | 
    column_schema = ColumnSchema(
        classifier="input",
        data_type="fractional",
        discreteness="discrete",
        tags=[
            "tags_example",
        ],
    ) # ColumnSchema | 

    # example passing only required values which don't have defaults set
    try:
        # Save the entity schema of a single column for a given dataset.
        api_response = api_instance.put_entity_schema_column(org_id, dataset_id, column_id, column_schema)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->put_entity_schema_column: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
column_id	str
column_schema	ColumnSchema

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	PutEntitySchemaColumn 200 response	-

put_entity_schema_metric

Response put_entity_schema_metric(org_id, dataset_id, metric_schema)

Save the schema of a single metric for a given dataset.

Save the schema of a single metric for a given dataset. The metric will be given a name based on the label in the schema, replacing any non-alphanumeric with _.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.metric_schema import MetricSchema
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    metric_schema = MetricSchema(
        label="Estimated prediction median",
        column="estimated_prediction",
        default_metric="default_metric_example",
        builtin_metric="median",
    ) # MetricSchema | 

    # example passing only required values which don't have defaults set
    try:
        # Save the schema of a single metric for a given dataset.
        api_response = api_instance.put_entity_schema_metric(org_id, dataset_id, metric_schema)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->put_entity_schema_metric: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
metric_schema	MetricSchema

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	PutEntitySchemaMetric 200 response	-

put_named_metric_schema

Response put_named_metric_schema(org_id, dataset_id, metric_name, metric_schema_fields)

Save the schema of a single named metric for a given dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.metric_schema_fields import MetricSchemaFields
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    metric_name = "estimated_performance_median" # str | 
    metric_schema_fields = MetricSchemaFields(
        label="Estimated prediction median",
        column="estimated_prediction",
        builtin_metric="median",
    ) # MetricSchemaFields | 

    # example passing only required values which don't have defaults set
    try:
        # Save the schema of a single named metric for a given dataset.
        api_response = api_instance.put_named_metric_schema(org_id, dataset_id, metric_name, metric_schema_fields)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->put_named_metric_schema: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
metric_name	str
metric_schema_fields	MetricSchemaFields

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	PutNamedMetricSchema 200 response	-

reinfer_entity_schema

EntitySchema reinfer_entity_schema(org_id, dataset_id, reinfer_entity_schema_request)

Reinfers the entity schema config for a given dataset.

Reinfers the type and discreteness for the columns in a given dataset. Retains additional user information like tags and whether the column is input or output

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.entity_schema import EntitySchema
from whylabs_client.model.reinfer_entity_schema_request import ReinferEntitySchemaRequest
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    reinfer_entity_schema_request = ReinferEntitySchemaRequest(
        interval="2024-01-01T00:00:00Z/2024-01-12T00:00:00Z",
    ) # ReinferEntitySchemaRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Reinfers the entity schema config for a given dataset.
        api_response = api_instance.reinfer_entity_schema(org_id, dataset_id, reinfer_entity_schema_request)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->reinfer_entity_schema: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
reinfer_entity_schema_request	ReinferEntitySchemaRequest

Return type

EntitySchema

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	ReinferEntitySchema 200 response	-

update_model

ModelMetadataResponse update_model(org_id, model_id, model_name, time_period)

Update a model's metadata

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.model_metadata_response import ModelMetadataResponse
from whylabs_client.model.model_type import ModelType
from whylabs_client.model.time_period import TimePeriod
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | The organization ID
    model_id = "model-123" # str | The model ID
    model_name = "Credit-Score-1" # str | The name of a model
    time_period = TimePeriod("P1D") # TimePeriod | The \\[TimePeriod\\] for data aggregation/alerting for a model
    model_type = ModelType("CLASSIFICATION") # ModelType | The \\[ModelType\\] of the dataset (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update a model's metadata
        api_response = api_instance.update_model(org_id, model_id, model_name, time_period)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->update_model: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a model's metadata
        api_response = api_instance.update_model(org_id, model_id, model_name, time_period, model_type=model_type)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->update_model: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str	The organization ID
model_id	str	The model ID
model_name	str	The name of a model
time_period	TimePeriod	The \[TimePeriod\] for data aggregation/alerting for a model
model_type	ModelType	The \[ModelType\] of the dataset	[optional]

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The \[ModelMetadataResponse\] if operation succeeds	-

update_resource_tag

Response update_resource_tag(org_id, dataset_id, resource_tag)

Update a resource tag to a dataset.

Example

Api Key Authentication (ApiKeyAuth):

import time
import whylabs_client
from whylabs_client.api import models_api
from whylabs_client.model.resource_tag import ResourceTag
from whylabs_client.model.response import Response
from pprint import pprint
# Defining the host is optional and defaults to https://api.whylabsapp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = whylabs_client.Configuration(
    host = "https://api.whylabsapp.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whylabs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = models_api.ModelsApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    resource_tag = ResourceTag(
        key="key_example",
        value="value_example",
    ) # ResourceTag | 

    # example passing only required values which don't have defaults set
    try:
        # Update a resource tag to a dataset.
        api_response = api_instance.update_resource_tag(org_id, dataset_id, resource_tag)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling ModelsApi->update_resource_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
org_id	str
dataset_id	str
resource_tag	ResourceTag

Return type

Authorization