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
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
void	setApiClient(ApiClient apiClient)

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 model summary if 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 model summary if 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 model summary if 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 model summary if 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 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 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 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 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 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 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 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 succeeds	-