cloudmersive-documentai-api-client 2.2.0 → 2.2.1

checksums.yaml

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

data/README.md

@@ -2,13 +2,14 @@
 
 CloudmersiveDocumentaiApiClient - the Ruby gem for the Document AI API
 
-Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+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.
 
 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
+- Package version: 2.2.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.cloudmersive.com](https://www.cloudmersive.com)
 
 ## Installation
 
@@ -23,15 +24,15 @@ gem build cloudmersive-documentai-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-documentai-api-client-2.2.0.gem
+gem install ./cloudmersive-documentai-api-client-2.2.1.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-documentai-api-client-2.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-documentai-api-client-2.2.1.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'
+    gem 'cloudmersive-documentai-api-client', '~> 2.2.1'
 
 ### Install from Git
 
@@ -65,25 +66,26 @@ end
 api_instance = CloudmersiveDocumentaiApiClient::AnalyzeApi.new
 
 opts = { 
-  body: CloudmersiveDocumentaiApiClient::DocumentPolicyRequest.new # DocumentPolicyRequest | Input request, including document and policy rules
+  body: CloudmersiveDocumentaiApiClient::DocumentQuestionsRequest.new # DocumentQuestionsRequest | Input request, including document and questions
 }
 
 begin
-  #Enforce Policies to a Document to allow or block it using Advanced AI
-  result = api_instance.apply_rules(opts)
+  #Answer Questions about a Document in a structured way using Advanced AI
+  result = api_instance.answer_questions(opts)
   p result
 rescue CloudmersiveDocumentaiApiClient::ApiError => e
-  puts "Exception when calling AnalyzeApi->apply_rules: #{e}"
+  puts "Exception when calling AnalyzeApi->answer_questions: #{e}"
 end
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.cloudmersive.com*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*CloudmersiveDocumentaiApiClient::AnalyzeApi* | [**answer_questions**](docs/AnalyzeApi.md#answer_questions) | **POST** /document-ai/document/analyze/answer-questions | Answer Questions about a Document in a structured way using Advanced AI
 *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
@@ -91,6 +93,7 @@ Class | Method | HTTP request | Description
 *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_split**](docs/ExtractApi.md#extract_split) | **POST** /document-ai/document/extract/split | Intelligently Split a Combined Document into Sub-Documents using 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
@@ -110,19 +113,30 @@ Class | Method | HTTP request | Description
  - [CloudmersiveDocumentaiApiClient::DocumentClassificationResult](docs/DocumentClassificationResult.md)
  - [CloudmersiveDocumentaiApiClient::DocumentPolicyRequest](docs/DocumentPolicyRequest.md)
  - [CloudmersiveDocumentaiApiClient::DocumentPolicyResult](docs/DocumentPolicyResult.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentQuestionAnswerItem](docs/DocumentQuestionAnswerItem.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentQuestionAnswersResult](docs/DocumentQuestionAnswersResult.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentQuestionBoolean](docs/DocumentQuestionBoolean.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentQuestionChoiceItem](docs/DocumentQuestionChoiceItem.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentQuestionFreeResponse](docs/DocumentQuestionFreeResponse.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentQuestionMultipleChoice](docs/DocumentQuestionMultipleChoice.md)
+ - [CloudmersiveDocumentaiApiClient::DocumentQuestionsRequest](docs/DocumentQuestionsRequest.md)
  - [CloudmersiveDocumentaiApiClient::ExtractBarcodesAiResponse](docs/ExtractBarcodesAiResponse.md)
  - [CloudmersiveDocumentaiApiClient::ExtractDocumentBatchJobResult](docs/ExtractDocumentBatchJobResult.md)
  - [CloudmersiveDocumentaiApiClient::ExtractDocumentJobStatusResult](docs/ExtractDocumentJobStatusResult.md)
+ - [CloudmersiveDocumentaiApiClient::ExtractFieldsAdvancedResponse](docs/ExtractFieldsAdvancedResponse.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::FieldAdvancedValue](docs/FieldAdvancedValue.md)
  - [CloudmersiveDocumentaiApiClient::FieldToExtract](docs/FieldToExtract.md)
  - [CloudmersiveDocumentaiApiClient::FieldValue](docs/FieldValue.md)
  - [CloudmersiveDocumentaiApiClient::PolicyRule](docs/PolicyRule.md)
  - [CloudmersiveDocumentaiApiClient::PolicyRuleViolation](docs/PolicyRuleViolation.md)
+ - [CloudmersiveDocumentaiApiClient::SplitDocumentResponse](docs/SplitDocumentResponse.md)
+ - [CloudmersiveDocumentaiApiClient::SubDocument](docs/SubDocument.md)
  - [CloudmersiveDocumentaiApiClient::SummarizeDocumentResponse](docs/SummarizeDocumentResponse.md)
  - [CloudmersiveDocumentaiApiClient::TableResult](docs/TableResult.md)
  - [CloudmersiveDocumentaiApiClient::TableResultCell](docs/TableResultCell.md)

data/cloudmersive-documentai-api-client.gemspec

@@ -3,10 +3,10 @@
 =begin
 #Document AI API
 
-#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+#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.
 
 OpenAPI spec version: v1
-
+Contact: support@cloudmersive.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.14
 
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.version     = CloudmersiveDocumentaiApiClient::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Cloudmersive"]
-  s.email       = [""]
+  s.email       = ["support@cloudmersive.com"]
   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."

data/docs/AdvancedExtractClassificationRequest.md

@@ -5,6 +5,9 @@ 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] 
+**preprocessing** | **String** | Optional: Set the level of image pre-processing to enhance accuracy.  Possible values are 'Auto', 'SmoothEdges', 'SmoothEdgesPlus', 'Compatability' and 'None'.  Default is Auto.  Set to SmoothEdges to smooth harsh edges in the input image to enhance recognition accuracy.  Set to SmoothEdgesPlus to smooth harsh edges to a higher degree.  Set to Compatability for maximum PDF feature compatability. | [optional] 
+**result_cross_check** | **String** | Optional: Set the level of output accuracy cross-checking to perform on the input.  Possible values are 'None', 'Advanced', 'Ultra' and 'Hyper'.  Default is None.  Ultra and Hyper will produce the highest accuracy but at the cost of longer processing times. | [optional] 
 **maximum_pages_processed** | **Integer** | Optional: Limit the number of pages processed | [optional] 
+**rotate_image_degrees** | **Float** | Optional: Rotate the input image before recognition by the specified number of degrees; valid values range from -360 to +360. | [optional] 
 
 

data/docs/AdvancedExtractFieldsRequest.md

@@ -6,5 +6,8 @@ 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] 
+**preprocessing** | **String** | Optional: Set the level of image pre-processing to enhance accuracy.  Possible values are 'Auto', 'SmoothEdges', 'SmoothEdgesPlus', 'ContrastEdges', 'ContrastEdgesPlus', 'Invert', 'Binarize', 'Compatability' and 'None'.  Default is Auto.  Set to SmoothEdges to smooth harsh edges in the input image to enhance recognition accuracy.  Set to SmoothEdgesPlus to smooth harsh edges to a higher degree.  Set to ContrastEdges and ContrastEdgesPlus to enhance contrast and readability for low quality black and white or grayscale images.  Set to Invert to invert the input image.  Set to Binarize to binarize the input image.  Set to Compatability for maximum PDF feature compatability. | [optional] 
+**result_cross_check** | **String** | Optional: Set the level of output accuracy cross-checking to perform on the input.  Possible values are 'None', 'Advanced' and 'Ultra'.  Default is None.  Ultra will produce the highest accuracy but at the cost of longer processing times. | [optional] 
+**rotate_image_degrees** | **Float** | Optional: Rotate the input image before recognition by the specified number of degrees; valid values range from -360 to +360. | [optional] 
 
 

data/docs/AnalyzeApi.md

@@ -1,18 +1,74 @@
 # CloudmersiveDocumentaiApiClient::AnalyzeApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**answer_questions**](AnalyzeApi.md#answer_questions) | **POST** /document-ai/document/analyze/answer-questions | Answer Questions about a Document in a structured way using Advanced AI
 [**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
 
 
+# **answer_questions**
+> DocumentQuestionAnswersResult answer_questions(opts)
+
+Answer Questions about a Document in a structured way using Advanced AI
+
+Answer boolean (yes/no), multiple-choice and free-response questions about the contents of a document using Advanced AI.  Input document formats supported include DOCX, PDF, PNG and JPG.  Consumes 100 API calls per page.
+
+### 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::DocumentQuestionsRequest.new # DocumentQuestionsRequest | Input request, including document and questions
+}
+
+begin
+  #Answer Questions about a Document in a structured way using Advanced AI
+  result = api_instance.answer_questions(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling AnalyzeApi->answer_questions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DocumentQuestionsRequest**](DocumentQuestionsRequest.md)| Input request, including document and questions | [optional] 
+
+### Return type
+
+[**DocumentQuestionAnswersResult**](DocumentQuestionAnswersResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
 # **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.
+Enforce Policies to a Document to allow or block it using Advanced AI.  Input document formats supported include DOCX, PDF, PNG and JPG.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby

data/docs/DocumentAdvancedClassificationResult.md

@@ -5,5 +5,6 @@ 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] 
+**confidence_score** | **Float** | Confidence score between 0.0 and 1.0, where values > 0.8 indicate high confidence | [optional] 
 
 

data/docs/DocumentPolicyRequest.md

@@ -5,5 +5,6 @@ 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] 
+**recognition_mode** | **String** | Optional; Recognition mode - Normal (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images | [optional] 
 
 

data/docs/DocumentQuestionAnswerItem.md

@@ -0,0 +1,11 @@
+# CloudmersiveDocumentaiApiClient::DocumentQuestionAnswerItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question_id** | **String** | ID of the input question | [optional] 
+**answer_value** | **String** | Answer response value, formatted as a string, for this question.  Boolean questions will return YES or NO. | [optional] 
+**answer_rationale** | **String** | Rationale explaining why this answer was given | [optional] 
+**confidence_score** | **Float** | Confidence score between 0.0 and 1.0 where values above 0.8 indicate high confidence | [optional] 
+
+

data/docs/DocumentQuestionAnswersResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::DocumentQuestionAnswersResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was completed successfully, or false otherwise | [optional] 
+**confidence_score** | **Float** | Confidence score between 0.0 and 1.0 where values above 0.8 indicate high confidence | [optional] 
+**answer_results** | [**Array<DocumentQuestionAnswerItem>**](DocumentQuestionAnswerItem.md) |  | [optional] 
+
+

data/docs/DocumentQuestionBoolean.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::DocumentQuestionBoolean
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question_id** | **String** | Unique ID of the question, e.g. 1 or 2A | [optional] 
+**question_text** | **String** | Question in natural language to ask of the document where the answer resolves to YES or NO, e.g. 'Is this document signed and countersigned by both parties?' | [optional] 
+
+

data/docs/DocumentQuestionChoiceItem.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::DocumentQuestionChoiceItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**choice_id** | **String** | Unique ID of the response choice, e.g. 3C | [optional] 
+**choice_text** | **String** | Description text of this choice, e.g. 'Delaware' | [optional] 
+
+

data/docs/DocumentQuestionFreeResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::DocumentQuestionFreeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question_id** | **String** | Unique ID of the question, e.g. 7 or 5A | [optional] 
+**question_text** | **String** | Question in natural language to ask of the document where the answer resolves to a free response, e.g. 'Who is the counterparty in this agreement?' | [optional] 
+
+

data/docs/DocumentQuestionMultipleChoice.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::DocumentQuestionMultipleChoice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question_id** | **String** | Unique ID of the question, e.g. 1 or 2A | [optional] 
+**question_text** | **String** | Question in natural language to ask of the document where the answer resolves to one of a fixed number of provided choices, e.g. 'What is the governing law of this agreement?' | [optional] 
+**response_choices** | [**Array<DocumentQuestionChoiceItem>**](DocumentQuestionChoiceItem.md) | Possible response choices for the multiple-choice question | [optional] 
+
+

data/docs/DocumentQuestionsRequest.md

@@ -0,0 +1,12 @@
+# CloudmersiveDocumentaiApiClient::DocumentQuestionsRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file** | **String** | Input file as a byte array | [optional] 
+**questions_yes_no** | [**Array<DocumentQuestionBoolean>**](DocumentQuestionBoolean.md) | Optional: Yes or No boolean questions to answer about the document | [optional] 
+**questions_multiple_choice** | [**Array<DocumentQuestionMultipleChoice>**](DocumentQuestionMultipleChoice.md) | Optional: Multiple choice questions to answer about the document | [optional] 
+**questions_free_response** | [**Array<DocumentQuestionFreeResponse>**](DocumentQuestionFreeResponse.md) | Optional: Free response questions to answer about the document | [optional] 
+**recognition_mode** | **String** | Optional; Recognition mode - Normal (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images | [optional] 
+
+

data/docs/ExtractApi.md

@@ -1,6 +1,6 @@
 # CloudmersiveDocumentaiApiClient::ExtractApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**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_split**](ExtractApi.md#extract_split) | **POST** /document-ai/document/extract/split | Intelligently Split a Combined Document into Sub-Documents using 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
@@ -20,7 +21,7 @@ Method | HTTP request | Description
 
 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.
+Extract all Fields and Tables, comprised of rows and columns of data, from a document using AI.  Input document formats supported include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -38,6 +39,7 @@ 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
+  preprocessing: 'preprocessing_example', # String | Optional: Set the level of image pre-processing to enhance accuracy.  Possible values are 'Auto' (default), 'Paged', and 'Compatability'.  Use 'Paged' to treat each page as a separate document for extraction (requires Advanced recognitionMode).  Default is Auto.
   input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to extract data from
 }
 
@@ -55,6 +57,7 @@ end
 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] 
+ **preprocessing** | **String**| Optional: Set the level of image pre-processing to enhance accuracy.  Possible values are 'Auto' (default), 'Paged', and 'Compatability'.  Use 'Paged' to treat each page as a separate document for extraction (requires Advanced recognitionMode).  Default is Auto. | [optional] 
  **input_file** | **File**| Input document, or photos of a document, to extract data from | [optional] 
 
 ### Return type
@@ -77,7 +80,7 @@ Name | Type | Description  | Notes
 
 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.
+Extract all barcodes from a document using AI.  Input document formats supported include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG, HEIC and WEBP.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -134,7 +137,7 @@ Name | Type | Description  | Notes
 
 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.
+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, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -193,7 +196,7 @@ Name | Type | Description  | Notes
 
 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.
+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, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -250,7 +253,7 @@ Name | Type | Description  | Notes
 
 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.
+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, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -305,11 +308,11 @@ Name | Type | Description  | Notes
 
 
 # **extract_fields_advanced**
-> ExtractFieldsResponse extract_fields_advanced(opts)
+> ExtractFieldsAdvancedResponse 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.
+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, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -348,7 +351,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ExtractFieldsResponse**](ExtractFieldsResponse.md)
+[**ExtractFieldsAdvancedResponse**](ExtractFieldsAdvancedResponse.md)
 
 ### Authorization
 
@@ -361,12 +364,69 @@ Name | Type | Description  | Notes
 
 
 
+# **extract_split**
+> SplitDocumentResponse extract_split(opts)
+
+Intelligently Split a Combined Document into Sub-Documents using AI
+
+Analyzes a document containing multiple sub-documents (such as a scanned batch of ID cards, forms, or mixed documents) and intelligently splits it into separate sub-documents.  Uses AI to detect document boundaries based on visual content, headers, names, and document types.  Returns the page ranges and PDF bytes for each identified sub-document.  Input document formats supported include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumes 100 API calls per page.
+
+### 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 containing multiple sub-documents to split
+}
+
+begin
+  #Intelligently Split a Combined Document into Sub-Documents using AI
+  result = api_instance.extract_split(opts)
+  p result
+rescue CloudmersiveDocumentaiApiClient::ApiError => e
+  puts "Exception when calling ExtractApi->extract_split: #{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 containing multiple sub-documents to split | [optional] 
+
+### Return type
+
+[**SplitDocumentResponse**](SplitDocumentResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **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.
+Creates a 1 paragraph summary of the input document using Artificial Intelligence.  Input document formats supported include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -384,6 +444,7 @@ 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
+  language: 'language_example', # String | Optional; Three-letter language code (ISO 639) for the summary.  Default is ENG.  Possible language codes are: AAR,ABK,ACE,ACH,ADA,ADY,AFA,AFH,AFR,AIN,AKA,AKK,ALB,ALE,ALG,ALT,AMH,ANG,ANP,APA,ARA,ARC,ARG,ARM,ARN,ARP,ART,ARW,ASM,AST,ATH,AUS,AVA,AVE,AWA,AYM,AZE,BAD,BAI,BAK,BAL,BAM,BAN,BAQ,BAS,BAT,BEJ,BEL,BEM,BEN,BER,BHO,BIH,BIK,BIN,BIS,BLA,BNT,BOD,BOS,BRA,BRE,BTK,BUA,BUG,BUL,BUR,BYN,CAD,CAI,CAR,CAT,CAU,CEB,CEL,CES,CHA,CHB,CHE,CHG,CHI,CHK,CHM,CHN,CHO,CHP,CHR,CHU,CHV,CHY,CMC,CNR,COP,COR,COS,CPE,CPF,CPP,CRE,CRH,CRP,CSB,CUS,CYM,CZE,DAK,DAN,DAR,DAY,DEL,DEN,DEU,DGR,DIN,DIV,DOI,DRA,DSB,DUA,DUM,DUT,DYU,DZO,EFI,EGY,EKA,ELL,ELX,ENG,ENM,EPO,EST,EUS,EWE,EWO,FAN,FAO,FAS,FAT,FIJ,FIL,FIN,FIU,FON,FRA,FRE,FRM,FRO,FRR,FRS,FRY,FUL,FUR,GAA,GAY,GBA,GEM,GEO,GER,GEZ,GIL,GLA,GLE,GLG,GLV,GMH,GOH,GON,GOR,GOT,GRB,GRC,GRE,GRN,GSW,GUJ,GWI,HAI,HAT,HAU,HAW,HEB,HER,HIL,HIM,HIN,HIT,HMN,HMO,HRV,HSB,HUN,HUP,HYE,IBA,IBO,ICE,IDO,III,IJO,IKU,ILE,ILO,INA,INC,IND,INE,INH,IPK,IRA,IRO,ISL,ITA,JAV,JBO,JPN,JPR,JRB,KAA,KAB,KAC,KAL,KAM,KAN,KAR,KAS,KAT,KAU,KAW,KAZ,KBD,KHA,KHI,KHM,KHO,KIK,KIN,KIR,KMB,KOK,KOM,KON,KOR,KOS,KPE,KRC,KRL,KRO,KRU,KUA,KUM,KUR,KUT,LAD,LAH,LAM,LAO,LAT,LAV,LEZ,LIM,LIN,LIT,LOL,LOZ,LTZ,LUA,LUB,LUG,LUI,LUN,LUO,LUS,MAC,MAD,MAG,MAH,MAI,MAK,MAL,MAN,MAO,MAP,MAR,MAS,MAY,MDF,MDR,MEN,MGA,MIC,MIN,MIS,MKD,MKH,MLG,MLT,MNC,MNI,MNO,MOH,MON,MOS,MRI,MSA,MUL,MUN,MUS,MWL,MWR,MYA,MYN,MYV,NAH,NAI,NAP,NAU,NAV,NBL,NDE,NDO,NDS,NEP,NEW,NIA,NIC,NIU,NLD,NNO,NOB,NOG,NON,NOR,NQO,NSO,NUB,NWC,NYA,NYM,NYN,NYO,NZI,OCI,OJI,ORI,ORM,OSA,OSS,OTA,OTO,PAA,PAG,PAL,PAM,PAN,PAP,PAU,PEO,PER,PHI,PHN,PLI,POL,PON,POR,PRA,PRO,PUS,QUE,RAJ,RAP,RAR,ROA,ROH,ROM,RON,RUM,RUN,RUP,RUS,SAD,SAG,SAH,SAI,SAL,SAM,SAN,SAS,SAT,SCN,SCO,SEL,SEM,SGA,SGN,SHN,SID,SIN,SIO,SIT,SLA,SLK,SLO,SLV,SMA,SME,SMI,SMJ,SMN,SMO,SMS,SNA,SND,SNK,SOG,SOM,SON,SOT,SPA,SQI,SRD,SRN,SRP,SRR,SSA,SSW,SUK,SUN,SUS,SUX,SWA,SWE,SYC,SYR,TAH,TAI,TAM,TAT,TEL,TEM,TER,TET,TGK,TGL,THA,TIB,TIG,TIR,TIV,TKL,TLH,TLI,TMH,TOG,TON,TPI,TSI,TSN,TSO,TUK,TUM,TUP,TUR,TUT,TVL,TWI,TYV,UDM,UGA,UIG,UKR,UMB,UND,URD,UZB,VAI,VEN,VIE,VOL,VOT,WAK,WAL,WAR,WAS,WEL,WEN,WLN,WOL,XAL,XHO,YAO,YAP,YID,YOR,YPK,ZAP,ZBL,ZEN,ZGH,ZHA,ZHO,ZND,ZUL,ZUN,ZXX,ZZA.
   input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to extract data from
 }
 
@@ -401,6 +462,7 @@ end
 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] 
+ **language** | **String**| Optional; Three-letter language code (ISO 639) for the summary.  Default is ENG.  Possible language codes are: AAR,ABK,ACE,ACH,ADA,ADY,AFA,AFH,AFR,AIN,AKA,AKK,ALB,ALE,ALG,ALT,AMH,ANG,ANP,APA,ARA,ARC,ARG,ARM,ARN,ARP,ART,ARW,ASM,AST,ATH,AUS,AVA,AVE,AWA,AYM,AZE,BAD,BAI,BAK,BAL,BAM,BAN,BAQ,BAS,BAT,BEJ,BEL,BEM,BEN,BER,BHO,BIH,BIK,BIN,BIS,BLA,BNT,BOD,BOS,BRA,BRE,BTK,BUA,BUG,BUL,BUR,BYN,CAD,CAI,CAR,CAT,CAU,CEB,CEL,CES,CHA,CHB,CHE,CHG,CHI,CHK,CHM,CHN,CHO,CHP,CHR,CHU,CHV,CHY,CMC,CNR,COP,COR,COS,CPE,CPF,CPP,CRE,CRH,CRP,CSB,CUS,CYM,CZE,DAK,DAN,DAR,DAY,DEL,DEN,DEU,DGR,DIN,DIV,DOI,DRA,DSB,DUA,DUM,DUT,DYU,DZO,EFI,EGY,EKA,ELL,ELX,ENG,ENM,EPO,EST,EUS,EWE,EWO,FAN,FAO,FAS,FAT,FIJ,FIL,FIN,FIU,FON,FRA,FRE,FRM,FRO,FRR,FRS,FRY,FUL,FUR,GAA,GAY,GBA,GEM,GEO,GER,GEZ,GIL,GLA,GLE,GLG,GLV,GMH,GOH,GON,GOR,GOT,GRB,GRC,GRE,GRN,GSW,GUJ,GWI,HAI,HAT,HAU,HAW,HEB,HER,HIL,HIM,HIN,HIT,HMN,HMO,HRV,HSB,HUN,HUP,HYE,IBA,IBO,ICE,IDO,III,IJO,IKU,ILE,ILO,INA,INC,IND,INE,INH,IPK,IRA,IRO,ISL,ITA,JAV,JBO,JPN,JPR,JRB,KAA,KAB,KAC,KAL,KAM,KAN,KAR,KAS,KAT,KAU,KAW,KAZ,KBD,KHA,KHI,KHM,KHO,KIK,KIN,KIR,KMB,KOK,KOM,KON,KOR,KOS,KPE,KRC,KRL,KRO,KRU,KUA,KUM,KUR,KUT,LAD,LAH,LAM,LAO,LAT,LAV,LEZ,LIM,LIN,LIT,LOL,LOZ,LTZ,LUA,LUB,LUG,LUI,LUN,LUO,LUS,MAC,MAD,MAG,MAH,MAI,MAK,MAL,MAN,MAO,MAP,MAR,MAS,MAY,MDF,MDR,MEN,MGA,MIC,MIN,MIS,MKD,MKH,MLG,MLT,MNC,MNI,MNO,MOH,MON,MOS,MRI,MSA,MUL,MUN,MUS,MWL,MWR,MYA,MYN,MYV,NAH,NAI,NAP,NAU,NAV,NBL,NDE,NDO,NDS,NEP,NEW,NIA,NIC,NIU,NLD,NNO,NOB,NOG,NON,NOR,NQO,NSO,NUB,NWC,NYA,NYM,NYN,NYO,NZI,OCI,OJI,ORI,ORM,OSA,OSS,OTA,OTO,PAA,PAG,PAL,PAM,PAN,PAP,PAU,PEO,PER,PHI,PHN,PLI,POL,PON,POR,PRA,PRO,PUS,QUE,RAJ,RAP,RAR,ROA,ROH,ROM,RON,RUM,RUN,RUP,RUS,SAD,SAG,SAH,SAI,SAL,SAM,SAN,SAS,SAT,SCN,SCO,SEL,SEM,SGA,SGN,SHN,SID,SIN,SIO,SIT,SLA,SLK,SLO,SLV,SMA,SME,SMI,SMJ,SMN,SMO,SMS,SNA,SND,SNK,SOG,SOM,SON,SOT,SPA,SQI,SRD,SRN,SRP,SRR,SSA,SSW,SUK,SUN,SUS,SUX,SWA,SWE,SYC,SYR,TAH,TAI,TAM,TAT,TEL,TEM,TER,TET,TGK,TGL,THA,TIB,TIG,TIR,TIV,TKL,TLH,TLI,TMH,TOG,TON,TPI,TSI,TSN,TSO,TUK,TUM,TUP,TUR,TUT,TVL,TWI,TYV,UDM,UGA,UIG,UKR,UMB,UND,URD,UZB,VAI,VEN,VIE,VOL,VOT,WAK,WAL,WAR,WAS,WEL,WEN,WLN,WOL,XAL,XHO,YAO,YAP,YID,YOR,YPK,ZAP,ZBL,ZEN,ZGH,ZHA,ZHO,ZND,ZUL,ZUN,ZXX,ZZA. | [optional] 
  **input_file** | **File**| Input document, or photos of a document, to extract data from | [optional] 
 
 ### Return type
@@ -423,7 +485,7 @@ Name | Type | Description  | Notes
 
 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.
+Extract Tables, comprised of rows and columns of data, from a document using AI.  Input document formats supported include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Consumeds 100 API calls per page.
 
 ### Example
 ```ruby
@@ -480,7 +542,7 @@ Name | Type | Description  | Notes
 
 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.
+Extract raw text from a document using AI.  Input document formats supported include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.  Supports a wide range of languages.  Consumes 100 API calls per page.
 
 ### Example
 ```ruby
@@ -497,7 +559,7 @@ 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
+  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.  Set to Deterministic to directly extract text from digital documents without using AI.
   input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to extract data from
 }
 
@@ -514,7 +576,7 @@ end
 
 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] 
+ **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.  Set to Deterministic to directly extract text from digital documents without using AI. | [optional] 
  **input_file** | **File**| Input document, or photos of a document, to extract data from | [optional] 
 
 ### Return type

data/docs/ExtractFieldsAdvancedResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveDocumentaiApiClient::ExtractFieldsAdvancedResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**results** | [**Array<FieldAdvancedValue>**](FieldAdvancedValue.md) | Field value results from the extraction operation | [optional] 
+**confidence_score** | **Float** | Confidence score between 0.0 and 1.0, where values > 0.8 indicate high confidence | [optional] 
+
+

data/docs/FieldAdvancedValue.md

@@ -0,0 +1,9 @@
+# CloudmersiveDocumentaiApiClient::FieldAdvancedValue
+
+## 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/FieldValue.md

@@ -4,6 +4,7 @@
 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] 
+**field_string_value** | **String** | Primary or first string value of the field that was extractged from the document | [optional] 
+**additional_field_string_values** | **Array<String>** | Additional values for this field when the same field is present with multiple values, for example, if two instances of the same form occur in the same document | [optional]