mindee 4.13.0 → 5.0.0.rc1

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

@@ -0,0 +1,32 @@
+# lib/mindee/v1/parsing/common/document.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class Document
+          def inference: -> Inference
+
+          def name: -> String
+
+          def id: -> String
+
+          def extras: -> Extras::Extras?
+
+          def ocr: -> OCR::OCR?
+
+          def n_pages: -> Integer
+
+          def self.load_ocr: (Hash[String | Symbol, untyped]) -> Parsing::Common::OCR::OCR?
+
+          def self.extract_extras: (Hash[String | Symbol, untyped]) -> Parsing::Common::Extras::Extras?
+
+          def initialize: (singleton(Parsing::Common::Inference), Hash[String | Symbol, untyped]) -> void
+
+          def to_s: -> String
+
+          def inject_full_text_ocr: (Hash[String | Symbol, untyped]) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# lib/mindee/v1/parsing/common/execution.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class Execution
+          attr_reader available_at: Time?
+          attr_reader batch_name: String
+          attr_reader created_at: Time
+          attr_reader file: ExecutionFile
+          attr_reader id: String
+          attr_reader inference: Inference
+          attr_reader priority: Symbol?
+          attr_reader reviewed_at: Time?
+          attr_reader reviewed_prediction: Prediction?
+          attr_reader status: Symbol
+          attr_reader type: String?
+          attr_reader uploaded_at: Time?
+          attr_reader workflow_id: String
+
+          def initialize: (singleton(Parsing::Common::Inference), Hash[String | Symbol, untyped]) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# lib/mindee/v1/parsing/common/execution_file.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class ExecutionFile
+          def name: -> String
+
+          def alias: -> String?
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,18 @@
+# lib/mindee/v1/parsing/common/extras/cropper_extra.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        module Extras
+          class CropperExtra
+            attr_reader croppings: Array[Standard::PositionField]
+
+            def initialize: (Hash[String | Symbol, untyped], ?Integer?) -> void
+
+            def to_s: -> String
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# lib/mindee/v1/parsing/common/extras/extras.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        module Extras
+          class Extras
+            attr_reader cropper: CropperExtra?
+            attr_reader full_text_ocr: FullTextOCRExtra
+            attr_reader rag: RAGExtra?
+
+            def initialize: (Hash[String | Symbol, untyped]) -> void
+
+            def to_s: -> String
+
+            def add_artificial_extra: (Hash[String | Symbol, untyped]) -> void
+          end
+
+          def empty?: -> bool
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# lib/mindee/v1/parsing/common/extras/full_text_ocr_extra.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        module Extras
+          class FullTextOCRExtra
+            def contents: -> String?
+
+            def language: -> String?
+
+            def initialize: (Hash[String | Symbol, untyped]) -> nil
+
+            def to_s: -> String
+
+            def <<: (?untyped?) -> untyped
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# lib/mindee/v1/parsing/common/extras/rag_extra.rb
+
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        module Extras
+          class RAGExtra
+            def matching_document_id: -> String?
+
+            def initialize: (untyped) -> nil
+
+            def to_s: -> String
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# lib/mindee/v1/parsing/common/inference.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class Inference
+          def self.endpoint_name: () -> String?
+
+          def self.endpoint_version: () -> String?
+
+          def self.has_async: () -> bool
+
+          def self.has_sync: () -> bool
+
+          attr_reader endpoint_name: String
+          attr_reader endpoint_version: String
+          attr_reader extras: Extras::Extras
+          attr_reader has_async: bool
+          attr_reader has_sync: bool
+          attr_reader is_rotation_applied: bool
+          attr_reader pages: Array[Page]
+          attr_reader product: Product
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# lib/mindee/v1/parsing/common/job.rb
+module Mindee
+  module V1
+    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[String | Symbol, untyped]
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# lib/mindee/v1/parsing/common/ocr/mvision_v1.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        module OCR
+          class MVisionV1
+            def pages: -> [ ]
+
+            def initialize: (Hash[String | Symbol, untyped]) -> void
+
+            def to_s: -> String
+
+            def reconstruct_vertically: (Array[Geometry::Point], Integer, Float) -> OCRLine
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# lib/mindee/v1/parsing/common/ocr/ocr.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        module OCR
+          class OCRWord
+            attr_reader bounding_box: Geometry::Quadrilateral
+            attr_accessor confidence: Float
+            attr_reader polygon: Geometry::Polygon
+            attr_reader text: String
+
+            def initialize: (Hash[String | Symbol, untyped]) -> void
+
+            def to_s: -> String
+          end
+
+          class OCRLine < Array[OCRWord]
+            def initialize: (?Array[untyped]?, ?Array[OCRWord]?) -> void
+
+            def sort_on_x: -> OCRLine
+
+            def to_s: -> String
+          end
+
+          class OCRPage
+            attr_reader all_words: Array[OCRWord]
+            attr_reader lines: Array[OCRLine]
+
+            def initialize: (Hash[String | Symbol, untyped]) -> void
+
+            def all_lines: -> Array[OCRLine]
+
+            def to_s: -> String
+
+            def parse_one: (Array[OCRWord], OCRWord?, Array[Integer], Array[OCRLine]) -> Array[OCRLine]?
+
+            def to_lines: -> Array[OCRLine]
+
+            def words_on_same_line?: (OCRWord, OCRWord) -> bool
+          end
+
+          class OCR
+            attr_reader mvision_v1: MVisionV1
+
+            def initialize: (Hash[String | Symbol, untyped]) -> void
+
+            def to_s: -> String
+
+            def reconstruct_vertically: (Array[Geometry::Point], Integer, ?Float) -> OCRLine
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# lib/mindee/v1/parsing/common/orientation.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class Orientation
+          attr_reader page_id: Integer?
+          attr_reader value: Integer?
+
+          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# lib/mindee/v1/parsing/common/page.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class Page
+          attr_reader extras: Extras::Extras
+          attr_reader orientation: Common::Orientation
+          attr_reader page_id: Integer
+          attr_reader prediction: untyped # Voluntary to allow proper overloads, leave as-is.
+
+          def initialize: (Hash[String | Symbol, untyped]) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,22 @@
+# lib/mindee/v1/parsing/common/workflow_response.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class WorkflowResponse
+          @api_request: ApiRequest
+          @execution: Execution
+          @raw_http: String
+
+          def execution: -> Execution
+
+          def api_request: -> ApiRequest
+
+          def raw_http: -> String
+
+          def initialize: (singleton(Parsing::Common::Inference), Hash[String | Symbol, untyped] | Net::HTTPResponse, String) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# lib/mindee/v1/parsing/standard/abstract_field.rb
+module Mindee
+  module V1
+    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[String | Symbol, 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
+end

data/sig/mindee/v1/parsing/standard/address_field.rbs

@@ -0,0 +1,28 @@
+# lib/mindee/v1/parsing/standard/address_field.rb
+module Mindee
+  module V1
+    module Parsing
+      module Standard
+        class AddressField < StringField
+          def street_number: -> String
+
+          def street_name: -> String
+
+          def po_box: -> String
+
+          def address_complement: -> String
+
+          def city: -> String
+
+          def postal_code: -> String
+
+          def state: -> String
+
+          def country: -> String
+
+          def initialize: (Hash[String | Symbol, untyped], ?Integer?, ?reconstructed: bool) -> void
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,20 @@
+# lib/mindee/v1/parsing/standard/date_field.rb
+module Mindee
+  module V1
+    module Parsing
+      module Standard
+        class DateField < BaseField
+          def date_object: -> DateTime
+
+          def value: -> String?
+
+          def raw: -> String?
+
+          def is_computed: -> bool
+
+          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
+        end
+      end
+    end
+  end
+end

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

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

data/sig/mindee/v1/parsing/standard/locale_field.rbs

@@ -0,0 +1,24 @@
+# lib/mindee/v1/parsing/standard/locale_field.rb
+module Mindee
+  module V1
+    module Parsing
+      module Standard
+        class LocaleField
+          def confidence: -> Float?
+
+          def language: -> String?
+
+          def country: -> String?
+
+          def currency: -> String?
+
+          def value: -> String?
+
+          def initialize: (Hash[String | Symbol, untyped], ?Integer?) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v1/parsing/standard/payment_details_field.rbs

@@ -0,0 +1,19 @@
+# lib/mindee/v1/parsing/standard/payment_details_field.rb
+module Mindee
+  module V1
+    module Parsing
+      module Standard
+        class PaymentDetailsField < BaseField
+          attr_reader account_number: String?
+          attr_reader iban: String?
+          attr_reader routing_number: String?
+          attr_reader swift: String?
+
+          def initialize: (Hash[String | Symbol, untyped], Integer?, ?reconstructed: bool) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v1/parsing/standard/position_field.rbs

@@ -0,0 +1,26 @@
+# lib/mindee/v1/parsing/standard/position_field.rb
+module Mindee
+  module V1
+    module Parsing
+      module Standard
+        class PositionField
+          def polygon: -> Geometry::Polygon
+
+          def value: -> Geometry::Polygon
+
+          def quadrangle: -> Geometry::Quadrilateral
+
+          def rectangle: -> Geometry::Quadrilateral
+
+          def bounding_box: -> Geometry::Quadrilateral
+
+          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
+
+          def to_s: -> String
+
+          def to_quadrilateral: (Hash[String | Symbol, Array[untyped]], String) -> Geometry::Quadrilateral?
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v1/parsing/standard/string_field.rbs

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