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

Class	Method	HTTP request	Description
AnalyzeApi	answerQuestions	POST /document-ai/document/analyze/answer-questions	Answer Questions about a Document in a structured way using Advanced AI
AnalyzeApi	applyRules	POST /document-ai/document/analyze/enforce-policy	Enforce Policies to a Document to allow or block it using Advanced AI
ExtractApi	extractAllFieldsAndTables	POST /document-ai/document/extract/all	Extract All Fields and Tables of Data from a Document using AI
ExtractApi	extractBarcodes	POST /document-ai/document/extract/barcodes	Extract Barcodes of from a Document using AI
ExtractApi	extractClassification	POST /document-ai/document/extract/classify	Extract Classification or Category from a Document using AI
ExtractApi	extractClassificationAdvanced	POST /document-ai/document/extract/classify/advanced	Extract Classification or Category from a Document using Advanced AI
ExtractApi	extractFields	POST /document-ai/document/extract/fields	Extract Field Values from a Document using AI
ExtractApi	extractFieldsAdvanced	POST /document-ai/document/extract/fields/advanced	Extract Field Values from a Document using Advanced AI
ExtractApi	extractSplit	POST /document-ai/document/extract/split	Intelligently Split a Combined Document into Sub-Documents using AI
ExtractApi	extractSummary	POST /document-ai/document/extract/summary	Extract Summary from a Document using AI
ExtractApi	extractTables	POST /document-ai/document/extract/tables	Extract Tables of Data from a Document using AI
ExtractApi	extractText	POST /document-ai/document/extract/text	Extract Text from a Document using AI
RunBatchJobApi	extractAllFieldsAndTablesFromDocumentBatchJob	POST /document-ai/document/batch-job/extract/all	Extract All Fields and Tables of Data from a Document using AI as a Batch Job
RunBatchJobApi	extractClassificationFromDocumentBatchJob	POST /document-ai/document/batch-job/extract/classify	Extract Classification or Category from a Document using AI as a Batch Job
RunBatchJobApi	extractFieldsFromDocumentAdvancedBatchJob	POST /document-ai/document/batch-job/extract/fields/advanced	Extract Field Values from a Document using Advanced AI as a Batch Job
RunBatchJobApi	extractTextFromDocumentBatchJob	POST /document-ai/document/batch-job/extract/text	Extract Text from a Document using AI as a Batch Job
RunBatchJobApi	getAsyncJobStatus	GET /document-ai/document/batch-job/batch-job/status	Get the status and result of an Extract Document Batch Job

Documentation For Models

Documentation For Authorization

Apikey

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

Author

support@cloudmersive.com

cloudmersive / cloudmersive_documentai_api_client

Maintainers

Details