mindee 4.11.0 → 4.13.0

data/lib/mindee/v2/product/classification/classification_inference.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'classification_result'
+
+module Mindee
+  module V2
+    module Product
+      module Classification
+        # The inference result for a classification utility request.
+        class ClassificationInference < Mindee::V2::Parsing::BaseInference
+          # @return [ClassificationResult] Parsed inference payload.
+          attr_reader :result
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            super
+
+            @result = ClassificationResult.new(server_response['result'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            [
+              super,
+              @result.to_s,
+              '',
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/classification/classification_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing/base_response'
+require_relative 'classification_inference'
+require_relative 'params/classification_parameters'
+
+module Mindee
+  module V2
+    module Product
+      module Classification
+        # HTTP response wrapper that embeds a V2 Inference.
+        class ClassificationResponse < Mindee::V2::Parsing::BaseResponse
+          # @return [ClassificationInference] Parsed inference payload.
+          attr_reader :inference
+
+          # @param server_response [Hash] Hash parsed from the API JSON response.
+          def initialize(server_response)
+            super
+
+            @inference = ClassificationInference.new(server_response['inference'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            @inference.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/classification/classification_result.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'classification_classifier'
+
+module Mindee
+  module V2
+    module Product
+      module Classification
+        # Result of the document classifier inference.
+        class ClassificationResult
+          # @return [ClassificationClassifier] The document type, as identified on given classification values.
+          attr_reader :classification
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @classification = ClassificationClassifier.new(server_response['classification'])
+          end
+
+          # @return [String] String representation.
+          def to_s
+            "Classification\n==============\n#{@classification}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/classification/params/classification_parameters.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Product
+      module Classification
+        module Params
+          # Parameters accepted by the classification utility v2 endpoint.
+          class ClassificationParameters < Mindee::Input::BaseParameters
+            # @return [String] Slug for the endpoint.
+            def self.slug
+              'classification'
+            end
+
+            # @param [String] model_id ID of the model
+            # @param [String, nil] file_alias File alias, if applicable.
+            # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
+            # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+            # @param [Boolean, nil] close_file Whether to close the file after parsing.
+            def initialize(
+              model_id,
+              file_alias: nil,
+              webhook_ids: nil,
+              polling_options: nil,
+              close_file: true
+            )
+              super
+            end
+
+            # Loads the parameters from a Hash.
+            # @param [Hash] params Parameters to provide as a hash.
+            # @return [ClassificationParameters]
+            def self.from_hash(params: {})
+              ClassificationParameters.new(
+                params.fetch(:model_id),
+                file_alias: params.fetch(:file_alias, nil),
+                webhook_ids: params.fetch(:webhook_ids, nil),
+                close_file: params.fetch(:close_file, true)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/crop/crop.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'crop_response'
+require_relative 'params/crop_parameters'
+
+module Mindee
+  module V2
+    module Product
+      module Crop
+        # Crop product.
+        class Crop < BaseProduct
+          @slug = 'crop'
+          @params_type = Mindee::V2::Product::Crop::Params::CropParameters
+          @response_type = Mindee::V2::Product::Crop::CropResponse
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/crop/crop_inference.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'crop_result'
+
+module Mindee
+  module V2
+    module Product
+      module Crop
+        # The inference result for a crop utility request.
+        class CropInference < Mindee::V2::Parsing::BaseInference
+          # @return [CropResult] Parsed inference payload.
+          attr_reader :result
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            super
+
+            @result = CropResult.new(server_response['result'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            [
+              super,
+              @result.to_s,
+              '',
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/crop/crop_item.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Product
+      module Crop
+        # Result of a cropped document region.
+        class CropItem
+          # @return [String] Type or classification of the detected object.
+          attr_reader :object_type
+          # @return [Parsing::V2::Field::FieldLocation] Coordinates of the detected object on the document.
+          attr_reader :location
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @object_type = server_response['object_type']
+            @location = Mindee::Parsing::V2::Field::FieldLocation.new(server_response['location'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            "* :Location: #{location}\n  :Object Type: #{object_type}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/crop/crop_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing/base_response'
+require_relative 'params/crop_parameters'
+require_relative 'crop_inference'
+
+module Mindee
+  module V2
+    module Product
+      module Crop
+        # HTTP response wrapper that embeds a V2 Inference.
+        class CropResponse < Mindee::V2::Parsing::BaseResponse
+          # @return [CropInference] Parsed inference payload.
+          attr_reader :inference
+
+          # @param server_response [Hash] Hash parsed from the API JSON response.
+          def initialize(server_response)
+            super
+
+            @inference = CropInference.new(server_response['inference'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            @inference.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/crop/crop_result.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'crop_item'
+
+module Mindee
+  module V2
+    module Product
+      module Crop
+        # Result of a crop utility inference.
+        class CropResult
+          # @return [Array<Cropitem>] List of results of cropped document regions.
+          attr_reader :crops
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @crops = if server_response.key?('crops')
+                       server_response['crops'].map do |crop|
+                         CropItem.new(crop)
+                       end
+                     end
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            crops_str = @crops.join("\n")
+
+            "Crops\n=====\n#{crops_str}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/crop/params/crop_parameters.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Product
+      module Crop
+        module Params
+          # Parameters accepted by the crop utility v2 endpoint.
+          class CropParameters < Mindee::Input::BaseParameters
+            # @return [String] Slug for the endpoint.
+            def self.slug
+              'crop'
+            end
+
+            # @param [String] model_id ID of the model
+            # @param [String, nil] file_alias File alias, if applicable.
+            # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
+            # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+            # @param [Boolean, nil] close_file Whether to close the file after parsing.
+            def initialize(
+              model_id,
+              file_alias: nil,
+              webhook_ids: nil,
+              polling_options: nil,
+              close_file: true
+            )
+              super
+            end
+
+            # Loads the parameters from a Hash.
+            # @param [Hash] params Parameters to provide as a hash.
+            # @return [CropParameters]
+            def self.from_hash(params: {})
+              CropParameters.new(
+                params.fetch(:model_id),
+                file_alias: params.fetch(:file_alias, nil),
+                webhook_ids: params.fetch(:webhook_ids, nil),
+                close_file: params.fetch(:close_file, true)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/extraction/extraction.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'extraction_response'
+require_relative 'params/extraction_parameters'
+
+module Mindee
+  module V2
+    module Product
+      module Extraction
+        # Extraction product.
+        # Note: currently a placeholder for the `Inference` class.
+        class Extraction < Mindee::Parsing::V2::Inference
+          @params_type = Product::Extraction::Params::ExtractionParameters
+          @response_type = Product::Extraction::ExtractionResponse
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/extraction/extraction_inference.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing/v2/inference'
+require_relative 'extraction_result'
+
+module Mindee
+  module V2
+    module Product
+      module Extraction
+        # Extraction inference.
+        class ExtractionInference < Mindee::Parsing::V2::Inference
+          # @return [ExtractionResult] Parsed inference payload.
+          attr_reader :result
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            super
+
+            @result = Mindee::V2::Product::Extraction::ExtractionResult.new(server_response['result'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/extraction/extraction_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing/v2/inference_response'
+require_relative 'extraction_inference'
+
+module Mindee
+  module V2
+    module Product
+      module Extraction
+        # HTTP response wrapper that embeds a V2 Inference.
+        class ExtractionResponse < Mindee::Parsing::V2::InferenceResponse
+          # @return [ExtractionInference] Parsed inference payload.
+          attr_reader :inference
+
+          def initialize(server_response)
+            super
+            @inference = Mindee::V2::Product::Extraction::ExtractionInference.new(server_response['inference'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/extraction/extraction_result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../../parsing/v2/inference_result'
+
+module Mindee
+  module V2
+    module Product
+      module Extraction
+        # Result of an extraction utility inference.
+        class ExtractionResult < Mindee::Parsing::V2::InferenceResult
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/extraction/params/extraction_parameters.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../../../../input/inference_parameters'
+
+module Mindee
+  module V2
+    module Product
+      module Extraction
+        module Params
+          # Parameters accepted by the extraction v2 endpoint.
+          # Currently a placeholder for the InferenceParameters class.
+          class ExtractionParameters < Input::InferenceParameters
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/ocr/ocr.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'ocr_response'
+require_relative 'params/ocr_parameters'
+
+module Mindee
+  module V2
+    module Product
+      module Ocr
+        # Ocr product.
+        class Ocr < BaseProduct
+          @slug = 'ocr'
+          @params_type = Mindee::V2::Product::Ocr::Params::OcrParameters
+          @response_type = Mindee::V2::Product::Ocr::OcrResponse
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/ocr/ocr_inference.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'ocr_result'
+
+module Mindee
+  module V2
+    module Product
+      module Ocr
+        # The inference result for an OCR utility request.
+        class OcrInference < Mindee::V2::Parsing::BaseInference
+          # @return [OcrResult] Parsed inference payload.
+          attr_reader :result
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            super
+
+            @result = OcrResult.new(server_response['result'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            [
+              super,
+              @result.to_s,
+              '',
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/ocr/ocr_page.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'ocr_word'
+
+module Mindee
+  module V2
+    module Product
+      module Ocr
+        # OCR result for a single page.
+        class OcrPage
+          # @return [Array<OcrWord>] List of words extracted from the document page.
+          attr_reader :words
+          # @return [String] Full text content extracted from the document page.
+          attr_reader :content
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @words = server_response['words'].map { |word| OcrWord.new(word) }
+            @content = server_response['content']
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            ocr_words = "\n"
+            ocr_words += @words.map(&:to_s).join("\n\n") if @words&.any?
+            "OCR Words\n======#{ocr_words}\n\n:Content: #{@content}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/ocr/ocr_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing/base_response'
+require_relative 'params/ocr_parameters'
+require_relative 'ocr_inference'
+
+module Mindee
+  module V2
+    module Product
+      module Ocr
+        # HTTP response wrapper that embeds a V2 Inference.
+        class OcrResponse < Mindee::V2::Parsing::BaseResponse
+          # @return [OcrInference] Parsed inference payload.
+          attr_reader :inference
+
+          # @param server_response [Hash] Hash parsed from the API JSON response.
+          def initialize(server_response)
+            super
+
+            @inference = OcrInference.new(server_response['inference'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            @inference.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/ocr/ocr_result.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'ocr_page'
+
+module Mindee
+  module V2
+    module Product
+      module Ocr
+        # Result of a ocr utility inference.
+        class OcrResult
+          # @return [Array<OcrPage>] List of OCR results for each page in the document.
+          attr_reader :pages
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @pages = if server_response.key?('pages')
+                       server_response['pages'].map do |pages|
+                         OcrPage.new(pages)
+                       end
+                     end
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            pages_str = @pages.join("\n")
+
+            "Pages\n======\n#{pages_str}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/ocr/ocr_word.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Product
+      module Ocr
+        # OCR result for a single word extracted from the document page.
+        class OcrWord
+          # @return [String] Text content of the word.
+          attr_reader :content
+          # @return [Mindee::Geometry::Polygon] Position information as a list of points in clockwise order.
+          attr_reader :polygon
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @content = server_response['content']
+            @polygon = Mindee::Geometry::Polygon.new(server_response['polygon'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            @content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/ocr/params/ocr_parameters.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Product
+      module Ocr
+        module Params
+          # Parameters accepted by the ocr utility v2 endpoint.
+          class OcrParameters < Mindee::Input::BaseParameters
+            # @return [String] Slug for the endpoint.
+            def self.slug
+              'ocr'
+            end
+
+            # @param [String] model_id ID of the model
+            # @param [String, nil] file_alias File alias, if applicable.
+            # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
+            # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+            # @param [Boolean, nil] close_file Whether to close the file after parsing.
+            def initialize(
+              model_id,
+              file_alias: nil,
+              webhook_ids: nil,
+              polling_options: nil,
+              close_file: true
+            )
+              super
+            end
+
+            # Loads the parameters from a Hash.
+            # @param [Hash] params Parameters to provide as a hash.
+            # @return [OcrParameters]
+            def self.from_hash(params: {})
+              OcrParameters.new(
+                params.fetch(:model_id),
+                file_alias: params.fetch(:file_alias, nil),
+                webhook_ids: params.fetch(:webhook_ids, nil),
+                close_file: params.fetch(:close_file, true)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end