README

Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI. Also supports handwriting and low quality photos and scans, as well as digital document input. Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.

Cloudmersive Document AI API provides advanced field and data extraction capabilities.

• API version: v1
• Package version: 3.2.1

For more information, please visit https://www.cloudmersive.com

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/cloudmersive/cloudmersive_documentai_api_client.git"
    }
  ],
  "require": {
    "cloudmersive/cloudmersive_documentai_api_client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cloudmersive_documentai_api_client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

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

$apiInstance = new Swagger\Client\Api\AnalyzeApi(
    // 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
);
$body = new \Swagger\Client\Model\DocumentQuestionsRequest(); // \Swagger\Client\Model\DocumentQuestionsRequest | Input request, including document and questions

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

?>

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Documentation For Models

• AdvancedExtractClassificationRequest
• AdvancedExtractFieldsRequest
• DocumentAdvancedClassificationResult
• DocumentCategories
• DocumentClassificationResult
• DocumentPolicyRequest
• DocumentPolicyResult
• DocumentQuestionAnswerItem
• DocumentQuestionAnswersResult
• DocumentQuestionBoolean
• DocumentQuestionChoiceItem
• DocumentQuestionFreeResponse
• DocumentQuestionMultipleChoice
• DocumentQuestionsRequest
• ExtractBarcodesAiResponse
• ExtractDocumentBatchJobResult
• ExtractDocumentJobStatusResult
• ExtractFieldsAdvancedResponse
• ExtractFieldsAndTablesResponse
• ExtractFieldsResponse
• ExtractTablesResponse
• ExtractTextResponse
• ExtractedBarcodeItem
• ExtractedTextPage
• FieldAdvancedValue
• FieldToExtract
• FieldValue
• PolicyRule
• PolicyRuleViolation
• SplitDocumentResponse
• SubDocument
• SummarizeDocumentResponse
• TableResult
• TableResultCell
• TableResultRow

Documentation For Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header

Author

support@cloudmersive.com