mindee 4.7.1 → 4.8.0

data/docs/localized_products/us_mail_v3.md

@@ -1,152 +0,0 @@
----
-title: US US Mail
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-us-us-mail-ocr
-parentDoc: 67b49e29a2cd6f08d69a40d8
----
-The Ruby Client Library supports the [US Mail API](https://platform.mindee.com/mindee/us_mail).
-
-
-> 📝 Product Specs
->
-> | Specification                  | Details                                            |
-> | ------------------------------ | -------------------------------------------------- |
-> | Endpoint Name                  | `us_mail`                                          |
-> | Recommended Version            | `v3.0`                                             |
-> | Supports Polling/Webhooks      | ✔️ Yes                                             |
-> | Support Synchronous HTTP Calls | ❌ No                                              |
-> | Geography                      | 🇺🇸 United States                                   |
-
-> 🔐 Polling Limitations
->
-> | Setting                         | Parameter name          | Default Value |
-> | ------------------------------- | ----------------------- | ------------- |
-> | Initial Delay Before Polling    | `initial_delay_seconds` | 2 seconds     |
-> | Default Delay Between Calls     | `delay_sec`             | 1.5 seconds   |
-> | Polling Attempts Before Timeout | `max_retries`           | 80 retries    |
-
-
-The [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg) can be used for testing purposes.
-![US Mail sample](https://github.com/mindee/client-lib-test-data/blob/main/products/us_mail/default_sample.jpg?raw=true)
-
-# Quick-Start
-```rb
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-require 'mindee'
-
-# Init a new client
-mindee_client = Mindee::Client.new(api_key: 'my-api-key')
-
-# Load a file from disk
-input_source = mindee_client.source_from_path('/path/to/the/file.ext')
-
-# Parse the file
-result = mindee_client.parse(
-  input_source,
-  Mindee::Product::US::UsMail::UsMailV3
-)
-
-# Print a full summary of the parsed data in RST format
-puts result.document
-
-# Print the document-level parsed data
-# puts result.document.inference.prediction
-```
-# Field Types
-## Standard Fields
-These fields are generic and used in several products.
-
-### Basic Field
-Each prediction object contains a set of fields that inherit from the generic `Field` class.
-A typical `Field` object will have the following attributes:
-
-* **value** (`String`, `Float`, `Integer`, `bool`): corresponds to the field value. Can be `nil` if no value was extracted.
-* **confidence** (Float, nil): the confidence score of the field prediction.
-* **bounding_box** (`Mindee::Geometry::Quadrilateral`, `nil`): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
-* **polygon** (`Mindee::Geometry::Polygon`, `nil`): contains the relative vertices coordinates (`Point`) of a polygon containing the field in the image.
-* **page_id** (`Integer`, `nil`): the ID of the page, always `nil` when at document-level.
-* **reconstructed** (`bool`): indicates whether an object was reconstructed (not extracted as the API gave it).
-
-
-Aside from the previous attributes, all basic fields have access to a `to_s` method that can be used to print their value as a string.
-
-### String Field
-The text field `StringField` only has one constraint: it's **value** is a `String` (or `nil`).
-
-## Specific Fields
-Fields which are specific to this product; they are not used in any other product.
-
-### Sender Address Field
-The address of the sender.
-
-A `UsMailV3SenderAddress` implements the following attributes:
-
-* `city` (String): The city of the sender's address.
-* `complete` (String): The complete address of the sender.
-* `postal_code` (String): The postal code of the sender's address.
-* `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-* `street` (String): The street of the sender's address.
-Fields which are specific to this product; they are not used in any other product.
-
-### Recipient Addresses Field
-The addresses of the recipients.
-
-A `UsMailV3RecipientAddress` implements the following attributes:
-
-* `city` (String): The city of the recipient's address.
-* `complete` (String): The complete address of the recipient.
-* `is_address_change` (bool): Indicates if the recipient's address is a change of address.
-* `postal_code` (String): The postal code of the recipient's address.
-* `private_mailbox_number` (String): The private mailbox number of the recipient's address.
-* `state` (String): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-* `street` (String): The street of the recipient's address.
-* `unit` (String): The unit number of the recipient's address.
-
-# Attributes
-The following fields are extracted for US Mail V3:
-
-## Return to Sender
-**is_return_to_sender** ([BooleanField](#boolean-field)): Whether the mailing is marked as return to sender.
-
-```rb
-puts result.document.inference.prediction.is_return_to_sender.value
-```
-
-## Recipient Addresses
-**recipient_addresses** (Array<[UsMailV3RecipientAddress](#recipient-addresses-field)>): The addresses of the recipients.
-
-```rb
-result.document.inference.prediction.recipient_addresses do |recipient_addresses_elem|
-  puts recipient_addresses_elem.value
-end
-```
-
-## Recipient Names
-**recipient_names** (Array<[StringField](#string-field)>): The names of the recipients.
-
-```rb
-result.document.inference.prediction.recipient_names do |recipient_names_elem|
-  puts recipient_names_elem.value
-end
-```
-
-## Sender Address
-**sender_address** ([UsMailV3SenderAddress](#sender-address-field)): The address of the sender.
-
-```rb
-puts result.document.inference.prediction.sender_address.value
-```
-
-## Sender Name
-**sender_name** ([StringField](#string-field)): The name of the sender.
-
-```rb
-puts result.document.inference.prediction.sender_name.value
-```
-
-# Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/localized_products.md

@@ -1,6 +0,0 @@
----
-title: Localized Products
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-localized-products
-parentDoc: 6294d97ee723f1008d2ab28e
----

data/lib/mindee/product/us/us_mail/us_mail_v2.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'us_mail_v2_document'
-require_relative 'us_mail_v2_page'
-
-module Mindee
-  module Product
-    module US
-      # US Mail module.
-      module UsMail
-        # US Mail API version 2 inference prediction.
-        class UsMailV2 < Mindee::Parsing::Common::Inference
-          @endpoint_name = 'us_mail'
-          @endpoint_version = '2'
-          @has_async = true
-          @has_sync = false
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = UsMailV2Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(UsMailV2Page.new(page))
-            end
-          end
-
-          class << self
-            # Name of the endpoint for this product.
-            # @return [String]
-            attr_reader :endpoint_name
-            # Version for this product.
-            # @return [String]
-            attr_reader :endpoint_version
-            # Whether this product has access to an asynchronous endpoint.
-            # @return [bool]
-            attr_reader :has_async
-            # Whether this product has access to synchronous endpoint.
-            # @return [bool]
-            attr_reader :has_sync
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v2_document.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'us_mail_v2_sender_address'
-require_relative 'us_mail_v2_recipient_addresses'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # US Mail API version 2.0 document data.
-        class UsMailV2Document < Mindee::Parsing::Common::Prediction
-          include Mindee::Parsing::Standard
-          # The addresses of the recipients.
-          # @return [Mindee::Product::US::UsMail::UsMailV2RecipientAddresses]
-          attr_reader :recipient_addresses
-          # The names of the recipients.
-          # @return [Array<Mindee::Parsing::Standard::StringField>]
-          attr_reader :recipient_names
-          # The address of the sender.
-          # @return [Mindee::Product::US::UsMail::UsMailV2SenderAddress]
-          attr_reader :sender_address
-          # The name of the sender.
-          # @return [Mindee::Parsing::Standard::StringField]
-          attr_reader :sender_name
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @recipient_addresses = Product::US::UsMail::UsMailV2RecipientAddresses.new(
-              prediction['recipient_addresses'], page_id
-            )
-            @recipient_names = [] # : Array[Parsing::Standard::StringField]
-            prediction['recipient_names'].each do |item|
-              @recipient_names.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-            @sender_address = Product::US::UsMail::UsMailV2SenderAddress.new(
-              prediction['sender_address'],
-              page_id
-            )
-            @sender_name = Parsing::Standard::StringField.new(
-              prediction['sender_name'],
-              page_id
-            )
-          end
-
-          # @return [String]
-          def to_s
-            sender_address = @sender_address.to_s
-            recipient_names = @recipient_names.join("\n #{' ' * 17}")
-            recipient_addresses = recipient_addresses_to_s
-            out_str = String.new
-            out_str << "\n:Sender Name: #{@sender_name}".rstrip
-            out_str << "\n:Sender Address:"
-            out_str << sender_address
-            out_str << "\n:Recipient Names: #{recipient_names}".rstrip
-            out_str << "\n:Recipient Addresses:"
-            out_str << recipient_addresses
-            out_str[1..].to_s
-          end
-
-          private
-
-          # @param char [String]
-          # @return [String]
-          def recipient_addresses_separator(char)
-            out_str = String.new
-            out_str << '  '
-            out_str << "+#{char * 17}"
-            out_str << "+#{char * 37}"
-            out_str << "+#{char * 19}"
-            out_str << "+#{char * 13}"
-            out_str << "+#{char * 24}"
-            out_str << "+#{char * 7}"
-            out_str << "+#{char * 27}"
-            out_str << '+'
-            out_str
-          end
-
-          # @return [String]
-          def recipient_addresses_to_s
-            return '' if @recipient_addresses.empty?
-
-            line_items = @recipient_addresses.map(&:to_table_line).join("\n#{recipient_addresses_separator('-')}\n  ")
-            out_str = String.new
-            out_str << "\n#{recipient_addresses_separator('-')}"
-            out_str << "\n  |"
-            out_str << ' City            |'
-            out_str << ' Complete Address                    |'
-            out_str << ' Is Address Change |'
-            out_str << ' Postal Code |'
-            out_str << ' Private Mailbox Number |'
-            out_str << ' State |'
-            out_str << ' Street                    |'
-            out_str << "\n#{recipient_addresses_separator('=')}"
-            out_str << "\n  #{line_items}"
-            out_str << "\n#{recipient_addresses_separator('-')}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v2_page.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'us_mail_v2_document'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # US Mail API version 2.0 page data.
-        class UsMailV2Page < Mindee::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            UsMailV2PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # US Mail V2 page prediction.
-        class UsMailV2PagePrediction < UsMailV2Document
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n#{super}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v2_recipient_address.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # The addresses of the recipients.
-        class UsMailV2RecipientAddress < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The city of the recipient's address.
-          # @return [String]
-          attr_reader :city
-          # The complete address of the recipient.
-          # @return [String]
-          attr_reader :complete
-          # Indicates if the recipient's address is a change of address.
-          # @return [bool]
-          attr_reader :is_address_change
-          # The postal code of the recipient's address.
-          # @return [String]
-          attr_reader :postal_code
-          # The private mailbox number of the recipient's address.
-          # @return [String]
-          attr_reader :private_mailbox_number
-          # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-          # @return [String]
-          attr_reader :state
-          # The street of the recipient's address.
-          # @return [String]
-          attr_reader :street
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @city = prediction['city']
-            @complete = prediction['complete']
-            @is_address_change = prediction['is_address_change']
-            @postal_code = prediction['postal_code']
-            @private_mailbox_number = prediction['private_mailbox_number']
-            @state = prediction['state']
-            @street = prediction['street']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:city] = format_for_display(@city)
-            printable[:complete] = format_for_display(@complete)
-            printable[:is_address_change] = format_for_display(@is_address_change)
-            printable[:postal_code] = format_for_display(@postal_code)
-            printable[:private_mailbox_number] = format_for_display(@private_mailbox_number)
-            printable[:state] = format_for_display(@state)
-            printable[:street] = format_for_display(@street)
-            printable
-          end
-
-          # @return [Hash]
-          def table_printable_values
-            printable = {}
-            printable[:city] = format_for_display(@city, 15)
-            printable[:complete] = format_for_display(@complete, 35)
-            printable[:is_address_change] = format_for_display(@is_address_change, nil)
-            printable[:postal_code] = format_for_display(@postal_code, nil)
-            printable[:private_mailbox_number] = format_for_display(@private_mailbox_number, nil)
-            printable[:state] = format_for_display(@state, nil)
-            printable[:street] = format_for_display(@street, 25)
-            printable
-          end
-
-          # @return [String]
-          def to_table_line
-            printable = table_printable_values
-            out_str = String.new
-            out_str << format('| %- 16s', printable[:city])
-            out_str << format('| %- 36s', printable[:complete])
-            out_str << format('| %- 18s', printable[:is_address_change])
-            out_str << format('| %- 12s', printable[:postal_code])
-            out_str << format('| %- 23s', printable[:private_mailbox_number])
-            out_str << format('| %- 6s', printable[:state])
-            out_str << format('| %- 26s', printable[:street])
-            out_str << '|'
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :City: #{printable[:city]}"
-            out_str << "\n  :Complete Address: #{printable[:complete]}"
-            out_str << "\n  :Is Address Change: #{printable[:is_address_change]}"
-            out_str << "\n  :Postal Code: #{printable[:postal_code]}"
-            out_str << "\n  :Private Mailbox Number: #{printable[:private_mailbox_number]}"
-            out_str << "\n  :State: #{printable[:state]}"
-            out_str << "\n  :Street: #{printable[:street]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v2_recipient_addresses.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'us_mail_v2_sender_address'
-require_relative 'us_mail_v2_recipient_address'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # The addresses of the recipients.
-        class UsMailV2RecipientAddresses < Array
-          # Entries.
-          # @return [Array<UsMailV2RecipientAddress>]
-          attr_reader :entries
-
-          # @param prediction [Array]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            entries = prediction.map do |entry|
-              UsMail::UsMailV2RecipientAddress.new(entry, page_id)
-            end
-            super(entries)
-          end
-
-          # Creates a line of rST table-compliant string separators.
-          # @param char [String] Character to use as a separator.
-          # @return [String]
-          def self.line_items_separator(char)
-            out_str = String.new
-            out_str << "+#{char * 17}"
-            out_str << "+#{char * 37}"
-            out_str << "+#{char * 19}"
-            out_str << "+#{char * 13}"
-            out_str << "+#{char * 24}"
-            out_str << "+#{char * 7}"
-            out_str << "+#{char * 27}"
-            out_str
-          end
-
-          # @return [String]
-          def to_s
-            return '' if empty?
-
-            lines = map do |entry|
-              "\n  #{entry.to_table_line}\n#{self.class.line_items_separator('-')}"
-            end.join
-            out_str = String.new
-            out_str << "\n#{self.class.line_items_separator('-')}\n "
-            out_str << ' | City           '
-            out_str << ' | Complete Address                   '
-            out_str << ' | Is Address Change'
-            out_str << ' | Postal Code'
-            out_str << ' | Private Mailbox Number'
-            out_str << ' | State'
-            out_str << ' | Street                   '
-            out_str << " |\n#{self.class.line_items_separator('=')}"
-            out_str + lines
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/product/us/us_mail/us_mail_v2_sender_address.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        # The address of the sender.
-        class UsMailV2SenderAddress < Mindee::Parsing::Standard::FeatureField
-          include Mindee::Parsing::Standard
-          # The city of the sender's address.
-          # @return [String]
-          attr_reader :city
-          # The complete address of the sender.
-          # @return [String]
-          attr_reader :complete
-          # The postal code of the sender's address.
-          # @return [String]
-          attr_reader :postal_code
-          # Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
-          # @return [String]
-          attr_reader :state
-          # The street of the sender's address.
-          # @return [String]
-          attr_reader :street
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @city = prediction['city']
-            @complete = prediction['complete']
-            @postal_code = prediction['postal_code']
-            @state = prediction['state']
-            @street = prediction['street']
-            @page_id = page_id
-          end
-
-          # @return [Hash]
-          def printable_values
-            printable = {}
-            printable[:city] = format_for_display(@city)
-            printable[:complete] = format_for_display(@complete)
-            printable[:postal_code] = format_for_display(@postal_code)
-            printable[:state] = format_for_display(@state)
-            printable[:street] = format_for_display(@street)
-            printable
-          end
-
-          # @return [String]
-          def to_s
-            printable = printable_values
-            out_str = String.new
-            out_str << "\n  :City: #{printable[:city]}"
-            out_str << "\n  :Complete Address: #{printable[:complete]}"
-            out_str << "\n  :Postal Code: #{printable[:postal_code]}"
-            out_str << "\n  :State: #{printable[:state]}"
-            out_str << "\n  :Street: #{printable[:street]}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/sig/mindee/product/us/us_mail/us_mail_v2.rbs

@@ -1,13 +0,0 @@
-# lib/mindee/product/../us_mail/us_mail_v2.rb
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        class UsMailV2 < Parsing::Common::Inference
-          def initialize: (Hash[String | Symbol, untyped]) -> void
-        end
-      end
-    end
-  end
-end

data/sig/mindee/product/us/us_mail/us_mail_v2_document.rbs

@@ -1,20 +0,0 @@
-# lib/mindee/product/../us_mail/us_mail_v2_document.rb
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        class UsMailV2Document < Parsing::Common::Prediction
-          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-          def recipient_addresses: -> (Product::US::UsMail::UsMailV2RecipientAddresses)
-          def recipient_names: -> (Array[Parsing::Standard::StringField])
-          def sender_address: -> (Product::US::UsMail::UsMailV2SenderAddress)
-          def sender_name: -> (Parsing::Standard::StringField)
-          def recipient_addresses_separator: (String) -> String
-          def recipient_addresses_to_s: -> String
-          def to_s: -> String
-        end
-      end
-    end
-  end
-end

data/sig/mindee/product/us/us_mail/us_mail_v2_page.rbs

@@ -1,17 +0,0 @@
-# lib/mindee/product/../us_mail/us_mail_v2_page.rb
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        class UsMailV2Page < Parsing::Common::Page
-          def initialize: (Hash[String | Symbol, untyped]) -> void
-        end
-        class UsMailV2PagePrediction < UsMailV2Document
-          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-          def to_s: -> String
-        end
-      end
-    end
-  end
-end

data/sig/mindee/product/us/us_mail/us_mail_v2_recipient_address.rbs

@@ -1,22 +0,0 @@
-module Mindee
-  module Product
-    module US
-      module UsMail
-        class UsMailV2RecipientAddress < Parsing::Standard::FeatureField
-          def initialize: (Hash[String | Symbol, untyped], Integer?) -> void
-          def city: -> String
-          def complete: -> String
-          def is_address_change: -> bool
-          def postal_code: -> String
-          def private_mailbox_number: -> String
-          def state: -> String
-          def street: -> String
-          def printable_values: -> Hash[String | Symbol, untyped]
-          def table_printable_values: -> Hash[String | Symbol, untyped]
-          def to_table_line: -> String
-          def to_s: -> String
-        end
-      end
-    end
-  end
-end

data/sig/mindee/product/us/us_mail/us_mail_v2_recipient_addresses.rbs

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  module Product
-    module US
-      module UsMail
-        class UsMailV2RecipientAddresses < Array[UsMailV2RecipientAddress]
-          def initialize: (Array[untyped], Integer?) -> void
-          def self.line_items_separator: (String) -> String
-          def to_s: -> String
-        end
-      end
-    end
-  end
-end