mindee-lite 5.0.0.beta1

data/sig/mindee/input/polling_options.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/input/polling_options.rb
+module Mindee
+  module Input
+    class PollingOptions
+      attr_reader delay_sec: Integer | Float
+      attr_reader initial_delay_sec: Integer | Float
+      attr_reader max_retries: Integer
+
+      def initialize: (?initial_delay_sec: Float, ?delay_sec: Float, ?max_retries: Integer) -> Integer
+    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?, Hash[:filename, String]]
+      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,30 @@
+# lib/mindee/input/sources/local_input_source.rb
+module Mindee
+  module Input
+    module Source
+      ALLOWED_MIME_TYPES: Array[String]
+      class LocalInputSource
+        attr_reader file_mimetype: String
+        attr_reader filename: String
+        attr_reader io_stream: StringIO | File
+        def initialize: (StringIO | File, String, ?repair_pdf: bool) -> void
+
+        def fix_pdf!: (?maximum_offset: Integer) -> void
+        def self.fix_pdf: (StringIO | File, ?maximum_offset: Integer) -> StringIO
+
+        def logger: () -> Logger
+
+        def rescue_broken_pdf: (untyped) -> void
+        def pdf?: -> bool
+        def apply_page_options: (PageOptions) -> StringIO?
+        def process_pdf: (PageOptions) -> StringIO?
+        def read_contents: (?close: bool) -> [String?, Hash[:filename, String]]
+        def page_count: -> 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: () -> Logger
+        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,11 @@
+module Mindee
+  module Logging
+    @logger: Logger
+
+    def self.logger: -> Logger
+    def debug: (?untyped?) -> void
+    def info: (?untyped?) -> void
+
+    def self.logger=: (Logger) -> Logger
+  end
+end

data/sig/mindee/page_options.rbs

@@ -0,0 +1,11 @@
+# lib/mindee/page_options.rb
+
+module Mindee
+  class PageOptions
+    attr_accessor page_indexes: Array[Integer]
+    attr_accessor operation: :KEEP_ONLY | :REMOVE
+    attr_accessor on_min_pages: Integer?
+
+    def initialize: (params: Hash[String | Symbol, untyped]) -> void
+  end
+end

data/sig/mindee/pdf/extracted_pdf.rbs

@@ -0,0 +1,17 @@
+# lib/mindee/pdf/extracted_pdf.rb
+module Mindee
+  module PDF
+    class ExtractedPDF
+      attr_reader pdf_bytes: StringIO
+      attr_reader filename: String
+
+      def initialize: (StringIO | File, String) -> void
+
+      def page_count: -> Integer
+
+      def write_to_file: (String, ?override: bool) -> void
+
+      def as_input_source: -> Input::Source::BytesInputSource
+    end
+  end
+end

data/sig/mindee/pdf/pdf_compressor.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/pdf/pdf_compressor.rb
+PDFReader: untyped
+PDF: untyped
+module Mindee
+  module PDF
+    module PDFCompressor
+      def self.logger: () -> Logger
+      def self.compress_pdf: (StringIO | File, ?quality: Integer, ?force_source_text_compression: bool, ?disable_source_text: bool) -> (StringIO | File)
+      def self.process_pdf_pages: (Origami::PDF, Integer) -> Array[Origami::Page]
+      def self.create_output_pdf: (Array[Origami::Page], bool, StringIO | File) -> Origami::PDF
+      def self.inject_text: (StringIO | File, Array[Origami::Page]) -> nil
+      def self.process_pdf_page: (StringIO, Integer, Integer, Array[Integer]?) -> Origami::Page
+    end
+  end
+end

data/sig/mindee/pdf/pdf_extractor.rbs

@@ -0,0 +1,19 @@
+# lib/mindee/pdf/pdf_extractor.rb
+module Mindee
+  module PDF
+    class PDFExtractor
+      attr_reader filename: String
+      attr_reader source_pdf: StringIO
+
+      def initialize: (Input::Source::LocalInputSource) -> void
+
+      def page_count: -> Integer
+
+      def cut_pages: (Array[Integer]) -> StringIO
+
+      def extract_sub_documents: (Array[Array[Integer]]) -> Array[ExtractedPDF]
+
+      def extract_invoices: (Array[V1::Product::InvoiceSplitter::InvoiceSplitterV1InvoicePageGroup] | Array[Array[Integer]], ?strict: bool) -> Array[ExtractedPDF]
+    end
+  end
+end

data/sig/mindee/pdf/pdf_processor.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/pdf/pdf_processor.rb
+module Mindee
+  module PDF
+    module PDFProcessor
+      def self.parse: (StringIO | File, PageOptions) -> StringIO
+      def self.indexes_from_keep: (Array[Integer], Array[Integer]) -> (Array[Integer])
+      def self.indexes_from_remove: (Array[Integer], Array[Integer]) -> (Array[Integer])
+      def self.open_pdf: (StringIO | File) -> Origami::PDF
+      def self.get_page: (Origami::PDF, Integer) -> StringIO
+    end
+  end
+end

data/sig/mindee/pdf/pdf_tools.rbs

@@ -0,0 +1,31 @@
+# lib/mindee/pdf/pdf_tools.rb
+module Mindee
+  module PDF
+    module PDFTools
+      BitsPerComponent: Integer
+      ColorSpace: Symbol
+      Contents: Origami::Stream
+      Height: Integer | Float
+      Width: Integer | Float
+
+      def self.pdf_header?: (StringIO | File) -> bool
+
+      def to_io_stream: (?Hash[Symbol, untyped]) -> StringIO
+      def intents_as_pdfa1: () -> void
+      def delinearize!: () -> void
+      def linearized?: () -> bool
+      def compile: (Hash[String | Symbol, untyped]) -> StringIO
+      def output: (Hash[String | Symbol, untyped]) -> String
+      def load_all_objects: () -> void
+      def self.stream_has_text?: (Origami::Stream) -> bool
+      def self.source_text?: (StringIO | File) -> bool
+      def self.create_xobject: (MiniMagick::Image) -> Origami::Graphics::ImageXObject
+      def self.set_xobject_properties: (Origami::Graphics::ImageXObject, MiniMagick::Image) -> void
+      def self.determine_filter: (MiniMagick::Image) -> (:DCTDecode | :FlateDecode | :LZWDecode)
+      def self.determine_colorspace: (MiniMagick::Image) -> (:DeviceCMYK | :DeviceGray | :DeviceRGB)
+      def self.add_content_to_page: (Origami::Page, String, Integer, Integer) -> void
+      def self.set_page_dimensions: (Origami::Page, Integer | Float, Integer | Float) -> void
+      def self.process_image_xobject: (MiniMagick::Image | StringIO, Integer, Integer | Float, Integer | Float) -> Origami::Graphics::ImageXObject
+    end
+  end
+end

data/sig/mindee/v1/client.rbs

@@ -0,0 +1,84 @@
+# lib/v1/mindee/client.rb
+
+module Mindee
+  module V1
+    OTS_OWNER: String
+
+    class ParseOptions
+      attr_accessor all_words: bool
+      attr_accessor full_text: bool
+      attr_accessor close_file: bool
+      attr_accessor page_options: PageOptions
+      attr_accessor cropper: bool
+      attr_accessor rag: bool
+      attr_accessor workflow_id: String?
+      attr_accessor initial_delay_sec: Integer | Float
+      attr_accessor delay_sec: Integer | Float
+      attr_accessor max_retries: Integer
+
+      def initialize: (params: Hash[String | Symbol, untyped]) -> void
+    end
+
+    class WorkflowOptions
+      attr_accessor document_alias: (String?)
+      attr_accessor priority: (Symbol?)
+      attr_accessor full_text: bool
+      attr_accessor rag: bool?
+      attr_accessor public_url: (String?)
+      attr_accessor page_options: (PageOptions)
+      attr_accessor close_file: bool
+
+      def initialize: (params: Hash[String | Symbol, untyped]) -> void
+    end
+
+    class Client
+      @api_key: String?
+
+      def initialize: (?api_key: String) -> void
+
+      def logger: () -> Logging
+
+      def parse: (Input::Source::LocalInputSource | Input::Source::URLInputSource, singleton(V1::Parsing::Common::Inference), ?endpoint: (V1::HTTP::Endpoint?), options: ParseOptions | Hash[String | Symbol, untyped]) -> V1::Parsing::Common::ApiResponse
+
+      def parse_sync: (Input::Source::LocalInputSource | Input::Source::URLInputSource, singleton(V1::Parsing::Common::Inference), V1::HTTP::Endpoint, ParseOptions) -> V1::Parsing::Common::ApiResponse
+
+      def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, singleton(V1::Parsing::Common::Inference), ?endpoint: (V1::HTTP::Endpoint?), options: ParseOptions | Hash[String | Symbol, untyped]) -> V1::Parsing::Common::ApiResponse
+
+      def parse_queued: (String, singleton(V1::Parsing::Common::Inference), ?endpoint: V1::HTTP::Endpoint?) -> V1::Parsing::Common::ApiResponse
+
+      def enqueue_and_parse: (Input::Source::URLInputSource | Input::Source::LocalInputSource, singleton(V1::Parsing::Common::Inference), V1::HTTP::Endpoint, ParseOptions) -> V1::Parsing::Common::ApiResponse
+
+      def execute_workflow: (Input::Source::URLInputSource | Input::Source::LocalInputSource, String, options: (Hash[String | Symbol, untyped] | WorkflowOptions)) -> V1::Parsing::Common::WorkflowResponse
+
+      def load_prediction: (singleton(V1::Parsing::Common::Inference), Input::LocalResponse) -> V1::Parsing::Common::ApiResponse
+
+      def source_from_path: (String, ?repair_pdf: bool) -> Input::Source::PathInputSource
+
+      def source_from_bytes: (String, String, ?repair_pdf: bool) -> Input::Source::BytesInputSource
+
+      def source_from_b64string: (String, String, ?repair_pdf: bool) -> Input::Source::Base64InputSource
+
+      def source_from_file: (File, String, ?repair_pdf: bool) -> Input::Source::FileInputSource
+
+      def source_from_url: (String) -> Input::Source::URLInputSource
+
+      def create_endpoint: (endpoint_name: String, account_name: String, version: String) -> V1::HTTP::Endpoint
+
+      private
+
+      def normalize_parse_options: ((Hash[String | Symbol, untyped] | ParseOptions)) -> ParseOptions
+
+      def process_pdf_if_required: (Input::Source::LocalInputSource, ParseOptions | WorkflowOptions) -> void
+
+      def initialize_endpoint: (singleton(V1::Parsing::Common::Inference), ?endpoint_name: String, ?account_name: String, ?version: String) -> V1::HTTP::Endpoint
+
+      def validate_async_params: (Integer | Float, Integer | Float, Integer) -> void
+
+      def fix_endpoint_name: (singleton(V1::Parsing::Common::Inference), String?) -> String
+
+      def fix_account_name: (String) -> String
+
+      def fix_version: (singleton(V1::Parsing::Common::Inference), String) -> String
+    end
+  end
+end

data/sig/mindee/v1/extraction/multi_receipts_extractor.rbs

@@ -0,0 +1,8 @@
+# lib/mindee/v1/extraction/multi_receipts_extractor.rb
+module Mindee
+  module V1
+    module Extraction
+      def self.extract_receipts: (Input::Source::LocalInputSource, Product::MultiReceiptsDetector::MultiReceiptsDetectorV1) -> Array[Image::ExtractedImage]
+    end
+  end
+end

data/sig/mindee/v1/http/endpoint.rbs

@@ -0,0 +1,41 @@
+# lib/mindee/v1/http/endpoint.rb
+module Mindee
+  module V1
+    module HTTP
+      API_KEY_ENV_NAME: String
+      API_KEY_DEFAULT: String?
+      BASE_URL_ENV_NAME: String
+      BASE_URL_DEFAULT: String
+      REQUEST_TIMEOUT_ENV_NAME: String
+      TIMEOUT_DEFAULT: Integer
+      USER_AGENT: String
+
+      class Endpoint
+        attr_reader api_key: String
+        attr_reader base_url: String
+        attr_reader request_timeout: Integer
+        attr_reader url_root: String
+
+        def logger: () -> Logger
+
+        def initialize: (String, String, String?, ?api_key: String) -> String
+
+        def predict: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Hash[String | Symbol, untyped], String]
+
+        def predict_async: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Hash[String | Symbol, untyped], String]
+
+        def parse_async: (String) -> [Hash[String | Symbol, untyped], String]
+
+        def predict_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> Net::HTTPResponse
+
+        def document_queue_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> Net::HTTPResponse
+
+        def document_queue_req_get: (String) -> Net::HTTPResponse
+
+        def check_api_key: -> void
+
+        def configure_ssl: (Net::HTTP) -> void
+      end
+    end
+  end
+end

data/sig/mindee/v1/http/workflow_endpoint.rbs

@@ -0,0 +1,22 @@
+# lib/mindee/v1/http/workflow_endpoint.rb
+module Mindee
+  module V1
+    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: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> [Hash[String, untyped], String]
+
+        def workflow_execution_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> Net::HTTPResponse?
+
+        def check_api_key: -> nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# lib/mindee/v1/parsing/common/api_request.rb
+module Mindee
+  module V1
+    module Parsing
+      module Common
+        class ApiRequest
+          def error: -> Hash[String, untyped]
+
+          def ressources: -> Array[String]
+
+          def status: -> [RequestStatus, Symbol]
+
+          def status_code: -> Integer
+
+          def url: -> String
+
+          def initialize: (Hash[String, untyped]) -> void
+        end
+      end
+    end
+  end
+end

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

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

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