cloudmersive-documentai-api-client 2.2.0

data/docs/ExtractApi.md

@@ -0,0 +1,534 @@
+# CloudmersiveDocumentaiApiClient::ExtractApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**extract_all_fields_and_tables**](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
+[**extract_barcodes**](ExtractApi.md#extract_barcodes) | **POST** /document-ai/document/extract/barcodes | Extract Barcodes of from a Document using AI
+[**extract_classification**](ExtractApi.md#extract_classification) | **POST** /document-ai/document/extract/classify | Extract Classification or Category from a Document using AI
+[**extract_classification_advanced**](ExtractApi.md#extract_classification_advanced) | **POST** /document-ai/document/extract/classify/advanced | Extract Classification or Category from a Document using Advanced AI
+[**extract_fields**](ExtractApi.md#extract_fields) | **POST** /document-ai/document/extract/fields | Extract Field Values from a Document using AI
+[**extract_fields_advanced**](ExtractApi.md#extract_fields_advanced) | **POST** /document-ai/document/extract/fields/advanced | Extract Field Values from a Document using Advanced AI
+[**extract_summary**](ExtractApi.md#extract_summary) | **POST** /document-ai/document/extract/summary | Extract Summary from a Document using AI
+[**extract_tables**](ExtractApi.md#extract_tables) | **POST** /document-ai/document/extract/tables | Extract Tables of Data from a Document using AI
+[**extract_text**](ExtractApi.md#extract_text) | **POST** /document-ai/document/extract/text | Extract Text from a Document using AI
+
+
+# **extract_all_fields_and_tables**
+> ExtractFieldsAndTablesResponse extract_all_fields_and_tables(opts)
+
+Extract All Fields and Tables of Data from a Document using AI
+
+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::ExtractApi.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
+  result = api_instance.extract_all_fields_and_tables(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_all_fields_and_tables: #{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
+
+[**ExtractFieldsAndTablesResponse**](ExtractFieldsAndTablesResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_barcodes**
+> ExtractBarcodesAiResponse extract_barcodes(opts)
+
+Extract Barcodes of from a Document using AI
+
+Extract all barcodes 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::ExtractApi.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 Barcodes of from a Document using AI
+  result = api_instance.extract_barcodes(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_barcodes: #{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
+
+[**ExtractBarcodesAiResponse**](ExtractBarcodesAiResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_classification**
+> DocumentClassificationResult extract_classification(opts)
+
+Extract Classification or Category from a Document using AI
+
+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::ExtractApi.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
+  result = api_instance.extract_classification(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_classification: #{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
+
+[**DocumentClassificationResult**](DocumentClassificationResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_classification_advanced**
+> DocumentAdvancedClassificationResult extract_classification_advanced(opts)
+
+Extract Classification or Category from a Document using Advanced AI
+
+Extract Classification or Category (e.g. Invoice, Receipt, Tax Form, or Form 1040, Form 1040 EZ, 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::ExtractApi.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::AdvancedExtractClassificationRequest.new # AdvancedExtractClassificationRequest | Input request to perform the classification on
+}
+
+begin
+  #Extract Classification or Category from a Document using Advanced AI
+  result = api_instance.extract_classification_advanced(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_classification_advanced: #{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** | [**AdvancedExtractClassificationRequest**](AdvancedExtractClassificationRequest.md)| Input request to perform the classification on | [optional] 
+
+### Return type
+
+[**DocumentAdvancedClassificationResult**](DocumentAdvancedClassificationResult.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_fields**
+> ExtractFieldsResponse extract_fields(opts)
+
+Extract Field Values from a Document using AI
+
+Extract Field Values (e.g. Invoice Number, Invoice Date, Business Card Phone Number, 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::ExtractApi.new
+
+opts = { 
+  field_names: 'field_names_example', # String | Desired fields to extract, comma separated
+  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 Field Values from a Document using AI
+  result = api_instance.extract_fields(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_fields: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **field_names** | **String**| Desired fields to extract, comma separated | [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
+
+[**ExtractFieldsResponse**](ExtractFieldsResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_fields_advanced**
+> ExtractFieldsResponse extract_fields_advanced(opts)
+
+Extract Field Values from a Document using Advanced AI
+
+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::ExtractApi.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 | Input request, including document file as byte array, and information on which fields to extract
+}
+
+begin
+  #Extract Field Values from a Document using Advanced AI
+  result = api_instance.extract_fields_advanced(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_fields_advanced: #{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)| Input request, including document file as byte array, and information on which fields to extract | [optional] 
+
+### Return type
+
+[**ExtractFieldsResponse**](ExtractFieldsResponse.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_summary**
+> SummarizeDocumentResponse extract_summary(opts)
+
+Extract Summary from a Document using AI
+
+Creates a 1 paragraph summary of the input document using Artificial Intelligence.  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::ExtractApi.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 Summary from a Document using AI
+  result = api_instance.extract_summary(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_summary: #{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
+
+[**SummarizeDocumentResponse**](SummarizeDocumentResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_tables**
+> ExtractTablesResponse extract_tables(opts)
+
+Extract Tables of Data from a Document using AI
+
+Extract 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::ExtractApi.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 Tables of Data from a Document using AI
+  result = api_instance.extract_tables(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_tables: #{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
+
+[**ExtractTablesResponse**](ExtractTablesResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **extract_text**
+> ExtractTextResponse extract_text(opts)
+
+Extract Text from a Document using AI
+
+Extract raw text from a document using AI.  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::ExtractApi.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
+  result = api_instance.extract_text(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_text: #{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
+
+[**ExtractTextResponse**](ExtractTextResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+

data/docs/ExtractBarcodesAiResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::ExtractBarcodesAiResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**barcode_results** | [**Array<ExtractedBarcodeItem>**](ExtractedBarcodeItem.md) | Table value results from the extraction operation | [optional] 
+
+

data/docs/ExtractDocumentBatchJobResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::ExtractDocumentBatchJobResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**async_job_id** | **String** | When creating a job, an Async Job ID is returned.  Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes | [optional] 
+
+

data/docs/ExtractDocumentJobStatusResult.md

@@ -0,0 +1,15 @@
+# CloudmersiveDocumentaiApiClient::ExtractDocumentJobStatusResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation to check the status of the job was successful, false otherwise | [optional] 
+**async_job_status** | **String** | Returns the job status of the Async Job, if applicable.  Possible states are STARTED and COMPLETED | [optional] 
+**async_job_id** | **String** | Job ID | [optional] 
+**extract_text_result** | [**ExtractTextResponse**](ExtractTextResponse.md) |  | [optional] 
+**extract_fields_and_tables_result** | [**ExtractFieldsAndTablesResponse**](ExtractFieldsAndTablesResponse.md) |  | [optional] 
+**extract_fields_result** | [**ExtractFieldsResponse**](ExtractFieldsResponse.md) |  | [optional] 
+**extract_classification_result** | [**DocumentClassificationResult**](DocumentClassificationResult.md) |  | [optional] 
+**error_message** | **String** | Error message (if any) | [optional] 
+
+

data/docs/ExtractFieldsAndTablesResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::ExtractFieldsAndTablesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**field_results** | [**Array<FieldValue>**](FieldValue.md) | Field value results from the extraction operation | [optional] 
+**table_results** | [**Array<TableResult>**](TableResult.md) | Table value results from the extraction operation | [optional] 
+
+

data/docs/ExtractFieldsResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::ExtractFieldsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**results** | [**Array<FieldValue>**](FieldValue.md) | Field value results from the extraction operation | [optional] 
+
+

data/docs/ExtractTablesResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::ExtractTablesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**table_results** | [**Array<TableResult>**](TableResult.md) | Table value results from the extraction operation | [optional] 
+
+

data/docs/ExtractTextResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::ExtractTextResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**page_results** | [**Array<ExtractedTextPage>**](ExtractedTextPage.md) | Page results from the extraction operation | [optional] 
+
+

data/docs/ExtractedBarcodeItem.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::ExtractedBarcodeItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**barcode_type** | **String** | Type of the barcode identified, possible values are: AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB, UNKNOWN | [optional] 
+**barcode_value** | **String** | Value of the barcode as a string | [optional] 
+
+

data/docs/ExtractedTextPage.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::ExtractedTextPage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_number** | **Integer** | Page number index, 1-based | [optional] 
+**text_result** | **String** | Text content of the page | [optional] 
+
+

data/docs/FieldToExtract.md

@@ -0,0 +1,11 @@
+# CloudmersiveDocumentaiApiClient::FieldToExtract
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_name** | **String** | Name of the field to extract | [optional] 
+**field_optional** | **BOOLEAN** | Optional: True if the field is optional, false if required (default) | [optional] 
+**field_description** | **String** | Optional but recommended: Description of the field - use this to describe what the field is, how it is formatted, what is unique about it, etc. | [optional] 
+**field_example** | **String** | Optional: Example label or value of the field | [optional] 
+
+

data/docs/FieldValue.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::FieldValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_name** | **String** | Name of the field (note that spaces will be replaced with underscore) | [optional] 
+**field_string_value** | **String** | String value of the field that was extractged from the document | [optional] 
+
+

data/docs/PolicyRule.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::PolicyRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule_id** | **String** |  | [optional] 
+**rule_type** | **String** | Possible values are ALLOW and DENY | [optional] 
+**rule_description** | **String** | Description of the rule in natural language, e.g. Do not allow documents that contain offensive language | [optional] 
+
+

data/docs/PolicyRuleViolation.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::PolicyRuleViolation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule_id** | **String** | ID of the rule; if no ID was supplied, the ID is the 1-based index of the rule | [optional] 
+**rule_violation_risk_score** | **Float** | Risk score between 0.0 and 1.0 where values above 0.5 are increasing levels of risk | [optional] 
+**rule_violation_rationale** | **String** | AI natural language rationale for why this policy was violated | [optional] 
+
+