cloudmersive-documentai-api-client 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f396a4b31059a378e018961b2681b03f16701b80ecbb435d31139e57a218daf7
+  data.tar.gz: 6ca03d63a92d772dae91392dd94059822b6b9ae8177a9a9e7dc3cacbbcb57af8
+SHA512:
+  metadata.gz: 5dfebaf16d563952a730d65f962eb0d93504475561707b720fa12b6d01816400424859f051fa43bd1f287ec76691aee4e1d03a0b92285070aefe8a5da886c0e8
+  data.tar.gz: 0211efc337baf968845383aba65bbe987f3d67ef5afe6e7001b1fa97124e68d503be097de00cd18b060405196200f53a8892f4bb7191eaa98c459b20b13db1ce

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,140 @@
+# cloudmersive-documentai-api-client
+
+CloudmersiveDocumentaiApiClient - the Ruby gem for the Document AI API
+
+Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.2.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-documentai-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-documentai-api-client-2.2.0.gem
+```
+(for development, run `gem install --dev ./cloudmersive-documentai-api-client-2.2.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'cloudmersive-documentai-api-client', '~> 2.2.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cloudmersive-documentai-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```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::AnalyzeApi.new
+
+opts = { 
+  body: CloudmersiveDocumentaiApiClient::DocumentPolicyRequest.new # DocumentPolicyRequest | Input request, including document and policy rules
+}
+
+begin
+  #Enforce Policies to a Document to allow or block it using Advanced AI
+  result = api_instance.apply_rules(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling AnalyzeApi->apply_rules: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveDocumentaiApiClient::AnalyzeApi* | [**apply_rules**](docs/AnalyzeApi.md#apply_rules) | **POST** /document-ai/document/analyze/enforce-policy | Enforce Policies to a Document to allow or block it using Advanced AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_all_fields_and_tables**](docs/ExtractApi.md#extract_all_fields_and_tables) | **POST** /document-ai/document/extract/all | Extract All Fields and Tables of Data from a Document using AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_barcodes**](docs/ExtractApi.md#extract_barcodes) | **POST** /document-ai/document/extract/barcodes | Extract Barcodes of from a Document using AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_classification**](docs/ExtractApi.md#extract_classification) | **POST** /document-ai/document/extract/classify | Extract Classification or Category from a Document using AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_classification_advanced**](docs/ExtractApi.md#extract_classification_advanced) | **POST** /document-ai/document/extract/classify/advanced | Extract Classification or Category from a Document using Advanced AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_fields**](docs/ExtractApi.md#extract_fields) | **POST** /document-ai/document/extract/fields | Extract Field Values from a Document using AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_fields_advanced**](docs/ExtractApi.md#extract_fields_advanced) | **POST** /document-ai/document/extract/fields/advanced | Extract Field Values from a Document using Advanced AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_summary**](docs/ExtractApi.md#extract_summary) | **POST** /document-ai/document/extract/summary | Extract Summary from a Document using AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_tables**](docs/ExtractApi.md#extract_tables) | **POST** /document-ai/document/extract/tables | Extract Tables of Data from a Document using AI
+*CloudmersiveDocumentaiApiClient::ExtractApi* | [**extract_text**](docs/ExtractApi.md#extract_text) | **POST** /document-ai/document/extract/text | Extract Text from a Document using AI
+*CloudmersiveDocumentaiApiClient::RunBatchJobApi* | [**extract_all_fields_and_tables_from_document_batch_job**](docs/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
+*CloudmersiveDocumentaiApiClient::RunBatchJobApi* | [**extract_classification_from_document_batch_job**](docs/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
+*CloudmersiveDocumentaiApiClient::RunBatchJobApi* | [**extract_fields_from_document_advanced_batch_job**](docs/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
+*CloudmersiveDocumentaiApiClient::RunBatchJobApi* | [**extract_text_from_document_batch_job**](docs/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
+*CloudmersiveDocumentaiApiClient::RunBatchJobApi* | [**get_async_job_status**](docs/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
+
+
+## Documentation for Models
+
+ - [CloudmersiveDocumentaiApiClient::AdvancedExtractClassificationRequest](docs/AdvancedExtractClassificationRequest.md)
+ - [CloudmersiveDocumentaiApiClient::AdvancedExtractFieldsRequest](docs/AdvancedExtractFieldsRequest.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentAdvancedClassificationResult](docs/DocumentAdvancedClassificationResult.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentCategories](docs/DocumentCategories.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentClassificationResult](docs/DocumentClassificationResult.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentPolicyRequest](docs/DocumentPolicyRequest.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentPolicyResult](docs/DocumentPolicyResult.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractBarcodesAiResponse](docs/ExtractBarcodesAiResponse.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractDocumentBatchJobResult](docs/ExtractDocumentBatchJobResult.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractDocumentJobStatusResult](docs/ExtractDocumentJobStatusResult.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractFieldsAndTablesResponse](docs/ExtractFieldsAndTablesResponse.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractFieldsResponse](docs/ExtractFieldsResponse.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractTablesResponse](docs/ExtractTablesResponse.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractTextResponse](docs/ExtractTextResponse.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractedBarcodeItem](docs/ExtractedBarcodeItem.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractedTextPage](docs/ExtractedTextPage.md)
+ - [CloudmersiveDocumentaiApiClient::FieldToExtract](docs/FieldToExtract.md)
+ - [CloudmersiveDocumentaiApiClient::FieldValue](docs/FieldValue.md)
+ - [CloudmersiveDocumentaiApiClient::PolicyRule](docs/PolicyRule.md)
+ - [CloudmersiveDocumentaiApiClient::PolicyRuleViolation](docs/PolicyRuleViolation.md)
+ - [CloudmersiveDocumentaiApiClient::SummarizeDocumentResponse](docs/SummarizeDocumentResponse.md)
+ - [CloudmersiveDocumentaiApiClient::TableResult](docs/TableResult.md)
+ - [CloudmersiveDocumentaiApiClient::TableResultCell](docs/TableResultCell.md)
+ - [CloudmersiveDocumentaiApiClient::TableResultRow](docs/TableResultRow.md)
+
+
+## Documentation for Authorization
+
+
+### Apikey
+
+- **Type**: API key
+- **API key parameter name**: Apikey
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/cloudmersive-documentai-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudmersive-documentai-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-documentai-api-client"
+  s.version     = CloudmersiveDocumentaiApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://cloudmersive.com/document-ai-api"
+  s.summary     = "Use next-generation AI to extract data, fields, insights and text from documents. Instantly."
+  s.description = "Use next-generation AI to extract data, fields, insights and text from documents. Instantly."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = Dir['./**/*']
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/AdvancedExtractClassificationRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::AdvancedExtractClassificationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file** | **String** | Input document file to perform the operation on as a byte array | [optional] 
+**categories** | [**Array<DocumentCategories>**](DocumentCategories.md) | Possible categories for the document | [optional] 
+**maximum_pages_processed** | **Integer** | Optional: Limit the number of pages processed | [optional] 
+
+

data/docs/AdvancedExtractFieldsRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::AdvancedExtractFieldsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file** | **String** | Input document file to perform the operation on as a byte array | [optional] 
+**fields_to_extract** | [**Array<FieldToExtract>**](FieldToExtract.md) | Fields to extract from the document | [optional] 
+**maximum_pages_processed** | **Integer** | Optional: Limit the number of pages processed | [optional] 
+
+

data/docs/AnalyzeApi.md

@@ -0,0 +1,64 @@
+# CloudmersiveDocumentaiApiClient::AnalyzeApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**apply_rules**](AnalyzeApi.md#apply_rules) | **POST** /document-ai/document/analyze/enforce-policy | Enforce Policies to a Document to allow or block it using Advanced AI
+
+
+# **apply_rules**
+> DocumentPolicyResult apply_rules(opts)
+
+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.
+
+### 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::AnalyzeApi.new
+
+opts = { 
+  body: CloudmersiveDocumentaiApiClient::DocumentPolicyRequest.new # DocumentPolicyRequest | Input request, including document and policy rules
+}
+
+begin
+  #Enforce Policies to a Document to allow or block it using Advanced AI
+  result = api_instance.apply_rules(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling AnalyzeApi->apply_rules: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DocumentPolicyRequest**](DocumentPolicyRequest.md)| Input request, including document and policy rules | [optional] 
+
+### Return type
+
+[**DocumentPolicyResult**](DocumentPolicyResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+

data/docs/DocumentAdvancedClassificationResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::DocumentAdvancedClassificationResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**document_category_result** | **String** | Category applied to the document; if a category could not be identified then \"other\" will be used.  Spaces are replaced with underscores. | [optional] 
+
+

data/docs/DocumentCategories.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::DocumentCategories
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category_name** | **String** | Name of the classification | [optional] 
+**category_description** | **String** | Optional but recommended: Description of the classification in natural langugage | [optional] 
+
+

data/docs/DocumentClassificationResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::DocumentClassificationResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**document_category_result** | **String** | Category applied to the document; if a category could not be identified then \"other\" will be used.  Spaces are replaced with underscores. | [optional] 
+
+

data/docs/DocumentPolicyRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::DocumentPolicyRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file** | **String** | Input file as a byte array | [optional] 
+**rules** | [**Array<PolicyRule>**](PolicyRule.md) | Rules to apply to the document | [optional] 
+
+

data/docs/DocumentPolicyResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::DocumentPolicyResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if the document complies with all of the policies, and false if it does not | [optional] 
+**risk_score** | **Float** | Risk score between 0.0 and 1.0 where values above 0.5 are increasing levels of risk | [optional] 
+**rule_violations** | [**Array<PolicyRuleViolation>**](PolicyRuleViolation.md) | Policy violations | [optional] 
+
+