cloudmersive-documentai-api-client 2.2.0

data/docs/RunBatchJobApi.md

@@ -0,0 +1,298 @@
+# CloudmersiveDocumentaiApiClient::RunBatchJobApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**extract_all_fields_and_tables_from_document_batch_job**](RunBatchJobApi.md#extract_all_fields_and_tables_from_document_batch_job) | **POST** /document-ai/document/batch-job/extract/all | Extract All Fields and Tables of Data from a Document using AI as a Batch Job
+[**extract_classification_from_document_batch_job**](RunBatchJobApi.md#extract_classification_from_document_batch_job) | **POST** /document-ai/document/batch-job/extract/classify | Extract Classification or Category from a Document using AI as a Batch Job
+[**extract_fields_from_document_advanced_batch_job**](RunBatchJobApi.md#extract_fields_from_document_advanced_batch_job) | **POST** /document-ai/document/batch-job/extract/fields/advanced | Extract Field Values from a Document using Advanced AI as a Batch Job
+[**extract_text_from_document_batch_job**](RunBatchJobApi.md#extract_text_from_document_batch_job) | **POST** /document-ai/document/batch-job/extract/text | Extract Text from a Document using AI as a Batch Job
+[**get_async_job_status**](RunBatchJobApi.md#get_async_job_status) | **GET** /document-ai/document/batch-job/batch-job/status | Get the status and result of an Extract Document Batch Job
+
+
+# **extract_all_fields_and_tables_from_document_batch_job**
+> ExtractDocumentBatchJobResult extract_all_fields_and_tables_from_document_batch_job(opts)
+
+Extract All Fields and Tables of Data from a Document using AI as a Batch Job
+
+Creates an async batch job for processing a large document as an AI batch job.  Extract all Fields and Tables, comprised of rows and columns of data, from a document using AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-documentai-api-client'
+# setup authorization
+CloudmersiveDocumentaiApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDocumentaiApiClient::RunBatchJobApi.new
+
+opts = { 
+  recognition_mode: 'recognition_mode_example', # String | Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to extract data from
+}
+
+begin
+  #Extract All Fields and Tables of Data from a Document using AI as a Batch Job
+  result = api_instance.extract_all_fields_and_tables_from_document_batch_job(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling RunBatchJobApi->extract_all_fields_and_tables_from_document_batch_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recognition_mode** | **String**| Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images | [optional] 
+ **input_file** | **File**| Input document, or photos of a document, to extract data from | [optional] 
+
+### Return type
+
+[**ExtractDocumentBatchJobResult**](ExtractDocumentBatchJobResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_classification_from_document_batch_job**
+> ExtractDocumentBatchJobResult extract_classification_from_document_batch_job(opts)
+
+Extract Classification or Category from a Document using AI as a Batch Job
+
+Creates an async batch job for processing a large document as an AI batch job.  Extract Classification or Category (e.g. Invoice, Receipt, Tax Form, or Form 1040, Form 1040 EZ, etc.) from a document using AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-documentai-api-client'
+# setup authorization
+CloudmersiveDocumentaiApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDocumentaiApiClient::RunBatchJobApi.new
+
+opts = { 
+  categories: 'categories_example', # String | Desired classification to extract
+  recognition_mode: 'recognition_mode_example', # String | Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to extract data from
+}
+
+begin
+  #Extract Classification or Category from a Document using AI as a Batch Job
+  result = api_instance.extract_classification_from_document_batch_job(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling RunBatchJobApi->extract_classification_from_document_batch_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **categories** | **String**| Desired classification to extract | [optional] 
+ **recognition_mode** | **String**| Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images | [optional] 
+ **input_file** | **File**| Input document, or photos of a document, to extract data from | [optional] 
+
+### Return type
+
+[**ExtractDocumentBatchJobResult**](ExtractDocumentBatchJobResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_fields_from_document_advanced_batch_job**
+> ExtractDocumentBatchJobResult extract_fields_from_document_advanced_batch_job(opts)
+
+Extract Field Values from a Document using Advanced AI as a Batch Job
+
+Creates an async batch job for processing a large document as an AI batch job.  Extract Field Values (e.g. Invoice Number, Invoice Date, Business Card Phone Number, etc.) from a document using Advanced AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-documentai-api-client'
+# setup authorization
+CloudmersiveDocumentaiApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDocumentaiApiClient::RunBatchJobApi.new
+
+opts = { 
+  recognition_mode: 'recognition_mode_example', # String | Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  body: CloudmersiveDocumentaiApiClient::AdvancedExtractFieldsRequest.new # AdvancedExtractFieldsRequest | 
+}
+
+begin
+  #Extract Field Values from a Document using Advanced AI as a Batch Job
+  result = api_instance.extract_fields_from_document_advanced_batch_job(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling RunBatchJobApi->extract_fields_from_document_advanced_batch_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recognition_mode** | **String**| Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images | [optional] 
+ **body** | [**AdvancedExtractFieldsRequest**](AdvancedExtractFieldsRequest.md)|  | [optional] 
+
+### Return type
+
+[**ExtractDocumentBatchJobResult**](ExtractDocumentBatchJobResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_text_from_document_batch_job**
+> ExtractDocumentBatchJobResult extract_text_from_document_batch_job(opts)
+
+Extract Text from a Document using AI as a Batch Job
+
+Creates an async batch job for processing a large document as an AI batch job.  Input document formats supported include DOCX, PDF, PNG and JPG.  Supports a wide range of languages.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-documentai-api-client'
+# setup authorization
+CloudmersiveDocumentaiApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDocumentaiApiClient::RunBatchJobApi.new
+
+opts = { 
+  recognition_mode: 'recognition_mode_example', # String | Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to extract data from
+}
+
+begin
+  #Extract Text from a Document using AI as a Batch Job
+  result = api_instance.extract_text_from_document_batch_job(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling RunBatchJobApi->extract_text_from_document_batch_job: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recognition_mode** | **String**| Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images | [optional] 
+ **input_file** | **File**| Input document, or photos of a document, to extract data from | [optional] 
+
+### Return type
+
+[**ExtractDocumentBatchJobResult**](ExtractDocumentBatchJobResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **get_async_job_status**
+> ExtractDocumentJobStatusResult get_async_job_status(opts)
+
+Get the status and result of an Extract Document Batch Job
+
+Returns the result of the Async Job - possible states can be STARTED or COMPLETED.  This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-documentai-api-client'
+# setup authorization
+CloudmersiveDocumentaiApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDocumentaiApiClient::RunBatchJobApi.new
+
+opts = { 
+  async_job_id: 'async_job_id_example' # String | 
+}
+
+begin
+  #Get the status and result of an Extract Document Batch Job
+  result = api_instance.get_async_job_status(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling RunBatchJobApi->get_async_job_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **async_job_id** | **String**|  | [optional] 
+
+### Return type
+
+[**ExtractDocumentJobStatusResult**](ExtractDocumentJobStatusResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain, application/json, text/json
+
+
+

data/docs/SummarizeDocumentResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::SummarizeDocumentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**document_summary_text** | **String** | Summary of the document | [optional] 
+
+

data/docs/TableResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::TableResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Title of the table (optional) | [optional] 
+**rows** | [**Array<TableResultRow>**](TableResultRow.md) | Rows of the table | [optional] 
+
+

data/docs/TableResultCell.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::TableResultCell
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cell_header** | **String** | Cell column header | [optional] 
+**cell_value** | **String** | Cell value as a string | [optional] 
+
+

data/docs/TableResultRow.md

@@ -0,0 +1,8 @@
+# CloudmersiveDocumentaiApiClient::TableResultRow
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cells** | [**Array<TableResultCell>**](TableResultCell.md) | Cells in the row | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/cloudmersive-documentai-api-client/api/analyze_api.rb

@@ -0,0 +1,73 @@
+=begin
+#Document AI API
+
+#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveDocumentaiApiClient
+  class AnalyzeApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Enforce Policies to a Document to allow or block it using Advanced AI
+    # Enforce Policies to a Document to allow or block it using Advanced AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+    # @param [Hash] opts the optional parameters
+    # @option opts [DocumentPolicyRequest] :body Input request, including document and policy rules
+    # @return [DocumentPolicyResult]
+    def apply_rules(opts = {})
+      data, _status_code, _headers = apply_rules_with_http_info(opts)
+      data
+    end
+
+    # Enforce Policies to a Document to allow or block it using Advanced AI
+    # Enforce Policies to a Document to allow or block it using Advanced AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+    # @param [Hash] opts the optional parameters
+    # @option opts [DocumentPolicyRequest] :body Input request, including document and policy rules
+    # @return [Array<(DocumentPolicyResult, Fixnum, Hash)>] DocumentPolicyResult data, response status code and response headers
+    def apply_rules_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyzeApi.apply_rules ...'
+      end
+      # resource path
+      local_var_path = '/document-ai/document/analyze/enforce-policy'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DocumentPolicyResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyzeApi#apply_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end