Skip to content

ConfigurationManagementApi.md

Latest commit

 

History

History
255 lines (172 loc) · 7.94 KB

ConfigurationManagementApi.md

File metadata and controls

255 lines (172 loc) · 7.94 KB

Irisnet\API\Client\ConfigurationManagementApi

All URIs are relative to https://api.irisnet.de, except if the operation defines another base path.

Method HTTP request Description
deleteConfig() DELETE /v2/config/{configId} Delete an AI configuration.
getAllConfigs() GET /v2/config List all saved AI configurations.
getConfig() GET /v2/config/{configId} Get a specific AI configuration.
setConfig() POST /v2/config Create a new AI configuration.

deleteConfig()

deleteConfig($configId)

Delete an AI configuration.

Deletes the AI configuration with the given id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: LICENSE-KEY
$config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKey('LICENSE-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('LICENSE-KEY', 'Bearer');


$apiInstance = new Irisnet\API\Client\Api\ConfigurationManagementApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$configId = 'configId_example'; // string | The id of the configuration that should be deleted.

try {
    $apiInstance->deleteConfig($configId);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationManagementApi->deleteConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
configId string The id of the configuration that should be deleted.

Return type

void (empty response body)

Authorization

LICENSE-KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: */*

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

getAllConfigs()

getAllConfigs(): \Irisnet\API\Client\Model\Config[]

List all saved AI configurations.

Returns a list of all configurations with their ids and configured prototypes. There is a limit to the number of configurations that can be stored per license key. You can find this limit in the response of the info operation.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: LICENSE-KEY
$config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKey('LICENSE-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('LICENSE-KEY', 'Bearer');


$apiInstance = new Irisnet\API\Client\Api\ConfigurationManagementApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAllConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationManagementApi->getAllConfigs: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Irisnet\API\Client\Model\Config[]

Authorization

LICENSE-KEY

HTTP request headers

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

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

getConfig()

getConfig($configId): \Irisnet\API\Client\Model\Config

Get a specific AI configuration.

Returns a specific AI configuration for the requested id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: LICENSE-KEY
$config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKey('LICENSE-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('LICENSE-KEY', 'Bearer');


$apiInstance = new Irisnet\API\Client\Api\ConfigurationManagementApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$configId = 'configId_example'; // string | The id of the configuration that is being requested.

try {
    $result = $apiInstance->getConfig($configId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationManagementApi->getConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
configId string The id of the configuration that is being requested.

Return type

\Irisnet\API\Client\Model\Config

Authorization

LICENSE-KEY

HTTP request headers

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

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

setConfig()

setConfig($config): \Irisnet\API\Client\Model\Config

Create a new AI configuration.

Create a new AI configuration with the desired prototypes.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: LICENSE-KEY
$config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKey('LICENSE-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('LICENSE-KEY', 'Bearer');


$apiInstance = new Irisnet\API\Client\Api\ConfigurationManagementApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$config = {"name":"first attempt","prototypes":["nudityCheck","ageEstimation","illegalSymbols","attributesCheck","nippleCheck","textRecognition","bodyAttributes","unwantedSubstances","violenceCheck","selfieCheck"]}; // \Irisnet\API\Client\Model\Config | Define the prototypes to use for an AI check operation. View the _Config_ schema to see the available prototypes.

try {
    $result = $apiInstance->setConfig($config);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationManagementApi->setConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
config \Irisnet\API\Client\Model\Config Define the prototypes to use for an AI check operation. View the Config schema to see the available prototypes.

Return type

\Irisnet\API\Client\Model\Config

Authorization

LICENSE-KEY

HTTP request headers

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

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