Skip to content

Latest commit

 

History

History
380 lines (279 loc) · 13.5 KB

LogApi.md

File metadata and controls

380 lines (279 loc) · 13.5 KB

whylabs_client.LogApi

All URIs are relative to https://api.whylabsapp.com

Method HTTP request Description
get_profile_observatory_link POST /v0/organizations/{org_id}/log/observatory-link/{dataset_id} Get observatory links for profiles in a given org/model. A max of 3 profiles can be viewed a a time.
log_async POST /v0/organizations/{org_id}/log/async/{dataset_id} Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to.
log_profile POST /v1/log/async It returns an upload link that can be used to upload the profile to.
log_reference POST /v0/organizations/{org_id}/log/reference/{model_id} Returns a presigned URL for uploading the reference profile to.

get_profile_observatory_link

GetProfileObservatoryLinkResponse get_profile_observatory_link(dataset_id, org_id, get_profile_observatory_link_request)

Get observatory links for profiles in a given org/model. A max of 3 profiles can be viewed a a time.

Get observatory links for profiles in a given org/model. A max of 3 profiles can be viewed a a time.

Example

  • Api Key Authentication (ApiKeyAuth):
import time
import whylabs_client
from whylabs_client.api import log_api
from whylabs_client.model.get_profile_observatory_link_response import GetProfileObservatoryLinkResponse
from whylabs_client.model.get_profile_observatory_link_request import GetProfileObservatoryLinkRequest
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 = log_api.LogApi(api_client)
    dataset_id = "dataset_id_example" # str | 
    org_id = "org_id_example" # str | 
    get_profile_observatory_link_request = GetProfileObservatoryLinkRequest(
        batch_profile_timestamps=[
            1,
        ],
        reference_profile_ids=[
            "reference_profile_ids_example",
        ],
    ) # GetProfileObservatoryLinkRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Get observatory links for profiles in a given org/model. A max of 3 profiles can be viewed a a time.
        api_response = api_instance.get_profile_observatory_link(dataset_id, org_id, get_profile_observatory_link_request)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling LogApi->get_profile_observatory_link: %s\n" % e)

Parameters

Name Type Description Notes
dataset_id str
org_id str
get_profile_observatory_link_request GetProfileObservatoryLinkRequest

Return type

GetProfileObservatoryLinkResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 GetProfileObservatoryLink 200 response -

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

log_async

AsyncLogResponse log_async(org_id, dataset_id, log_async_request)

Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to.

Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to.

Example

  • Api Key Authentication (ApiKeyAuth):
import time
import whylabs_client
from whylabs_client.api import log_api
from whylabs_client.model.log_async_request import LogAsyncRequest
from whylabs_client.model.async_log_response import AsyncLogResponse
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 = log_api.LogApi(api_client)
    org_id = "org-123" # str | 
    dataset_id = "model-123" # str | 
    log_async_request = LogAsyncRequest(
        dataset_timestamp=1,
        segment_tags=[
            SegmentTag(
                key="key_example",
                value="value_example",
            ),
        ],
        region="region_example",
    ) # LogAsyncRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Like /log, except this api doesn't take the actual profile content. It returns an upload link that can be used to upload the profile to.
        api_response = api_instance.log_async(org_id, dataset_id, log_async_request)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling LogApi->log_async: %s\n" % e)

Parameters

Name Type Description Notes
org_id str
dataset_id str
log_async_request LogAsyncRequest

Return type

AsyncLogResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 LogAsync 200 response -

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

log_profile

AsyncLogResponse log_profile(log_async_request)

It returns an upload link that can be used to upload the profile to.

It returns an upload link that can be used to upload the profile to.

Example

  • Api Key Authentication (ApiKeyAuth):
import time
import whylabs_client
from whylabs_client.api import log_api
from whylabs_client.model.log_async_request import LogAsyncRequest
from whylabs_client.model.async_log_response import AsyncLogResponse
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 = log_api.LogApi(api_client)
    log_async_request = LogAsyncRequest(
        dataset_timestamp=1,
        segment_tags=[
            SegmentTag(
                key="key_example",
                value="value_example",
            ),
        ],
        region="region_example",
    ) # LogAsyncRequest | 
    x_whylabs_resource = "resource-1" # str, none_type |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # It returns an upload link that can be used to upload the profile to.
        api_response = api_instance.log_profile(log_async_request)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling LogApi->log_profile: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # It returns an upload link that can be used to upload the profile to.
        api_response = api_instance.log_profile(log_async_request, x_whylabs_resource=x_whylabs_resource)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling LogApi->log_profile: %s\n" % e)

Parameters

Name Type Description Notes
log_async_request LogAsyncRequest
x_whylabs_resource str, none_type [optional]

Return type

AsyncLogResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 LogProfile 200 response -

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

log_reference

LogReferenceResponse log_reference(org_id, model_id, log_reference_request)

Returns a presigned URL for uploading the reference profile to.

Reference profiles can be used for.

Example

  • Api Key Authentication (ApiKeyAuth):
import time
import whylabs_client
from whylabs_client.api import log_api
from whylabs_client.model.log_reference_response import LogReferenceResponse
from whylabs_client.model.log_reference_request import LogReferenceRequest
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 = log_api.LogApi(api_client)
    org_id = "org-123" # str | 
    model_id = "model-123" # str | 
    log_reference_request = LogReferenceRequest(
        alias="alias_example",
        dataset_timestamp=1,
        region="region_example",
    ) # LogReferenceRequest | 

    # example passing only required values which don't have defaults set
    try:
        # Returns a presigned URL for uploading the reference profile to.
        api_response = api_instance.log_reference(org_id, model_id, log_reference_request)
        pprint(api_response)
    except whylabs_client.ApiException as e:
        print("Exception when calling LogApi->log_reference: %s\n" % e)

Parameters

Name Type Description Notes
org_id str
model_id str
log_reference_request LogReferenceRequest

Return type

LogReferenceResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 LogReference 200 response -

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