# OpenAPIClient-php

Artificial Intelligence (AI) for image- and video-processing in realtime.

This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Build package: org.openapitools.codegen.languages.PhpClientCodegen

## Requirements

PHP 5.5 and later

## Installation & Usage

### Composer

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

```json
{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}
```

Then run `composer install`

### Manual Installation

Download the files and include `autoload.php`:

```php
    require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
```

## Tests

To run the unit tests:

```bash
composer install
./vendor/bin/phpunit
```

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

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



$apiInstance = new OpenAPI\Client\Api\AIOperationsApi(
    // 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()
);
$license_key = 'license_key_example'; // string | License obtained from irisnet.de shop.
$detail = 1; // int | Sets the response details. Use 1 for minimum detail (better API performance), 2 for medium details and 3 for all details.
$file = "/path/to/file.txt"; // \SplFileObject | 

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

?>
```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AIOperationsApi* | [**checkImage**](docs/Api/AIOperationsApi.md#checkimage) | **POST** /v1/check-image/{licenseKey} | Upload and check image against previously chosen configuration.
*AIOperationsApi* | [**downloadProcessed**](docs/Api/AIOperationsApi.md#downloadprocessed) | **GET** /v1/download/{filename} | Get the resulting image file.
*AIOperationsApi* | [**setINDefine**](docs/Api/AIOperationsApi.md#setindefine) | **POST** /v1/set-definition | Set the definitions of the pre-defined rule sets.
*AIOperationsApi* | [**setINParams**](docs/Api/AIOperationsApi.md#setinparams) | **POST** /v1/set-parameters | Set the behaviour parameters of the single classifications.
*LicenseKeyOperationsApi* | [**getAICost**](docs/Api/LicenseKeyOperationsApi.md#getaicost) | **GET** /v1/cost | Get the cost of the previously set parameters. The cost of the configuration is subtracted from the license key during each check.
*LicenseKeyOperationsApi* | [**getLicenseInfo**](docs/Api/LicenseKeyOperationsApi.md#getlicenseinfo) | **GET** /v1/info/{licenseKey} | Get information from given license key.


## Documentation For Models

 - [Error](docs/Model/Error.md)
 - [INDefault](docs/Model/INDefault.md)
 - [INDefineAI](docs/Model/INDefineAI.md)
 - [INImage](docs/Model/INImage.md)
 - [INObject](docs/Model/INObject.md)
 - [INParam](docs/Model/INParam.md)
 - [INParams](docs/Model/INParams.md)
 - [INRule](docs/Model/INRule.md)
 - [InlineObject](docs/Model/InlineObject.md)
 - [IrisNet](docs/Model/IrisNet.md)
 - [LicenseInfo](docs/Model/LicenseInfo.md)


## Documentation For Authorization

All endpoints do not require authorization.

## Author