mindee 4.12.0 → 4.13.0

data/lib/mindee/v2/product/split/split_inference.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'split_result'
+
+module Mindee
+  module V2
+    module Product
+      module Split
+        # Split inference result.
+        class SplitInference < Mindee::V2::Parsing::BaseInference
+          # @return [SplitResult] Result of a split inference.
+          attr_reader :result
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            super
+
+            @result = SplitResult.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/split/split_range.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Product
+      module Split
+        # Split inference result.
+        class SplitRange
+          # @return [Array<Integer>] 0-based page indexes, where the first integer indicates the start page and the
+          #     second integer indicates the end page.
+          attr_reader :page_range
+          # @return [String] The document type, as identified on given classification values.
+          attr_reader :document_type
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @page_range = server_response['page_range']
+            @document_type = server_response['document_type']
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            "* :Page Range: #{@page_range}\n  :Document Type: #{@document_type}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product/split/split_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../../parsing/base_response'
+require_relative 'params/split_parameters'
+require_relative 'split_inference'
+
+module Mindee
+  module V2
+    module Product
+      module Split
+        # HTTP response wrapper that embeds a V2 Inference.
+        class SplitResponse < Mindee::V2::Parsing::BaseResponse
+          # @return [SplitInference] Parsed inference payload.
+          attr_reader :inference
+
+          # @param server_response [Hash] Hash parsed from the API JSON response.
+          def initialize(server_response)
+            super
+
+            @inference = SplitInference.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/split/split_result.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'split_range'
+
+module Mindee
+  module V2
+    module Product
+      module Split
+        # Result of a split utility inference.
+        class SplitResult
+          # @return [Array<SplitRange>] List of results of splitped document regions.
+          attr_reader :splits
+
+          # @param server_response [Hash] Hash representation of the JSON returned by the service.
+          def initialize(server_response)
+            @splits = if server_response.key?('splits')
+                        server_response['splits'].map do |split|
+                          SplitRange.new(split)
+                        end
+                      end
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            splits_str = @splits.join("\n")
+
+            "Splits\n======\n#{splits_str}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/product.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'product/classification/classification'
+require_relative 'product/crop/crop'
+require_relative 'product/extraction/extraction'
+require_relative 'product/ocr/ocr'
+require_relative 'product/split/split'

data/lib/mindee/v2.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'parsing'
+require_relative 'product'

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '4.12.0'
+  VERSION = '4.13.0'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[String | Symbol, Regexp], Nil?]

data/lib/mindee.rb

@@ -84,6 +84,13 @@ module Mindee
     module US
     end
   end
+
+  # V2-specific module.
+  module V2
+    # Product-specific module.
+    module Product
+    end
+  end
 end
 
 # Shorthand to call the logger from anywhere.

data/sig/mindee/client_v2.rbs

@@ -3,15 +3,19 @@
 OTS_OWNER: String
 module Mindee
   class ClientV2
-    attr_reader mindee_api: HTTP::MindeeApiV2
+    private attr_reader mindee_api: HTTP::MindeeApiV2
 
     def logger: () -> Logger
     def initialize: (?api_key: String) -> void
-    def get_inference: (String) -> Parsing::V2::InferenceResponse
-    def get_job: (String) -> Parsing::V2::JobResponse
-    def enqueue_inference: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::InferenceParameters) -> Parsing::V2::JobResponse
-    def enqueue_and_get_inference: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::InferenceParameters) -> Parsing::V2::InferenceResponse
-    def validate_async_params: (Integer | Float, Integer | Float, Integer) -> void
-    def normalize_inference_parameters: (Hash[String | Symbol, untyped] | Input::InferenceParameters) -> Input::InferenceParameters
+    def get_inference: (String inference_id) -> Parsing::V2::InferenceResponse
+    def get_result: [T] (HTTP::_ProductClass[T] product, String resource) -> T
+    def get_result_url: [T] (HTTP::_ResponseFactory[T] response_class, String inference_id) -> T
+    def get_job: (String job_id) -> Parsing::V2::JobResponse
+    def enqueue_inference: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::InferenceParameters params, ?disable_redundant_warnings: bool) -> Parsing::V2::JobResponse
+    def enqueue: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> Parsing::V2::JobResponse
+    def enqueue_and_get_result: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> T
+    def enqueue_and_get_inference: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::InferenceParameters params, ?disable_redundant_warnings: bool) -> Parsing::V2::InferenceResponse
+    def validate_async_params:  (Integer | Float, Integer | Float, Integer) -> void
+    def normalize_parameters: (singleton(Input::BaseParameters) param_class, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> Input::BaseParameters
   end
 end

data/sig/mindee/errors/mindee_http_error_v2.rbs

@@ -9,7 +9,7 @@ module Mindee
       attr_reader title: String
       attr_reader errors: Array[Parsing::V2::ErrorItem]
 
-      def initialize: (Hash[String, untyped] | Parsing::V2::ErrorResponse) -> void
+      def initialize: (Hash[String, untyped] | Mindee::Parsing::V2::ErrorResponse) -> void
     end
   end
 end

data/sig/mindee/geometry/point.rbs

@@ -7,6 +7,8 @@ module Mindee
 
       def initialize: (Float, Float) -> void
       def []: (Integer) -> Float
+
+      def to_s: -> String
     end
   end
 end

data/sig/mindee/geometry/polygon.rbs

@@ -5,6 +5,8 @@ module Mindee
       def initialize: (Array[::Mindee::Geometry::Point | Array[Float]]) -> void
       def centroid: -> Point
       def point_in_y?: (Point) -> bool
+
+      def to_s: -> String
     end
   end
 end

data/sig/mindee/http/mindee_api_v2.rbs

@@ -1,21 +1,37 @@
-# lib/mindee/http/mindee_api_v2.rb
+# lib/mindee/http/mindee_api_v2.rbs
 module Mindee
   module HTTP
+    interface _ResponseFactory[T]
+      def new: (Hash[String | Symbol, untyped]) -> T
+    end
+
+    interface _ProductClass[T]
+      def slug: () -> String
+      def response_type: () -> _ResponseFactory[T]
+      def params_type: () -> singleton(Input::BaseParameters)
+    end
+
     class MindeeApiV2
       attr_reader settings: ApiSettingsV2
 
       def initialize: (?api_key: String?) -> void
-      def req_post_inference_enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::InferenceParameters) -> Parsing::V2::JobResponse
+
+      def req_get_result: [T] (_ProductClass[T] product, String resource) -> T
+
+      def req_post_enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::BaseParameters) -> Parsing::V2::JobResponse
       def req_get_inference: (String) -> Parsing::V2::InferenceResponse
       def req_get_job: (String) -> Parsing::V2::JobResponse
       def process_response: (Net::HTTPResponse?) -> Hash[String | Symbol, untyped]
       def poll: (String) -> Net::HTTPResponse
       def inference_job_req_get: (String) -> Net::HTTPResponse
       def inference_result_req_get: (String) -> Net::HTTPResponse
-      def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::InferenceParameters) -> Net::HTTPResponse?
+      def result_req_get: [T] (String, _ProductClass[T] product) -> Net::HTTPResponse
+      def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::BaseParameters) -> Net::HTTPResponse?
 
       private
-
+      def req_get_job_url: (String) -> Parsing::V2::JobResponse
+      def req_get_result_url: [T] (_ResponseFactory[T] result_class, String url) -> T
+      def uri?: (String) -> bool
       def enqueue_form_options: (Array[untyped], Input::InferenceParameters) -> Array[untyped]
     end
   end

data/sig/mindee/input/base_parameters.rbs

@@ -0,0 +1,35 @@
+# lib/mindee/input/base_parameters.rb
+
+module Mindee
+  module Input
+    class BaseParameters
+      attr_reader self.slug: String
+
+      def self.from_hash: (params: Hash[String | Symbol, untyped]) -> instance
+      def self.load_from_hash: (params: Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
+
+      def slug: -> String
+
+      attr_reader model_id: String
+      attr_reader file_alias: String?
+      attr_reader webhook_ids: Array[String]?
+      attr_reader polling_options: PollingOptions
+      attr_reader close_file: bool
+
+      def initialize: (
+          String,
+          ?file_alias: String?,
+          ?webhook_ids: Array[String]?,
+          ?polling_options: Hash[Symbol | String, untyped] | PollingOptions?,
+          ?close_file: bool?
+        ) -> void
+
+      def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
+      def validate_async_params: () -> void
+
+      private
+
+      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions?) -> PollingOptions
+    end
+  end
+end

data/sig/mindee/input/inference_parameters.rbs

@@ -1,17 +1,14 @@
 # lib/mindee/input/inference_parameters.rb
 module Mindee
   module Input
-    class InferenceParameters
-      attr_reader close_file: bool
+    class InferenceParameters < BaseParameters
+      def self.slug: -> String
+
       attr_reader confidence: bool?
-      attr_reader file_alias: String?
-      attr_reader model_id: String
-      attr_reader polling_options: PollingOptions
       attr_reader polygon: bool?
       attr_reader rag: bool?
       attr_reader raw_text: bool?
       attr_reader text_context: String?
-      attr_reader webhook_ids: Array[String]?
       attr_reader data_schema: DataSchema?
 
       def initialize: (
@@ -29,12 +26,7 @@ module Mindee
         ) -> void
 
       def self.from_hash: (params: Hash[String | Symbol, untyped]) -> InferenceParameters
-
-      def validate_async_params: -> void
-
-      private
-
-      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions?) -> PollingOptions
+      def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
     end
   end
 end

data/sig/mindee/input/local_response.rbs

@@ -2,13 +2,13 @@
 module Mindee
   module Input
     class LocalResponse
-      def file: -> StringIO
+      attr_reader file: StringIO
       def initialize: (File | IO | StringIO | String | Pathname | Tempfile) -> void
       def as_hash: -> Hash[String | Symbol, untyped]
       def self.process_secret_key: (String) -> String
       def get_hmac_signature: (String) -> String
       def valid_hmac_signature?: (String, String) -> bool
-      def deserialize_response: (singleton(Parsing::V2::CommonResponse))-> (Parsing::V2::JobResponse | Parsing::V2::InferenceResponse)
+      def deserialize_response: (singleton(Parsing::V2::CommonResponse))-> (Parsing::V2::JobResponse | Mindee::Parsing::V2::InferenceResponse)
     end
   end
 end

data/sig/mindee/parsing/v2/inference.rbs

@@ -2,12 +2,11 @@
 module Mindee
   module Parsing
     module V2
-      class Inference
+      class Inference < Mindee::V2::Parsing::BaseInference
+        attr_reader self.params_type: singleton(Input::InferenceParameters)
+        attr_reader self.response_type: singleton(InferenceResponse)
+        attr_reader self.slug: String
 
-        attr_reader id: String
-        attr_reader job: InferenceJob
-        attr_reader model: InferenceModel
-        attr_reader file: InferenceFile
         attr_reader active_options: InferenceActiveOptions
         attr_reader result: InferenceResult
 

data/sig/mindee/parsing/v2/inference_response.rbs

@@ -2,10 +2,19 @@
 module Mindee
   module Parsing
     module V2
-      class InferenceResponse < CommonResponse
-        attr_reader inference: V2::Inference
+      class InferenceResponse < Mindee::V2::Parsing::BaseResponse[Mindee::Parsing::V2::Inference]
+
+        self.@slug: String
+        self.@_params_type: singleton(Input::BaseParameters)
+
+        attr_reader inference: Mindee::Parsing::V2::Inference
         def initialize: (Hash[String | Symbol, untyped]) -> void
+
+        def _params_type: -> singleton(Input::InferenceParameters)
+
         def to_s: -> String
+        def self._params_type: () -> singleton(Input::InferenceParameters)
+        def self.slug: () -> String
       end
     end
   end

data/sig/mindee/v2/parsing/base_inference.rbs

@@ -0,0 +1,18 @@
+# lib/mindee/v2/parsing/base_inference.rb
+
+module Mindee
+  module V2
+    module Parsing
+      class BaseInference
+        attr_reader job: Mindee::Parsing::V2::InferenceJob
+        attr_reader file: Mindee::Parsing::V2::InferenceFile
+        attr_reader id: String
+        attr_reader model: Mindee::Parsing::V2::InferenceModel
+
+        def initialize: (Hash[String | Symbol, untyped]) -> void
+
+        def to_s: -> String
+      end
+    end
+  end
+end

data/sig/mindee/v2/parsing/base_response.rbs

@@ -0,0 +1,11 @@
+# lib/mindee/v2/parsing/base_response.rb
+
+module Mindee
+  module V2
+    module Parsing
+      class BaseResponse[T] < Mindee::Parsing::V2::CommonResponse
+        attr_reader inference: T
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/base_product.rbs

@@ -0,0 +1,19 @@
+module Mindee
+  module V2
+    module Product
+      class BaseProduct
+        self.@slug: String
+        self.@params_type: singleton(Input::BaseParameters)
+        self.@response_type: singleton(Parsing::BaseResponse)
+
+        def self._params_type: () -> singleton(Input::BaseParameters)
+
+        attr_reader self.slug: String
+        attr_reader self.params_type: singleton(Input::BaseParameters)
+        attr_reader self.response_type: singleton(Parsing::BaseResponse)
+
+        def initialize: -> void
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/classification/classification.rbs

@@ -0,0 +1,10 @@
+module Mindee
+  module V2
+    module Product
+      module Classification
+        class Classification < BaseProduct
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/classification/classification_classifier.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/v2/product/classification/classification_classifier.rb
+
+module Mindee
+  module V2
+    module Product
+      module Classification
+        class ClassificationClassifier
+          attr_reader document_type: String
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/classification/classification_inference.rbs

@@ -0,0 +1,15 @@
+module Mindee
+  module V2
+    module Product
+      module Classification
+        class ClassificationInference
+          attr_reader result: ClassificationResult
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/classification/classification_response.rbs

@@ -0,0 +1,23 @@
+# lib/mindee/v2/product/classification/classification_response.rb
+
+module Mindee
+  module V2
+    module Product
+      module Classification
+        class ClassificationResponse
+          self.@slug: String
+          self.@_params_type: singleton(Params::ClassificationParameters)
+
+          attr_reader inference: Mindee::V2::Product::Classification::ClassificationInference
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+
+          def _params_type: -> singleton(Params::ClassificationParameters)
+
+          def to_s: -> String
+          def self._params_type: () -> singleton(Params::ClassificationParameters)
+          def self.slug: () -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/classification/classification_result.rbs

@@ -0,0 +1,15 @@
+module Mindee
+  module V2
+    module Product
+      module Classification
+        class ClassificationResult
+          attr_reader classification: ClassificationClassifier
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/classification/params/classification_parameters/classification_parameters.rbs

@@ -0,0 +1,23 @@
+module Mindee
+  module V2
+    module Product
+      module Classification
+        module Params
+          class ClassificationParameters
+            def self.slug: -> String
+
+            def self.from_hash: (params: Hash[String | Symbol, untyped]) -> ClassificationParameters
+
+            def initialize: (
+                String,
+                ?file_alias: String?,
+                ?webhook_ids: Array[String]?,
+                ?polling_options: Hash[Symbol | String, untyped] | Input::PollingOptions?,
+                ?close_file: bool?
+              ) -> void
+          end
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/crop/crop.rbs

@@ -0,0 +1,10 @@
+module Mindee
+  module V2
+    module Product
+      module Crop
+        class Crop < BaseProduct
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/crop/crop_inference.rbs

@@ -0,0 +1,14 @@
+module Mindee
+  module V2
+    module Product
+      module Crop
+        class CropInference
+          attr_reader result: CropResult
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/crop/crop_item.rbs

@@ -0,0 +1,15 @@
+module Mindee
+  module V2
+    module Product
+      module Crop
+        class CropItem
+          attr_reader object_type: String
+          attr_reader location: Mindee::Parsing::V2::Field::FieldLocation
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/crop/crop_response.rbs

@@ -0,0 +1,23 @@
+# lib/mindee/v2/product/crop/crop_response.rb
+
+module Mindee
+  module V2
+    module Product
+      module Crop
+        class CropResponse
+          self.@slug: String
+          self.@_params_type: singleton(Params::CropParameters)
+
+          attr_reader inference: Mindee::V2::Product::Crop::CropInference
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+
+          def _params_type: -> singleton(Params::CropParameters)
+
+          def to_s: -> String
+          def self._params_type: () -> singleton(Params::CropParameters)
+          def self.slug: () -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/product/crop/crop_result.rbs

@@ -0,0 +1,14 @@
+module Mindee
+  module V2
+    module Product
+      module Crop
+        class CropResult
+          attr_reader crops: Array[CropItem]
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end