de.irisnet.java.client

Class EndpointsToSetupTheAiApi

java.lang.Object

de.irisnet.java.client.EndpointsToSetupTheAiApi

public class EndpointsToSetupTheAiApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EndpointsToSetupTheAiApi()
EndpointsToSetupTheAiApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	setINDefine(INDefineAI inDefineAI) Set definitions via pre-defined prototypes.
okhttp3.Call	setINDefineAsync(INDefineAI inDefineAI, ApiCallback<Void> _callback) Set definitions via pre-defined prototypes.
okhttp3.Call	setINDefineCall(INDefineAI inDefineAI, ApiCallback _callback) Build call for setINDefine
ApiResponse<Void>	setINDefineWithHttpInfo(INDefineAI inDefineAI) Set definitions via pre-defined prototypes.
void	setINParams(INParams inParams) Set the behaviour parameters for one object class.
okhttp3.Call	setINParamsAsync(INParams inParams, ApiCallback<Void> _callback) Set the behaviour parameters for one object class.
okhttp3.Call	setINParamsCall(INParams inParams, ApiCallback _callback) Build call for setINParams
ApiResponse<Void>	setINParamsWithHttpInfo(INParams inParams) Set the behaviour parameters for one object class.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointsToSetupTheAiApi

public EndpointsToSetupTheAiApi()

EndpointsToSetupTheAiApi

public EndpointsToSetupTheAiApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

setINDefineCall

public okhttp3.Call setINDefineCall(INDefineAI inDefineAI,
                                    ApiCallback _callback)
                             throws ApiException

Build call for setINDefine

Parameters:

inDefineAI - (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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-

setINDefine

public void setINDefine(INDefineAI inDefineAI)
                 throws ApiException

Set definitions via pre-defined prototypes. Each available prototype groups together a pre-defined set of parameters that will define the behaviour of the AI. This allows to configure multiple AI-checks per image. The image upload is only required once. Set the definition context with your needs in mind, credits are subtracted accordingly. See 'cost' endpoint for further information. Additionally you can overwrite specific parameters using 'set-parameters'. Any prior request to 'set-parameters' are invalidated when calling this request. This can also be used to reset the AI configuration.

Parameters:

inDefineAI - (required)

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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-

setINDefineWithHttpInfo

public ApiResponse<Void> setINDefineWithHttpInfo(INDefineAI inDefineAI)
                                          throws ApiException

Set definitions via pre-defined prototypes. Each available prototype groups together a pre-defined set of parameters that will define the behaviour of the AI. This allows to configure multiple AI-checks per image. The image upload is only required once. Set the definition context with your needs in mind, credits are subtracted accordingly. See 'cost' endpoint for further information. Additionally you can overwrite specific parameters using 'set-parameters'. Any prior request to 'set-parameters' are invalidated when calling this request. This can also be used to reset the AI configuration.

Parameters:

inDefineAI - (required)

Returns:

ApiResponse<Void>

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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-

setINDefineAsync

public okhttp3.Call setINDefineAsync(INDefineAI inDefineAI,
                                     ApiCallback<Void> _callback)
                              throws ApiException

Set definitions via pre-defined prototypes. (asynchronously) Each available prototype groups together a pre-defined set of parameters that will define the behaviour of the AI. This allows to configure multiple AI-checks per image. The image upload is only required once. Set the definition context with your needs in mind, credits are subtracted accordingly. See 'cost' endpoint for further information. Additionally you can overwrite specific parameters using 'set-parameters'. Any prior request to 'set-parameters' are invalidated when calling this request. This can also be used to reset the AI configuration.

Parameters:

inDefineAI - (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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-

setINParamsCall

public okhttp3.Call setINParamsCall(INParams inParams,
                                    ApiCallback _callback)
                             throws ApiException

Build call for setINParams

Parameters:

inParams - (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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-

setINParams

public void setINParams(INParams inParams)
                 throws ApiException

Set the behaviour parameters for one object class. Overwrites or extends the default configuration of the AI. By setting precise behaviour parameters, the AI can be fine tuned for specific use cases. To reset the parameters to their default values, make a post request to 'set-definition'.

Parameters:

inParams - (required)

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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-

setINParamsWithHttpInfo

public ApiResponse<Void> setINParamsWithHttpInfo(INParams inParams)
                                          throws ApiException

Set the behaviour parameters for one object class. Overwrites or extends the default configuration of the AI. By setting precise behaviour parameters, the AI can be fine tuned for specific use cases. To reset the parameters to their default values, make a post request to 'set-definition'.

Parameters:

inParams - (required)

Returns:

ApiResponse<Void>

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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-

setINParamsAsync

public okhttp3.Call setINParamsAsync(INParams inParams,
                                     ApiCallback<Void> _callback)
                              throws ApiException

Set the behaviour parameters for one object class. (asynchronously) Overwrites or extends the default configuration of the AI. By setting precise behaviour parameters, the AI can be fine tuned for specific use cases. To reset the parameters to their default values, make a post request to 'set-definition'.

Parameters:

inParams - (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
400	Bad request. Check for badly formatted request body.	-
200	successful operation	-