cloudmersive-documentai-api-client 2.2.0 → 2.2.1

data/lib/cloudmersive-documentai-api-client/models/split_document_response.rb

@@ -0,0 +1,198 @@
+=begin
+#Document AI API
+
+#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
+
+=end
+
+require 'date'
+
+module CloudmersiveDocumentaiApiClient
+  # Result of splitting a document into sub-documents
+  class SplitDocumentResponse
+    # True if successful, false otherwise
+    attr_accessor :successful
+
+    # The sub-documents that were identified and extracted from the input document
+    attr_accessor :sub_documents
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'sub_documents' => :'SubDocuments'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'sub_documents' => :'Array<SubDocument>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'SubDocuments')
+        if (value = attributes[:'SubDocuments']).is_a?(Array)
+          self.sub_documents = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          successful == o.successful &&
+          sub_documents == o.sub_documents
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [successful, sub_documents].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveDocumentaiApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/cloudmersive-documentai-api-client/models/sub_document.rb

@@ -0,0 +1,231 @@
+=begin
+#Document AI API
+
+#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
+
+=end
+
+require 'date'
+
+module CloudmersiveDocumentaiApiClient
+  # A sub-document extracted from a combined document
+  class SubDocument
+    # Starting page number (1-indexed) of this sub-document in the original document
+    attr_accessor :start_page
+
+    # Ending page number (1-indexed) of this sub-document in the original document
+    attr_accessor :end_page
+
+    # Description of the sub-document including document type and any identifying information such as person name
+    attr_accessor :document_description
+
+    # The extracted sub-document as PDF file bytes
+    attr_accessor :file_bytes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start_page' => :'StartPage',
+        :'end_page' => :'EndPage',
+        :'document_description' => :'DocumentDescription',
+        :'file_bytes' => :'FileBytes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'start_page' => :'Integer',
+        :'end_page' => :'Integer',
+        :'document_description' => :'String',
+        :'file_bytes' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'StartPage')
+        self.start_page = attributes[:'StartPage']
+      end
+
+      if attributes.has_key?(:'EndPage')
+        self.end_page = attributes[:'EndPage']
+      end
+
+      if attributes.has_key?(:'DocumentDescription')
+        self.document_description = attributes[:'DocumentDescription']
+      end
+
+      if attributes.has_key?(:'FileBytes')
+        self.file_bytes = attributes[:'FileBytes']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@file_bytes.nil? && @file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        invalid_properties.push('invalid value for "file_bytes", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@file_bytes.nil? && @file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] file_bytes Value to be assigned
+    def file_bytes=(file_bytes)
+      if !file_bytes.nil? && file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        fail ArgumentError, 'invalid value for "file_bytes", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.'
+      end
+
+      @file_bytes = file_bytes
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          start_page == o.start_page &&
+          end_page == o.end_page &&
+          document_description == o.document_description &&
+          file_bytes == o.file_bytes
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [start_page, end_page, document_description, file_bytes].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveDocumentaiApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/cloudmersive-documentai-api-client/models/summarize_document_response.rb

@@ -1,10 +1,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
 

data/lib/cloudmersive-documentai-api-client/models/table_result.rb

@@ -1,10 +1,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
 

data/lib/cloudmersive-documentai-api-client/models/table_result_cell.rb

@@ -1,10 +1,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
 

data/lib/cloudmersive-documentai-api-client/models/table_result_row.rb

@@ -1,10 +1,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
 

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

@@ -1,15 +1,15 @@
 =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
 
 =end
 
 module CloudmersiveDocumentaiApiClient
-  VERSION = '2.2.0'
+  VERSION = '2.2.1'
 end

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

@@ -1,10 +1,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
 
@@ -24,19 +24,30 @@ require 'cloudmersive-documentai-api-client/models/document_categories'
 require 'cloudmersive-documentai-api-client/models/document_classification_result'
 require 'cloudmersive-documentai-api-client/models/document_policy_request'
 require 'cloudmersive-documentai-api-client/models/document_policy_result'
+require 'cloudmersive-documentai-api-client/models/document_question_answer_item'
+require 'cloudmersive-documentai-api-client/models/document_question_answers_result'
+require 'cloudmersive-documentai-api-client/models/document_question_boolean'
+require 'cloudmersive-documentai-api-client/models/document_question_choice_item'
+require 'cloudmersive-documentai-api-client/models/document_question_free_response'
+require 'cloudmersive-documentai-api-client/models/document_question_multiple_choice'
+require 'cloudmersive-documentai-api-client/models/document_questions_request'
 require 'cloudmersive-documentai-api-client/models/extract_barcodes_ai_response'
 require 'cloudmersive-documentai-api-client/models/extract_document_batch_job_result'
 require 'cloudmersive-documentai-api-client/models/extract_document_job_status_result'
+require 'cloudmersive-documentai-api-client/models/extract_fields_advanced_response'
 require 'cloudmersive-documentai-api-client/models/extract_fields_and_tables_response'
 require 'cloudmersive-documentai-api-client/models/extract_fields_response'
 require 'cloudmersive-documentai-api-client/models/extract_tables_response'
 require 'cloudmersive-documentai-api-client/models/extract_text_response'
 require 'cloudmersive-documentai-api-client/models/extracted_barcode_item'
 require 'cloudmersive-documentai-api-client/models/extracted_text_page'
+require 'cloudmersive-documentai-api-client/models/field_advanced_value'
 require 'cloudmersive-documentai-api-client/models/field_to_extract'
 require 'cloudmersive-documentai-api-client/models/field_value'
 require 'cloudmersive-documentai-api-client/models/policy_rule'
 require 'cloudmersive-documentai-api-client/models/policy_rule_violation'
+require 'cloudmersive-documentai-api-client/models/split_document_response'
+require 'cloudmersive-documentai-api-client/models/sub_document'
 require 'cloudmersive-documentai-api-client/models/summarize_document_response'
 require 'cloudmersive-documentai-api-client/models/table_result'
 require 'cloudmersive-documentai-api-client/models/table_result_cell'

data/spec/api/analyze_api_spec.rb

@@ -1,10 +1,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
 
@@ -32,9 +32,21 @@ describe 'AnalyzeApi' do
     end
   end
 
+  # unit tests for answer_questions
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DocumentQuestionsRequest] :body Input request, including document and questions
+  # @return [DocumentQuestionAnswersResult]
+  describe 'answer_questions test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for apply_rules
   # 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.
   # @param [Hash] opts the optional parameters
   # @option opts [DocumentPolicyRequest] :body Input request, including document and policy rules
   # @return [DocumentPolicyResult]