cloudmersive-documentai-api-client 2.2.0

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

@@ -0,0 +1,188 @@
+=begin
+#Document AI API
+
+#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveDocumentaiApiClient
+  # Row of a table extracted from a document
+  class TableResultRow
+    # Cells in the row
+    attr_accessor :cells
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cells' => :'Cells'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cells' => :'Array<TableResultCell>'
+      }
+    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?(:'Cells')
+        if (value = attributes[:'Cells']).is_a?(Array)
+          self.cells = 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 &&
+          cells == o.cells
+    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
+      [cells].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/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Document AI API
+
+#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+module CloudmersiveDocumentaiApiClient
+  VERSION = '2.2.0'
+end

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

@@ -0,0 +1,66 @@
+=begin
+#Document AI API
+
+#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+# Common files
+require 'cloudmersive-documentai-api-client/api_client'
+require 'cloudmersive-documentai-api-client/api_error'
+require 'cloudmersive-documentai-api-client/version'
+require 'cloudmersive-documentai-api-client/configuration'
+
+# Models
+require 'cloudmersive-documentai-api-client/models/advanced_extract_classification_request'
+require 'cloudmersive-documentai-api-client/models/advanced_extract_fields_request'
+require 'cloudmersive-documentai-api-client/models/document_advanced_classification_result'
+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/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_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_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/summarize_document_response'
+require 'cloudmersive-documentai-api-client/models/table_result'
+require 'cloudmersive-documentai-api-client/models/table_result_cell'
+require 'cloudmersive-documentai-api-client/models/table_result_row'
+
+# APIs
+require 'cloudmersive-documentai-api-client/api/analyze_api'
+require 'cloudmersive-documentai-api-client/api/extract_api'
+require 'cloudmersive-documentai-api-client/api/run_batch_job_api'
+
+module CloudmersiveDocumentaiApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveDocumentaiApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/analyze_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#Document AI API
+
+#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CloudmersiveDocumentaiApiClient::AnalyzeApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AnalyzeApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveDocumentaiApiClient::AnalyzeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AnalyzeApi' do
+    it 'should create an instance of AnalyzeApi' do
+      expect(@instance).to be_instance_of(CloudmersiveDocumentaiApiClient::AnalyzeApi)
+    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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DocumentPolicyRequest] :body Input request, including document and policy rules
+  # @return [DocumentPolicyResult]
+  describe 'apply_rules test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/extract_api_spec.rb

@@ -0,0 +1,154 @@
+=begin
+#Document AI API
+
+#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CloudmersiveDocumentaiApiClient::ExtractApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ExtractApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveDocumentaiApiClient::ExtractApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ExtractApi' do
+    it 'should create an instance of ExtractApi' do
+      expect(@instance).to be_instance_of(CloudmersiveDocumentaiApiClient::ExtractApi)
+    end
+  end
+
+  # unit tests for extract_all_fields_and_tables
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractFieldsAndTablesResponse]
+  describe 'extract_all_fields_and_tables 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 extract_barcodes
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractBarcodesAiResponse]
+  describe 'extract_barcodes 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 extract_classification
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :categories Desired classification to extract
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [DocumentClassificationResult]
+  describe 'extract_classification 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 extract_classification_advanced
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [AdvancedExtractClassificationRequest] :body Input request to perform the classification on
+  # @return [DocumentAdvancedClassificationResult]
+  describe 'extract_classification_advanced 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 extract_fields
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :field_names Desired fields to extract, comma separated
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractFieldsResponse]
+  describe 'extract_fields 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 extract_fields_advanced
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [AdvancedExtractFieldsRequest] :body Input request, including document file as byte array, and information on which fields to extract
+  # @return [ExtractFieldsResponse]
+  describe 'extract_fields_advanced 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 extract_summary
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [SummarizeDocumentResponse]
+  describe 'extract_summary 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 extract_tables
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractTablesResponse]
+  describe 'extract_tables 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 extract_text
+  # 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.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractTextResponse]
+  describe 'extract_text test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/run_batch_job_api_spec.rb

@@ -0,0 +1,100 @@
+=begin
+#Document AI API
+
+#Use next-generation AI to extract data, fields, insights and text from documents. Instantly.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CloudmersiveDocumentaiApiClient::RunBatchJobApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RunBatchJobApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveDocumentaiApiClient::RunBatchJobApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RunBatchJobApi' do
+    it 'should create an instance of RunBatchJobApi' do
+      expect(@instance).to be_instance_of(CloudmersiveDocumentaiApiClient::RunBatchJobApi)
+    end
+  end
+
+  # unit tests for extract_all_fields_and_tables_from_document_batch_job
+  # Extract All Fields and Tables of Data from a Document using AI as a Batch Job
+  # Creates an async batch job for processing a large document as an AI batch job.  Extract all Fields and Tables, comprised of rows and columns of data, from a document using AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractDocumentBatchJobResult]
+  describe 'extract_all_fields_and_tables_from_document_batch_job 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 extract_classification_from_document_batch_job
+  # Extract Classification or Category from a Document using AI as a Batch Job
+  # Creates an async batch job for processing a large document as an AI batch job.  Extract Classification or Category (e.g. Invoice, Receipt, Tax Form, or Form 1040, Form 1040 EZ, etc.) from a document using AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :categories Desired classification to extract
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractDocumentBatchJobResult]
+  describe 'extract_classification_from_document_batch_job 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 extract_fields_from_document_advanced_batch_job
+  # Extract Field Values from a Document using Advanced AI as a Batch Job
+  # Creates an async batch job for processing a large document as an AI batch job.  Extract Field Values (e.g. Invoice Number, Invoice Date, Business Card Phone Number, etc.) from a document using Advanced AI.  Input document formats supported include DOCX, PDF, PNG and JPG.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [AdvancedExtractFieldsRequest] :body 
+  # @return [ExtractDocumentBatchJobResult]
+  describe 'extract_fields_from_document_advanced_batch_job 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 extract_text_from_document_batch_job
+  # Extract Text from a Document using AI as a Batch Job
+  # Creates an async batch job for processing a large document as an AI batch job.  Input document formats supported include DOCX, PDF, PNG and JPG.  Supports a wide range of languages.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :recognition_mode Optional; Recognition mode - Advanced (default) provides the highest accuracy but slower speed, while Normal provides faster response but lower accuracy for low quality images
+  # @option opts [File] :input_file Input document, or photos of a document, to extract data from
+  # @return [ExtractDocumentBatchJobResult]
+  describe 'extract_text_from_document_batch_job 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 get_async_job_status
+  # Get the status and result of an Extract Document Batch Job
+  # Returns the result of the Async Job - possible states can be STARTED or COMPLETED.  This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :async_job_id 
+  # @return [ExtractDocumentJobStatusResult]
+  describe 'get_async_job_status test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end