ai.whylabs.service.api

Class ModelsApi

java.lang.Object

ai.whylabs.service.api.ModelsApi

public class ModelsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ModelsApi()
ModelsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ModelMetadata	createModel(java.lang.String orgId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType) Create a model with a given name and a time period Create a model
okhttp3.Call	createModelAsync(java.lang.String orgId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType, ApiCallback<ModelMetadata> _callback) Create a model with a given name and a time period (asynchronously) Create a model
okhttp3.Call	createModelCall(java.lang.String orgId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType, ApiCallback _callback) Build call for createModel
ApiResponse<ModelMetadata>	createModelWithHttpInfo(java.lang.String orgId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType) Create a model with a given name and a time period Create a model
ModelMetadata	deactivateModel(java.lang.String orgId, java.lang.String modelId) Mark a model as inactive Mark a model as inactive
okhttp3.Call	deactivateModelAsync(java.lang.String orgId, java.lang.String modelId, ApiCallback<ModelMetadata> _callback) Mark a model as inactive (asynchronously) Mark a model as inactive
okhttp3.Call	deactivateModelCall(java.lang.String orgId, java.lang.String modelId, ApiCallback _callback) Build call for deactivateModel
ApiResponse<ModelMetadata>	deactivateModelWithHttpInfo(java.lang.String orgId, java.lang.String modelId) Mark a model as inactive Mark a model as inactive
ApiClient	getApiClient()
ModelMetadata	getModel(java.lang.String orgId, java.lang.String modelId) Get a model metadata Returns various metadata about a model
okhttp3.Call	getModelAsync(java.lang.String orgId, java.lang.String modelId, ApiCallback<ModelMetadata> _callback) Get a model metadata (asynchronously) Returns various metadata about a model
okhttp3.Call	getModelCall(java.lang.String orgId, java.lang.String modelId, ApiCallback _callback) Build call for getModel
ApiResponse<ModelMetadata>	getModelWithHttpInfo(java.lang.String orgId, java.lang.String modelId) Get a model metadata Returns various metadata about a model
ListModelsResponse	listModels(java.lang.String orgId) Get a list of all of the model ids for an organization.
okhttp3.Call	listModelsAsync(java.lang.String orgId, ApiCallback<ListModelsResponse> _callback) Get a list of all of the model ids for an organization.
okhttp3.Call	listModelsCall(java.lang.String orgId, ApiCallback _callback) Build call for listModels
ApiResponse<ListModelsResponse>	listModelsWithHttpInfo(java.lang.String orgId) Get a list of all of the model ids for an organization.
ListSegmentsResponse	listSegments(java.lang.String orgId, java.lang.String modelId) Get a model metadata Returns the list of Segments for a given model
okhttp3.Call	listSegmentsAsync(java.lang.String orgId, java.lang.String modelId, ApiCallback<ListSegmentsResponse> _callback) Get a model metadata (asynchronously) Returns the list of Segments for a given model
okhttp3.Call	listSegmentsCall(java.lang.String orgId, java.lang.String modelId, ApiCallback _callback) Build call for listSegments
ApiResponse<ListSegmentsResponse>	listSegmentsWithHttpInfo(java.lang.String orgId, java.lang.String modelId) Get a model metadata Returns the list of Segments for a given model
SegmentMetadata	putSegments(java.lang.String orgId, java.lang.String modelId, java.util.List<SegmentTag> segmentTag) Add a segment to the dataset Return 200 if succeeds
okhttp3.Call	putSegmentsAsync(java.lang.String orgId, java.lang.String modelId, java.util.List<SegmentTag> segmentTag, ApiCallback<SegmentMetadata> _callback) Add a segment to the dataset (asynchronously) Return 200 if succeeds
okhttp3.Call	putSegmentsCall(java.lang.String orgId, java.lang.String modelId, java.util.List<SegmentTag> segmentTag, ApiCallback _callback) Build call for putSegments
ApiResponse<SegmentMetadata>	putSegmentsWithHttpInfo(java.lang.String orgId, java.lang.String modelId, java.util.List<SegmentTag> segmentTag) Add a segment to the dataset Return 200 if succeeds
void	setApiClient(ApiClient apiClient)
ModelMetadata	updateModel(java.lang.String orgId, java.lang.String modelId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType) Update a model's metadata Update a model's metadata
okhttp3.Call	updateModelAsync(java.lang.String orgId, java.lang.String modelId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType, ApiCallback<ModelMetadata> _callback) Update a model's metadata (asynchronously) Update a model's metadata
okhttp3.Call	updateModelCall(java.lang.String orgId, java.lang.String modelId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType, ApiCallback _callback) Build call for updateModel
ApiResponse<ModelMetadata>	updateModelWithHttpInfo(java.lang.String orgId, java.lang.String modelId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType) Update a model's metadata Update a model's metadata

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelsApi

public ModelsApi()

ModelsApi

public ModelsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createModelCall

public okhttp3.Call createModelCall(java.lang.String orgId,
                                    java.lang.String modelName,
                                    TimePeriod timePeriod,
                                    ModelType modelType,
                                    ApiCallback _callback)
                             throws ApiException

Build call for createModel

Parameters:

orgId - The organization ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

createModel

public ModelMetadata createModel(java.lang.String orgId,
                                 java.lang.String modelName,
                                 TimePeriod timePeriod,
                                 ModelType modelType)
                          throws ApiException

Create a model with a given name and a time period Create a model

Parameters:

orgId - The organization ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

Returns:

ModelMetadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

createModelWithHttpInfo

public ApiResponse<ModelMetadata> createModelWithHttpInfo(java.lang.String orgId,
                                                          java.lang.String modelName,
                                                          TimePeriod timePeriod,
                                                          ModelType modelType)
                                                   throws ApiException

Create a model with a given name and a time period Create a model

Parameters:

orgId - The organization ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

Returns:

ApiResponse<ModelMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

createModelAsync

public okhttp3.Call createModelAsync(java.lang.String orgId,
                                     java.lang.String modelName,
                                     TimePeriod timePeriod,
                                     ModelType modelType,
                                     ApiCallback<ModelMetadata> _callback)
                              throws ApiException

Create a model with a given name and a time period (asynchronously) Create a model

Parameters:

orgId - The organization ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

deactivateModelCall

public okhttp3.Call deactivateModelCall(java.lang.String orgId,
                                        java.lang.String modelId,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for deactivateModel

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

deactivateModel

public ModelMetadata deactivateModel(java.lang.String orgId,
                                     java.lang.String modelId)
                              throws ApiException

Mark a model as inactive Mark a model as inactive

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

Returns:

ModelMetadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

deactivateModelWithHttpInfo

public ApiResponse<ModelMetadata> deactivateModelWithHttpInfo(java.lang.String orgId,
                                                              java.lang.String modelId)
                                                       throws ApiException

Mark a model as inactive Mark a model as inactive

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

Returns:

ApiResponse<ModelMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

deactivateModelAsync

public okhttp3.Call deactivateModelAsync(java.lang.String orgId,
                                         java.lang.String modelId,
                                         ApiCallback<ModelMetadata> _callback)
                                  throws ApiException

Mark a model as inactive (asynchronously) Mark a model as inactive

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

getModelCall

public okhttp3.Call getModelCall(java.lang.String orgId,
                                 java.lang.String modelId,
                                 ApiCallback _callback)
                          throws ApiException

Build call for getModel

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [ModelMetadata] object if operation succeeds	-

getModel

public ModelMetadata getModel(java.lang.String orgId,
                              java.lang.String modelId)
                       throws ApiException

Get a model metadata Returns various metadata about a model

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

Returns:

ModelMetadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [ModelMetadata] object if operation succeeds	-

getModelWithHttpInfo

public ApiResponse<ModelMetadata> getModelWithHttpInfo(java.lang.String orgId,
                                                       java.lang.String modelId)
                                                throws ApiException

Get a model metadata Returns various metadata about a model

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

Returns:

ApiResponse<ModelMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [ModelMetadata] object if operation succeeds	-

getModelAsync

public okhttp3.Call getModelAsync(java.lang.String orgId,
                                  java.lang.String modelId,
                                  ApiCallback<ModelMetadata> _callback)
                           throws ApiException

Get a model metadata (asynchronously) Returns various metadata about a model

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [ModelMetadata] object if operation succeeds	-

listModelsCall

public okhttp3.Call listModelsCall(java.lang.String orgId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for listModels

Parameters:

orgId - Your company's unique organization ID (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	A list of model summary items	-

listModels

public ListModelsResponse listModels(java.lang.String orgId)
                              throws ApiException

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

Parameters:

orgId - Your company's unique organization ID (required)

Returns:

ListModelsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A list of model summary items	-

listModelsWithHttpInfo

public ApiResponse<ListModelsResponse> listModelsWithHttpInfo(java.lang.String orgId)
                                                       throws ApiException

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

Parameters:

orgId - Your company's unique organization ID (required)

Returns:

ApiResponse<ListModelsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A list of model summary items	-

listModelsAsync

public okhttp3.Call listModelsAsync(java.lang.String orgId,
                                    ApiCallback<ListModelsResponse> _callback)
                             throws ApiException

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

Parameters:

orgId - Your company's unique organization ID (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	A list of model summary items	-

listSegmentsCall

public okhttp3.Call listSegmentsCall(java.lang.String orgId,
                                     java.lang.String modelId,
                                     ApiCallback _callback)
                              throws ApiException

Build call for listSegments

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [ListSegmentsResponse] object if operation succeeds	-

listSegments

public ListSegmentsResponse listSegments(java.lang.String orgId,
                                         java.lang.String modelId)
                                  throws ApiException

Get a model metadata Returns the list of Segments for a given model

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

Returns:

ListSegmentsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [ListSegmentsResponse] object if operation succeeds	-

listSegmentsWithHttpInfo

public ApiResponse<ListSegmentsResponse> listSegmentsWithHttpInfo(java.lang.String orgId,
                                                                  java.lang.String modelId)
                                                           throws ApiException

Get a model metadata Returns the list of Segments for a given model

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

Returns:

ApiResponse<ListSegmentsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [ListSegmentsResponse] object if operation succeeds	-

listSegmentsAsync

public okhttp3.Call listSegmentsAsync(java.lang.String orgId,
                                      java.lang.String modelId,
                                      ApiCallback<ListSegmentsResponse> _callback)
                               throws ApiException

Get a model metadata (asynchronously) Returns the list of Segments for a given model

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [ListSegmentsResponse] object if operation succeeds	-

putSegmentsCall

public okhttp3.Call putSegmentsCall(java.lang.String orgId,
                                    java.lang.String modelId,
                                    java.util.List<SegmentTag> segmentTag,
                                    ApiCallback _callback)
                             throws ApiException

Build call for putSegments

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

segmentTag - List of segment tags to create the segment for (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [SegmentMetadata] object if operation succeeds	-

putSegments

public SegmentMetadata putSegments(java.lang.String orgId,
                                   java.lang.String modelId,
                                   java.util.List<SegmentTag> segmentTag)
                            throws ApiException

Add a segment to the dataset Return 200 if succeeds

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

segmentTag - List of segment tags to create the segment for (required)

Returns:

SegmentMetadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [SegmentMetadata] object if operation succeeds	-

putSegmentsWithHttpInfo

public ApiResponse<SegmentMetadata> putSegmentsWithHttpInfo(java.lang.String orgId,
                                                            java.lang.String modelId,
                                                            java.util.List<SegmentTag> segmentTag)
                                                     throws ApiException

Add a segment to the dataset Return 200 if succeeds

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

segmentTag - List of segment tags to create the segment for (required)

Returns:

ApiResponse<SegmentMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	A [SegmentMetadata] object if operation succeeds	-

putSegmentsAsync

public okhttp3.Call putSegmentsAsync(java.lang.String orgId,
                                     java.lang.String modelId,
                                     java.util.List<SegmentTag> segmentTag,
                                     ApiCallback<SegmentMetadata> _callback)
                              throws ApiException

Add a segment to the dataset (asynchronously) Return 200 if succeeds

Parameters:

orgId - The name of an organization (required)

modelId - The ID of a model (required)

segmentTag - List of segment tags to create the segment for (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	A [SegmentMetadata] object if operation succeeds	-

updateModelCall

public okhttp3.Call updateModelCall(java.lang.String orgId,
                                    java.lang.String modelId,
                                    java.lang.String modelName,
                                    TimePeriod timePeriod,
                                    ModelType modelType,
                                    ApiCallback _callback)
                             throws ApiException

Build call for updateModel

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

updateModel

public ModelMetadata updateModel(java.lang.String orgId,
                                 java.lang.String modelId,
                                 java.lang.String modelName,
                                 TimePeriod timePeriod,
                                 ModelType modelType)
                          throws ApiException

Update a model's metadata Update a model's metadata

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

Returns:

ModelMetadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

updateModelWithHttpInfo

public ApiResponse<ModelMetadata> updateModelWithHttpInfo(java.lang.String orgId,
                                                          java.lang.String modelId,
                                                          java.lang.String modelName,
                                                          TimePeriod timePeriod,
                                                          ModelType modelType)
                                                   throws ApiException

Update a model's metadata Update a model's metadata

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

Returns:

ApiResponse<ModelMetadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-

updateModelAsync

public okhttp3.Call updateModelAsync(java.lang.String orgId,
                                     java.lang.String modelId,
                                     java.lang.String modelName,
                                     TimePeriod timePeriod,
                                     ModelType modelType,
                                     ApiCallback<ModelMetadata> _callback)
                              throws ApiException

Update a model's metadata (asynchronously) Update a model's metadata

Parameters:

orgId - The organization ID (required)

modelId - The model ID (required)

modelName - The name of a model (required)

timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)

modelType - The [ModelType] of the dataset (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
0	The [ModelMetadata] if operation succeeds	-