mindee 3.20.0 → 4.0.0

data/sig/mindee/http/workflow_endpoint.rbs

@@ -0,0 +1,14 @@
+# lib/mindee/http/workflow_endpoint.rb
+module Mindee
+  module HTTP
+    class WorkflowEndpoint
+      def api_key: -> String
+      def request_timeout: -> Integer
+      def url: -> String
+      def initialize: (untyped, ?api_key: String) -> String
+      def execute_workflow: (untyped, untyped, untyped, untyped, untyped) -> [untyped, untyped]
+      def workflow_execution_req_post: (untyped, untyped, untyped, untyped, untyped) -> untyped
+      def check_api_key: -> nil
+    end
+  end
+end

data/sig/mindee/image/extracted_image.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/image/extracted_image.rb
+module Mindee
+  module Image
+    class ExtractedImage
+      def logger: () -> untyped
+      def page_id: -> Integer
+      def element_id: -> Integer
+      def buffer: -> StringIO
+      def internal_file_name: -> String
+      def initialize: (Input::Source::LocalInputSource, Integer, Integer) -> Integer
+      def write_to_file: (String, ?String?) -> nil
+      def as_source: -> Input::Source::BytesInputSource
+    end
+  end
+end

data/sig/mindee/image/image_compressor.rbs

@@ -0,0 +1,8 @@
+# lib/mindee/image/image_compressor.rb
+module Mindee
+  module Image
+    module ImageCompressor
+      def self.compress_image: (singleton(MiniMagick::Image) | MiniMagick::Image | StringIO, ?quality: Integer, ?max_width: Integer?, ?max_height: Integer?) -> StringIO
+    end
+  end
+end

data/sig/mindee/image/image_extractor.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/image/image_extractor.rb
+module Mindee
+  module Image
+    module ImageExtractor
+      def self.attach_image_as_new_file: (untyped, ?format: String) -> untyped
+      def self.to_blob: () -> String
+      def self.extract_multiple_images_from_source: (untyped, untyped, untyped) -> Array[untyped]
+      def self.extract_images_from_polygons: (untyped, untyped, untyped, untyped) -> Array[untyped]
+      def self.create_extracted_image: (StringIO, String, untyped, untyped) -> untyped
+      def self.load_input_source_pdf_page_as_stringio: (untyped, untyped) -> untyped
+    end
+  end
+end

data/sig/mindee/image/image_utils.rbs

@@ -0,0 +1,19 @@
+# lib/mindee/image/image_utils.rb
+module Mindee
+  module Image
+    module ImageUtils
+      def self.resize_image: (singleton(MiniMagick::Image) | MiniMagick::Image, Integer, Integer) -> void
+      def self.compress_image_quality: (singleton(MiniMagick::Image) | MiniMagick::Image, untyped) -> untyped
+      def self.to_image: (singleton(MiniMagick::Image) | MiniMagick::Image | StringIO | IO | File | Tempfile?) -> (singleton(MiniMagick::Image) | MiniMagick::Image)
+      def self.image_to_stringio: (singleton(MiniMagick::Image) | MiniMagick::Image, ?String) -> StringIO
+      def self.calculate_new_dimensions: (singleton(MiniMagick::Image) | MiniMagick::Image, ?max_width: Integer | Float?, ?max_height: Integer | Float?) -> [Integer, Integer]
+      def self.calculate_dimensions_from_media_box: (singleton(MiniMagick::Image) | MiniMagick::Image, Array[Integer]?) -> [Integer, Integer]
+      def self.pdf_to_magick_image: (StringIO, Integer) -> singleton(MiniMagick::Image)
+      def self.normalize_polygon: (Geometry::Quadrilateral | Geometry::Polygon | Array[Geometry::Point]) -> Geometry::Quadrilateral
+      def self.read_page_content: (StringIO) -> singleton(MiniMagick::Image)
+      def self.crop_image: (singleton(MiniMagick::Image), Geometry::MinMax, Geometry::MinMax) -> singleton(MiniMagick::Image)
+      def self.write_image_to_buffer: (singleton(MiniMagick::Image) | MiniMagick::Image, StringIO) -> Net::BufferedIO
+      def self.determine_file_extension: (Input::Source::LocalInputSource) -> String?
+    end
+  end
+end

data/sig/mindee/input/local_response.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/input/local_response.rb
+module Mindee
+  module Input
+    class LocalResponse
+      def file: -> StringIO
+      def initialize: (untyped) -> Integer
+      def as_hash: -> nil
+      def self.process_secret_key: (untyped) -> untyped
+      def get_hmac_signature: (untyped) -> untyped
+      def valid_hmac_signature?: (untyped, untyped) -> untyped
+    end
+  end
+end

data/sig/mindee/input/sources/base64_input_source.rbs

@@ -0,0 +1,11 @@
+# lib/mindee/input/sources/base64_input_source.rb
+module Mindee
+  module Input
+    module Source
+      class Base64InputSource < LocalInputSource
+        def initialize: (String, String, ?repair_pdf: bool) -> void
+        def read_contents: (?close: bool) -> [String, String, Hash[Symbol, untyped]]
+      end
+    end
+  end
+end

data/sig/mindee/input/sources/bytes_input_source.rbs

@@ -0,0 +1,10 @@
+# lib/mindee/input/sources/bytes_input_source.rb
+module Mindee
+  module Input
+    module Source
+      class BytesInputSource < LocalInputSource
+        def initialize: (String, String, ?repair_pdf: bool) -> void
+      end
+    end
+  end
+end

data/sig/mindee/input/sources/file_input_source.rbs

@@ -0,0 +1,10 @@
+# lib/mindee/input/sources/file_input_source.rb
+module Mindee
+  module Input
+    module Source
+      class FileInputSource < LocalInputSource
+        def initialize: (File, String, ?repair_pdf: bool) -> void
+      end
+    end
+  end
+end

data/sig/mindee/input/sources/local_input_source.rbs

@@ -0,0 +1,24 @@
+# lib/mindee/input/sources/local_input_source.rb
+module Mindee
+  module Input
+    module Source
+      ALLOWED_MIME_TYPES: Array[String]
+      class LocalInputSource
+        def filename: -> String
+        def file_mimetype: -> String
+        def io_stream: -> StringIO
+        def initialize: (StringIO | File, String, ?repair_pdf: bool) -> void
+        def logger: () -> untyped
+        def rescue_broken_pdf: (StringIO) -> StringIO
+        def pdf?: -> bool
+        def process_pdf: (PageOptions) -> StringIO?
+        def read_contents: (?close: bool) -> [String, String?, Hash[:filename, String]]
+        def count_pages: -> Integer
+        def write_to_file: (String) -> void
+        def compress!: (?quality: Integer, ?max_width: Integer?, ?max_height: Integer?, ?force_source_text: bool, ?disable_source_text: bool) -> Integer
+        def source_text?: -> bool?
+      end
+      def self.convert_to_unicode_escape: (String) -> String
+    end
+  end
+end

data/sig/mindee/input/sources/path_input_source.rbs

@@ -0,0 +1,10 @@
+# lib/mindee/input/sources/path_input_source.rb
+module Mindee
+  module Input
+    module Source
+      class PathInputSource < LocalInputSource
+        def initialize: (String, ?repair_pdf: bool) -> void
+      end
+    end
+  end
+end

data/sig/mindee/input/sources/url_input_source.rbs

@@ -0,0 +1,20 @@
+# lib/mindee/input/sources/url_input_source.rb
+module Mindee
+  module Input
+    module Source
+      class URLInputSource
+        def url: -> String
+        def logger: () -> untyped
+        def initialize: (String) -> void
+        def write_to_file: (String, ?filename: String?, ?username: String?, ?password: String?, ?token: String?, ?max_redirects: Integer) -> String
+        def as_local_input_source: (?filename: String?, ?username: String?, ?password: String?, ?token: String?, ?max_redirects: Integer) -> BytesInputSource?
+        def fetch_file_content: (?username: String?, ?password: String?, ?token: String?, ?max_redirects: Integer) -> String
+        def extract_filename_from_url: (::URI::File | ::URI::FTP | ::URI::HTTP | ::URI::HTTPS | ::URI::LDAP | ::URI::LDAPS | ::URI::MailTo | ::URI::WS | ::URI::WSS | ::URI::Generic) -> String
+        def fill_filename: (String?) -> String
+        def make_request: (URI::Generic, Net::HTTP::Get, Integer) -> Net::HTTPRedirection
+        def get_file_extension: (String) -> String?
+        def generate_file_name: (?extension: String?) -> String
+      end
+    end
+  end
+end

data/sig/mindee/logging/logger.rbs

@@ -0,0 +1,9 @@
+module Mindee
+  module Logging
+    @logger: Logger
+
+    def self.logger: -> Logger
+
+    def self.logger=: (Logger) -> Logger
+  end
+end

data/sig/mindee/parsing/common/api_request.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/parsing/common/api_request.rb
+module Mindee
+  module Parsing
+    module Common
+      class ApiRequest
+        def error: -> untyped
+        def ressources: -> untyped
+        def status: -> untyped
+        def status_code: -> untyped
+        def url: -> untyped
+        def initialize: (untyped) -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/api_response.rbs

@@ -0,0 +1,27 @@
+# lib/mindee/parsing/common/api_response.rb
+module Mindee
+  module Parsing
+    module Common
+      module JobStatus
+        WAITING: :waiting
+        PROCESSING: :processing
+        COMPLETED: :completed
+        FAILURE: :failed
+        end
+      module RequestStatus
+        FAILURE: :failure
+        SUCCESS: :success
+      end
+
+
+      class ApiResponse
+        def logger: () -> untyped
+        def document: -> Parsing::Common::Document?
+        def job: -> Parsing::Common::Job?
+        def api_request: -> Parsing::Common::ApiRequest?
+        def raw_http: -> String
+        def initialize: (singleton(Parsing::Common::Inference), Hash[Symbol | String, untyped], String) -> void
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/document.rbs

@@ -0,0 +1,20 @@
+# lib/mindee/parsing/common/document.rb
+module Mindee
+  module Parsing
+    module Common
+      class Document
+        def inference: -> untyped
+        def name: -> untyped
+        def id: -> untyped
+        def extras: -> nil
+        def ocr: -> nil
+        def n_pages: -> untyped
+        def self.load_ocr: (untyped) -> Parsing::Common::OCR::OCR?
+        def self.extract_extras: (untyped) -> Parsing::Common::Extras::Extras?
+        def initialize: (untyped, untyped) -> untyped
+        def to_s: -> String
+        def inject_full_text_ocr: (untyped) -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/execution.rbs

@@ -0,0 +1,23 @@
+# lib/mindee/parsing/common/execution.rb
+module Mindee
+  module Parsing
+    module Common
+      class Execution
+        def batch_name: -> untyped
+        def created_at: -> untyped
+        def file: -> untyped
+        def id: -> untyped
+        def inference: -> untyped
+        def priority: -> untyped
+        def reviewed_at: -> untyped
+        def available_at: -> untyped
+        def reviewed_prediction: -> untyped
+        def status: -> untyped
+        def type: -> untyped
+        def uploaded_at: -> untyped
+        def workflow_id: -> untyped
+        def initialize: (untyped, untyped) -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/execution_file.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/parsing/common/execution_file.rb
+module Mindee
+  module Parsing
+    module Common
+      class ExecutionFile
+        def name: -> untyped
+        def alias: -> untyped
+        def initialize: (untyped) -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/execution_priority.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/parsing/common/execution_priority.rb
+module Mindee
+  module Parsing
+    module Common
+      module ExecutionPriority
+        LOW: :low
+        MEDIUM: :medium
+        HIGH: :high
+        def self.to_priority: (untyped) -> (:high | :low | :medium)?
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/extras/cropper_extra.rbs

@@ -0,0 +1,14 @@
+# lib/mindee/parsing/common/extras/cropper_extra.rb
+module Mindee
+  module Parsing
+    module Common
+      module Extras
+        class CropperExtra
+          def croppings: -> Array[Standard::PositionField]
+          def initialize: (untyped, ?nil) -> untyped
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/extras/extras.rbs

@@ -0,0 +1,18 @@
+# lib/mindee/parsing/common/extras/extras.rb
+module Mindee
+  module Parsing
+    module Common
+      module Extras
+        class Extras
+          def cropper: -> untyped
+          def full_text_ocr: -> untyped
+          def initialize: (untyped) -> void
+          def new: (untyped) -> void
+          def to_s: -> String
+          def add_artificial_extra: (untyped) -> nil
+        end
+        def empty?: -> bool
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/extras/full_text_ocr_extra.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/parsing/common/extras/full_text_ocr_extra.rb
+module Mindee
+  module Parsing
+    module Common
+      module Extras
+        class FullTextOCRExtra
+          def contents: -> untyped
+          def language: -> untyped
+          def initialize: (untyped) -> nil
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# lib/mindee/parsing/common/inference.rb
+module Mindee
+  module Parsing
+    module Common
+      class Inference
+        def is_rotation_applied: -> untyped
+        def pages: -> Array[Page]
+        def prediction: -> untyped
+        def product: -> untyped
+        def initialize: (untyped) -> void
+        def to_s: -> String
+        def self.endpoint_name: -> String
+        def self.endpoint_version: -> String
+        def self.has_async: -> bool
+        def self.has_sync: -> bool
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/job.rbs

@@ -0,0 +1,16 @@
+# lib/mindee/parsing/common/job.rb
+module Mindee
+  module Parsing
+    module Common
+      class Job
+        def id: -> String
+        def issued_at: -> Time
+        def available_at: -> Time
+        def status: () -> (:waiting | :processing | :completed | :failed)
+        def millisecs_taken: -> Integer
+        def error: -> Hash[Symbol | String, untyped]
+        def initialize: (Hash[Symbol | String, untyped]) -> void
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/ocr/mvision_v1.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/parsing/common/ocr/mvision_v1.rb
+module Mindee
+  module Parsing
+    module Common
+      module OCR
+        class MVisionV1
+          def pages: -> []
+          def initialize: (untyped) -> untyped
+          def to_s: -> String
+          def reconstruct_vertically: (untyped, untyped, untyped) -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/ocr/ocr.rbs

@@ -0,0 +1,39 @@
+# lib/mindee/parsing/common/ocr/ocr.rb
+module Mindee
+  module Parsing
+    module Common
+      module OCR
+        class OCRWord
+          def confidence: -> untyped
+          def confidence=: (untyped) -> untyped
+          def text: -> untyped
+          def bounding_box: -> untyped
+          def polygon: -> untyped
+          def initialize: (untyped) -> void
+          def to_s: -> untyped
+        end
+        class OCRLine < Array[untyped]
+          def initialize: (?Array[untyped]?, ?Array[untyped]?) -> void
+          def sort_on_x: -> OCRLine
+          def to_s: -> String
+        end
+        class OCRPage
+          def all_words: -> Array[untyped]
+          def lines: -> Array[untyped]
+          def initialize: (untyped) -> untyped
+          def all_lines: -> Array[untyped]
+          def to_s: -> String
+          def parse_one: (Array[OCRWord], untyped, Array[untyped], Array[untyped]) -> Array[OCRLine]?
+          def to_lines: -> Array[untyped]
+          def words_on_same_line?: (OCRWord, OCRWord) -> untyped
+        end
+        class OCR
+          def mvision_v1: -> untyped
+          def initialize: (untyped) -> untyped
+          def to_s: -> untyped
+          def reconstruct_vertically: (untyped, untyped, ?Float) -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/orientation.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/parsing/common/orientation.rb
+module Mindee
+  module Parsing
+    module Common
+      class Orientation
+        def page_id: -> untyped
+        def value: -> untyped
+        def initialize: (untyped, untyped) -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/page.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/parsing/common/page.rb
+module Mindee
+  module Parsing
+    module Common
+      class Page
+        def page_id: -> untyped
+        def orientation: -> untyped
+        def prediction: -> untyped
+        def extras: -> untyped
+        def initialize: (untyped) -> void
+        def to_s: -> String
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/prediction.rbs

@@ -0,0 +1,11 @@
+# lib/mindee/parsing/common/prediction.rb
+module Mindee
+  module Parsing
+    module Common
+      class Prediction
+        def to_s: -> String
+        def initialize: (untyped?, untyped?) -> void
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/product.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/parsing/common/product.rb
+module Mindee
+  module Parsing
+    module Common
+      class Product
+        def name: -> untyped
+        def type: -> untyped
+        def version: -> untyped
+        def initialize: (Hash[String, untyped]) -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/common/workflow_response.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/parsing/common/workflow_response.rb
+module Mindee
+  module Parsing
+    module Common
+      class WorkflowResponse
+        def execution: -> untyped
+        def api_request: -> untyped
+        def raw_http: -> untyped
+        def initialize: (untyped, untyped, untyped) -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/abstract_field.rbs

@@ -0,0 +1,19 @@
+# lib/mindee/parsing/standard/abstract_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class AbstractField
+        def bounding_box: -> Geometry::Polygon?
+        def polygon: -> Geometry::Polygon?
+        def page_id: -> Integer?
+        def confidence: -> Float?
+        def confidence=: (Float?) -> Float?
+        def initialize: (Hash[Symbol | String, untyped], Integer?) -> void
+        def to_s: -> String
+        def self.array_confidence: (Array[untyped]) -> Float
+        def self.array_sum: (Array[untyped]) -> Float
+        def self.float_to_string: (Float, ?Integer) -> String
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/amount_field.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/parsing/standard/amount_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class AmountField # failed to identify its superclass
+        def value: -> untyped
+        def initialize: (untyped, untyped, ?reconstructed: false) -> nil
+        def to_s: -> untyped
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/base_field.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/parsing/standard/base_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class BaseField < Parsing::Standard::AbstractField
+        def initialize: (Hash[Symbol | String, untyped], Integer?, ?reconstructed: bool) -> void
+        def value: -> (String | Float | Integer | bool)
+        def reconstructed: -> bool
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/boolean_field.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/parsing/standard/boolean_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class BooleanField < BaseField
+        def value: -> bool?
+        def initialize: (Hash[Symbol | String, untyped], ?Integer?, ?reconstructed: false) -> void
+        def to_s: -> String
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/classification_field.rbs

@@ -0,0 +1,10 @@
+# lib/mindee/parsing/standard/classification_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class ClassificationField < BaseField
+        def value: -> String
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/company_registration_field.rbs

@@ -0,0 +1,14 @@
+# lib/mindee/parsing/standard/company_registration_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class CompanyRegistrationField < BaseField
+        def type: -> untyped
+        def initialize: (untyped, untyped, ?reconstructed: false) -> untyped
+        def to_table_line: -> String
+        def to_s: -> String
+        def printable_values: -> Hash[String, untyped]
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/date_field.rbs

@@ -0,0 +1,14 @@
+# lib/mindee/parsing/standard/date_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class DateField # failed to identify its superclass
+        def date_object: -> untyped
+        def value: -> untyped
+        def raw: -> untyped
+        def is_computed: -> untyped
+        def initialize: (untyped, untyped) -> nil
+      end
+    end
+  end
+end

data/sig/mindee/parsing/standard/feature_field.rbs

@@ -0,0 +1,10 @@
+# lib/mindee/parsing/standard/feature_field.rb
+module Mindee
+  module Parsing
+    module Standard
+      class FeatureField < BaseField
+        def format_for_display: (String | bool?, ?Integer?) -> String
+      end
+    end
+  end
+end