mindee 4.13.0 → 5.0.0.rc1

data/lib/mindee/{parsing/v2 → v2/parsing}/error_response.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Encapsulates information returned by the API when an error occurs.
       class ErrorResponse
         # @return [Integer] The HTTP status code returned by the server.

data/lib/mindee/{parsing/v2 → v2/parsing}/field/base_field.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Field submodule for V2.
       module Field
         # Base class for V2 fields.
@@ -54,7 +54,7 @@ module Mindee
               return SimpleField.new(raw_prediction, indent_level)
             end
 
-            raise Errors::MindeeError, "Unrecognized field format in #{raw_prediction.to_json}"
+            raise Error::MindeeError, "Unrecognized field format in #{raw_prediction.to_json}"
           end
         end
       end

data/lib/mindee/{parsing/v2 → v2/parsing}/field/field_confidence.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       module Field
         # Confidence level of a field as returned by the V2 API.
         class FieldConfidence

data/lib/mindee/{parsing/v2 → v2/parsing}/field/field_location.rb

@@ -3,8 +3,8 @@
 require_relative '../../../geometry/polygon'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       module Field
         # Location of a field.
         class FieldLocation

data/lib/mindee/{parsing/v2 → v2/parsing}/field/inference_fields.rb

@@ -3,8 +3,8 @@
 require_relative 'base_field'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       module Field
         # Represents a hash-like collection of inference fields, providing methods for
         # retrieval and string representation.
@@ -73,7 +73,7 @@ module Mindee
 
             indent ||= @indent_level
             padding = '  ' * indent
-            lines = []
+            lines = [] # @type var lines: Array[String]
 
             each do |field_key, field_value|
               line = "#{padding}:#{field_key}:"

data/lib/mindee/{parsing/v2 → v2/parsing}/field/list_field.rb

@@ -3,8 +3,8 @@
 require_relative 'base_field'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       module Field
         # Represents a field that contains a list of items.
         class ListField < BaseField
@@ -18,7 +18,7 @@ module Mindee
             super
 
             unless server_response.key?('items') && server_response['items'].is_a?(Array)
-              raise Errors::MindeeError,
+              raise Error::MindeeError,
                     "Expected \"items\" to be an array in #{server_response.to_json}."
             end
 
@@ -32,7 +32,7 @@ module Mindee
           # @return [Array<SimpleField>] Simple fields contained in the list.
           # @raise [TypeError] If the fields are not SimpleField.
           def simple_items
-            fields = []
+            fields = [] # @type var fields: Array[SimpleField]
             @items.each do |item|
               raise TypeError, "Invalid field type detected: #{item.class}" unless item.is_a?(SimpleField)
 
@@ -45,7 +45,7 @@ module Mindee
           # @return [Array<ObjectField>] Object fields contained in the list.
           # @raise [TypeError] If the fields are not ObjectField.
           def object_items
-            fields = []
+            fields = [] # @type var fields: Array[ObjectField]
             @items.each do |item|
               raise TypeError, "Invalid field type detected: #{item.class}" unless item.is_a?(ObjectField)
 

data/lib/mindee/{parsing/v2 → v2/parsing}/field/object_field.rb

@@ -4,8 +4,8 @@ require_relative 'base_field'
 require_relative 'inference_fields'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       module Field
         # A field containing a nested set of inference fields.
         class ObjectField < BaseField
@@ -111,22 +111,25 @@ module Mindee
           # Get all simple fields.
           # @return [Hash<String, SimpleField>] Simple fields contained in the object.
           def simple_fields
-            # @type var fields: Hash<String, SimpleField>
-            @fields.select { |_, value| value.is_a?(SimpleField) }
+            # @type var result: Hash[String, SimpleField]
+            result = @fields.select { |_, value| value.is_a?(SimpleField) } # rubocop:disable Style/RedundantAssignment
+            result
           end
 
           # Get all list fields.
           # @return [Hash<String, ListField>] List fields contained in the object.
           def list_fields
-            # @type var fields: Hash<String, ListField>
-            @fields.select { |_, value| value.is_a?(ListField) }
+            # @type var result: Hash[String, ListField]
+            result = @fields.select { |_, value| value.is_a?(ListField) } # rubocop:disable Style/RedundantAssignment
+            result
           end
 
           # Get all object fields.
           # @return [Hash<String, ObjectField>] Object fields contained in the object.
           def object_fields
-            # @type var fields: Hash<String, ObjectField>
-            @fields.select { |_, value| value.is_a?(ObjectField) }
+            # @type var result: Hash[String, ObjectField]
+            result = @fields.select { |_, value| value.is_a?(ObjectField) } # rubocop:disable Style/RedundantAssignment
+            result
           end
         end
       end

data/lib/mindee/{parsing/v2 → v2/parsing}/field/simple_field.rb

@@ -3,8 +3,8 @@
 require_relative 'base_field'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       module Field
         # A simple field with a scalar value.
         class SimpleField < BaseField

data/lib/mindee/{parsing/v2 → v2/parsing}/inference_active_options.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Data schema options activated during the inference.
       class DataSchemaActiveOption
         # @return [Boolean]

data/lib/mindee/{parsing/v2 → v2/parsing}/inference_file.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Information about a file returned in an inference.
       class InferenceFile
         # @return [String] File name.

data/lib/mindee/{parsing/v2 → v2/parsing}/inference_job.rb

@@ -4,8 +4,8 @@ require_relative 'common_response'
 require_relative 'job'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # HTTP response wrapper that embeds a V2 job.
       class InferenceJob
         # @return [String] UUID of the Job.

data/lib/mindee/{parsing/v2 → v2/parsing}/inference_model.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # ID of the model that produced the inference.
       class InferenceModel
         # @return [String] Identifier of the model.

data/lib/mindee/{parsing/v2 → v2/parsing}/job.rb

@@ -5,8 +5,8 @@ require_relative 'error_response'
 require_relative 'job_webhook'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Metadata returned when polling a job (asynchronous request).
       class Job
         # @return [String] Unique job identifier.
@@ -81,7 +81,7 @@ module Mindee
               '',
               'Webhooks',
               '=========',
-              @webhooks.map(&:to_s).join("\n\n"),
+              @webhooks.join("\n\n"),
             ]
           end
 

data/lib/mindee/{parsing/v2 → v2/parsing}/job_response.rb

@@ -4,8 +4,8 @@ require_relative 'common_response'
 require_relative 'job'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # HTTP response wrapper that embeds a V2 job.
       class JobResponse < CommonResponse
         # @return [Job] Parsed job payload.

data/lib/mindee/{parsing/v2 → v2/parsing}/job_webhook.rb

@@ -1,12 +1,11 @@
-# lib/mindee/parsing/v2/job_response_webhook.rb
 # frozen_string_literal: true
 
 require 'date'
 require_relative 'error_response'
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Information about a webhook created for a job response.
       class JobWebhook
         # @return [String] Identifier of the webhook.

data/lib/mindee/{parsing/v2 → v2/parsing}/rag_metadata.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Metadata about the RAG operation.
       class RAGMetadata
         # The UUID of the matched document used during the RAG operation.

data/lib/mindee/{parsing/v2 → v2/parsing}/raw_text.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Raw text extracted from all pages in the document.
       class RawText
-        # @return [Array[Mindee::Parsing::V2::RawTextPage]] List of pages with their extracted text content.
+        # @return [Array[Mindee::V2::Parsing::RawTextPage]] List of pages with their extracted text content.
         attr_reader :pages
 
         # @param server_response [Hash] Raw JSON parsed into a Hash.
@@ -16,8 +16,10 @@ module Mindee
           end
         end
 
+        # String representation.
+        # @return [String]
         def to_s
-          "#{@pages.map(&:to_s).join("\n\n")}\n"
+          "#{@pages.join("\n\n")}\n"
         end
       end
     end

data/lib/mindee/{parsing/v2 → v2/parsing}/raw_text_page.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Mindee
-  module Parsing
-    module V2
+  module V2
+    module Parsing
       # Raw text extracted from a single page.
       class RawTextPage
         # @return [String] Text content of the page as a single string. '\n' is used to separate lines.
@@ -13,6 +13,8 @@ module Mindee
           @content = server_response['content']
         end
 
+        # String representation.
+        # @return [String]
         def to_s
           @content
         end

data/lib/mindee/v2/parsing/search/pagination_metadata.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # Pagination Metadata data associated with model search.
+        class PaginationMetadata
+          # @return [Integer] Number of items per page.
+          attr_reader :per_page
+
+          # @return [Integer] 1-indexed page number.
+          attr_reader :page
+
+          # @return [Integer] Total items.
+          attr_reader :total_items
+
+          # @return [Integer] Total number of pages.
+          attr_reader :total_pages
+
+          # @param raw_response [Hash] The parsed JSON payload mapping to pagination metadata.
+          def initialize(raw_response)
+            @per_page = raw_response['per_page']
+            @page = raw_response['page']
+            @total_items = raw_response['total_items']
+            @total_pages = raw_response['total_pages']
+          end
+
+          # String representation of the pagination metadata.
+          # @return [String]
+          def to_s
+            [
+              ":Per Page: #{@per_page}",
+              ":Page: #{@page}",
+              ":Total Items: #{@total_items}",
+              ":Total Pages: #{@total_pages}",
+              '',
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/parsing/search/search_model.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # Individual model information.
+        class SearchModel
+          # @return [String] ID of the model.
+          attr_reader :id
+
+          # @return [String] Name of the model.
+          attr_reader :name
+
+          # @return [String] Type of the model.
+          attr_reader :model_type
+
+          # @param payload [Hash] The parsed JSON payload mapping to the search model.
+          def initialize(payload)
+            @id = payload['id']
+            @name = payload['name']
+            @model_type = payload['model_type']
+          end
+
+          # String representation of the model.
+          # @return [String]
+          def to_s
+            [
+              ":Name: #{@name}",
+              ":ID: #{@id}",
+              ":Model Type: #{@model_type}",
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/parsing/search/search_models.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # Array of search models.
+        class SearchModels < Array
+          def initialize(prediction)
+            super(prediction.map { |entry| SearchModel.new(entry) })
+          end
+
+          # Default string representation.
+          # @return [String]
+          def to_s
+            return "\n" if empty?
+
+            lines = flat_map do |model|
+              [
+                "* :Name: #{model.name}",
+                "  :ID: #{model.id}",
+                "  :Model Type: #{model.model_type}",
+              ]
+            end
+
+            # Joins all lines with a newline and appends a final newline
+            # to perfectly match the C# StringBuilder output.
+            "#{lines.join("\n")}\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/parsing/search/search_response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # Models search response.
+        class SearchResponse < CommonResponse
+          # @return [Search::Search] Parsed search payload.
+          attr_reader :models
+          # @return [Search::Search] Pagination metadata.
+          attr_reader :pagination_metadata
+
+          def initialize(server_response)
+            super
+
+            @models = Search::SearchModels.new(server_response['models'])
+            @pagination_metadata = PaginationMetadata.new(server_response['pagination'])
+          end
+
+          # String representation.
+          # @return [String]
+          def to_s
+            [
+              'Models',
+              '######',
+              models.to_s,
+              'Pagination Metadata',
+              '###################',
+              pagination_metadata.to_s,
+              '',
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/parsing/search.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'search/pagination_metadata'
+require_relative 'search/search_model'
+require_relative 'search/search_models'
+require_relative 'search/search_response'

data/lib/mindee/v2/parsing.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'parsing/common_response'
+require_relative 'parsing/error_response'
+require_relative 'parsing/field'
+require_relative 'parsing/inference_file'
+require_relative 'parsing/inference_job'
+require_relative 'parsing/inference_model'
+require_relative 'parsing/inference_active_options'
+require_relative 'parsing/job'
+require_relative 'parsing/job_response'
+require_relative 'parsing/job_webhook'
+require_relative 'parsing/rag_metadata'
+require_relative 'parsing/raw_text'
+require_relative 'parsing/raw_text_page'
+require_relative 'parsing/search'

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../parsing/base_response'
+require_relative '../../input/base_parameters'
 
 module Mindee
   module V2

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

@@ -6,6 +6,7 @@ require_relative 'params/classification_parameters'
 module Mindee
   module V2
     module Product
+      # Classification module.
       module Classification
         # Classification product.
         class Classification < BaseProduct

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'classification_result'
+require_relative '../../parsing/base_inference'
 
 module Mindee
   module V2

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

@@ -4,6 +4,7 @@ module Mindee
   module V2
     module Product
       module Classification
+        # Classification parameters.
         module Params
           # Parameters accepted by the classification utility v2 endpoint.
           class ClassificationParameters < Mindee::Input::BaseParameters

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

@@ -6,6 +6,7 @@ require_relative 'params/crop_parameters'
 module Mindee
   module V2
     module Product
+      # Crop module.
       module Crop
         # Crop product.
         class Crop < BaseProduct

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

@@ -8,13 +8,13 @@ module Mindee
         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.
+          # @return [V2::Parsing::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'])
+            @location = Mindee::V2::Parsing::Field::FieldLocation.new(server_response['location'])
           end
 
           # String representation.
@@ -22,6 +22,16 @@ module Mindee
           def to_s
             "* :Location: #{location}\n  :Object Type: #{object_type}"
           end
+
+          # Extract all crop items from this page
+          #
+          # @param input_source [Mindee::Input::Source::LocalInputSource] Local file to extract from
+          # @return [ExtractedImage]
+          def extract_from_file(input_source)
+            Image::ImageExtractor.extract_multiple_images_from_source(
+              input_source, @location.page, [@location.polygon]
+            )[0]
+          end
         end
       end
     end

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

@@ -25,6 +25,14 @@ module Mindee
           def to_s
             @inference.to_s
           end
+
+          # Apply the crop inference to a file and return a list of extracted images.
+          #
+          # @param input_source [Mindee::Input::Source::LocalInputSource] Local file to extract from
+          # @return [FileOperation::CropFiles] List of extracted PDFs
+          def extract_from_file(input_source)
+            FileOperation::Crop.extract_crops(input_source, @inference.result.crops)
+          end
         end
       end
     end

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

@@ -4,6 +4,7 @@ module Mindee
   module V2
     module Product
       module Crop
+        # Crop parameters.
         module Params
           # Parameters accepted by the crop utility v2 endpoint.
           class CropParameters < Mindee::Input::BaseParameters

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

@@ -6,10 +6,12 @@ require_relative 'params/extraction_parameters'
 module Mindee
   module V2
     module Product
+      # Extraction module.
       module Extraction
         # Extraction product.
         # Note: currently a placeholder for the `Inference` class.
-        class Extraction < Mindee::Parsing::V2::Inference
+        class Extraction < Product::BaseProduct
+          @slug = 'extraction'
           @params_type = Product::Extraction::Params::ExtractionParameters
           @response_type = Product::Extraction::ExtractionResponse
         end