Skip to content

EndpointsForAIChecksApi.md

Latest commit

 

History

History
126 lines (84 loc) · 4.73 KB

EndpointsForAIChecksApi.md

File metadata and controls

126 lines (84 loc) · 4.73 KB

Irisnet\API\Client\EndpointsForAIChecksApi

All URIs are relative to https://api.irisnet.de

Method HTTP request Description
checkImage POST /v1/check-image/{licenseKey} Upload and check image against previously chosen configuration.
checkImageUrl POST /v1/check-url/{licenseKey} Check image url against previously chosen configuration.

checkImage

\Irisnet\API\Client\Model\IrisNet checkImage($licenseKey, $detail, $file)

Upload and check image against previously chosen configuration.

Example

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


$apiInstance = new Irisnet\API\Client\Api\EndpointsForAIChecksApi(
    // 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()
);
$licenseKey = 'licenseKey_example'; // string | License obtained from irisnet.de shop.
$detail = 1; // int | Sets the response details.  * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information.
$file = "/path/to/file.txt"; // \SplFileObject | 

try {
    $result = $apiInstance->checkImage($licenseKey, $detail, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsForAIChecksApi->checkImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
licenseKey string License obtained from irisnet.de shop.
detail int Sets the response details. * 1 - The response body informs you if the image is ok or not ok (better API performance) * 2 - In addition the response body lists all broken rules. * 3 - In addition to the first two options, this will show all objects with positional information. [optional] [default to 1]
file \SplFileObject**\SplFileObject** [optional]

Return type

\Irisnet\API\Client\Model\IrisNet

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/xml, application/json

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

checkImageUrl

\Irisnet\API\Client\Model\IrisNet checkImageUrl($url, $licenseKey, $detail)

Check image url against previously chosen configuration.

Example

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


$apiInstance = new Irisnet\API\Client\Api\EndpointsForAIChecksApi(
    // 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()
);
$url = 'url_example'; // string | 
$licenseKey = 'licenseKey_example'; // string | License obtained from irisnet.de shop.
$detail = 1; // int | Sets the response details.  * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information.

try {
    $result = $apiInstance->checkImageUrl($url, $licenseKey, $detail);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsForAIChecksApi->checkImageUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
url string
licenseKey string License obtained from irisnet.de shop.
detail int Sets the response details. * 1 - The response body informs you if the image is ok or not ok (better API performance) * 2 - In addition the response body lists all broken rules. * 3 - In addition to the first two options, this will show all objects with positional information. [optional] [default to 1]

Return type

\Irisnet\API\Client\Model\IrisNet

Authorization

No authorization required

HTTP request headers

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

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