cloudmersive-documentai-api-client

CloudmersiveDocumentaiApiClient - JavaScript client for cloudmersive-documentai-api-client 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 data extraction from documents.

• API version: v1
• Package version: 1.3.2

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

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cloudmersive-documentai-api-client --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your cloudmersive-documentai-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-documentai-api-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CloudmersiveDocumentaiApiClient = require('cloudmersive-documentai-api-client');

var defaultClient = CloudmersiveDocumentaiApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"

var api = new CloudmersiveDocumentaiApiClient.AnalyzeApi()

var opts = { 
  'body': new CloudmersiveDocumentaiApiClient.DocumentQuestionsRequest() // {DocumentQuestionsRequest} Input request, including document and questions
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.answerQuestions(opts, callback);

Documentation for API Endpoints

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

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

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

Documentation for Authorization

Apikey

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