mindee 3.19.1 → 4.0.0

data/docs/bank_statement_fr_v1.md

@@ -1,178 +0,0 @@
----
-title: FR Bank Statement (FR) OCR Ruby
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-fr-bank-statement-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
----
-The Ruby OCR SDK supports the [Bank Statement (FR) API](https://platform.mindee.com/mindee/bank_statement_fr).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/bank_statement_fr/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
-![Bank Statement (FR) sample](https://github.com/mindee/client-lib-test-data/blob/main/products/bank_statement_fr/default_sample.jpg?raw=true)
-
-# Quick-Start
-```rb
-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.enqueue_and_parse(
-  input_source,
-  Mindee::Product::FR::BankStatement::BankStatementV1
-)
-
-# 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
-```
-
-**Output (RST):**
-```rst
-```
-
-# 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`, `Boolean`): 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, is `nil` when at document-level.
-* **reconstructed** (`Boolean`): 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.
-
-
-### Amount Field
-The amount field `AmountField` only has one constraint: its **value** is a `Float` (or `nil`).
-
-### Date Field
-Aside from the basic `Field` attributes, the date field `DateField` also implements the following: 
-
-* **date_object** (`Date`): an accessible representation of the value as a JavaScript object.
-
-### 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.
-
-### Transactions Field
-The list of values that represent the financial transactions recorded in a bank statement.
-
-A `BankStatementV1Transaction` implements the following attributes:
-
-* `amount` (Float): The monetary amount of the transaction.
-* `date` (String): The date on which the transaction occurred.
-* `description` (String): The additional information about the transaction.
-
-# Attributes
-The following fields are extracted for Bank Statement (FR) V1:
-
-## Account Number
-**account_number** ([StringField](#string-field)): The unique identifier for a customer's account in the bank's system.
-
-```rb
-puts result.document.inference.prediction.account_number.value
-```
-
-## Bank Address
-**bank_address** ([StringField](#string-field)): The physical location of the bank where the statement was issued.
-
-```rb
-puts result.document.inference.prediction.bank_address.value
-```
-
-## Bank Name
-**bank_name** ([StringField](#string-field)): The name of the bank that issued the statement.
-
-```rb
-puts result.document.inference.prediction.bank_name.value
-```
-
-## Client Address
-**client_address** ([StringField](#string-field)): The address of the client associated with the bank statement.
-
-```rb
-puts result.document.inference.prediction.client_address.value
-```
-
-## Client Name
-**client_name** ([StringField](#string-field)): The name of the client who owns the bank statement.
-
-```rb
-puts result.document.inference.prediction.client_name.value
-```
-
-## Closing Balance
-**closing_balance** ([AmountField](#amount-field)): The final amount of money in the account at the end of the statement period.
-
-```rb
-puts result.document.inference.prediction.closing_balance.value
-```
-
-## Opening Balance
-**opening_balance** ([AmountField](#amount-field)): The initial amount of money in an account at the start of the period.
-
-```rb
-puts result.document.inference.prediction.opening_balance.value
-```
-
-## Statement Date
-**statement_date** ([DateField](#date-field)): The date on which the bank statement was generated.
-
-```rb
-puts result.document.inference.prediction.statement_date.value
-```
-
-## Statement End Date
-**statement_end_date** ([DateField](#date-field)): The date when the statement period ends.
-
-```rb
-puts result.document.inference.prediction.statement_end_date.value
-```
-
-## Statement Start Date
-**statement_start_date** ([DateField](#date-field)): The date when the bank statement period begins.
-
-```rb
-puts result.document.inference.prediction.statement_start_date.value
-```
-
-## Total Credits
-**total_credits** ([AmountField](#amount-field)): The total amount of money deposited into the account.
-
-```rb
-puts result.document.inference.prediction.total_credits.value
-```
-
-## Total Debits
-**total_debits** ([AmountField](#amount-field)): The total amount of money debited from the account.
-
-```rb
-puts result.document.inference.prediction.total_debits.value
-```
-
-## Transactions
-**transactions** (Array<[BankStatementV1Transaction](#transactions-field)>): The list of values that represent the financial transactions recorded in a bank statement.
-
-```rb
-for transactions_elem in result.document.inference.prediction.transactions do
-  puts transactions_elem.value
-end
-```
-
-# Questions?
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)

data/docs/code_samples/bank_statement_fr_v1_async.txt

@@ -1,19 +0,0 @@
-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.enqueue_and_parse(
-  input_source,
-  Mindee::Product::FR::BankStatement::BankStatementV1
-)
-
-# 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

data/docs/code_samples/custom_v1.txt

@@ -1,33 +0,0 @@
-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')
-
-# Initialize a custom endpoint for this product
-custom_endpoint = mindee_client.create_endpoint(
-  account_name: 'my-account',
-  endpoint_name: 'my-endpoint'
-)
-
-# Parse the file
-result = mindee_client.parse(
-  input_source,
-  Mindee::Product::Custom::CustomV1,
-  endpoint: custom_endpoint
-)
-
-# 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
-
-# Looping over all prediction values
-result.document.inference.prediction.fields.each do |field_name, field_data|
-  puts field_name
-  puts field_data.values
-  puts field_data.to_s
-end

data/docs/code_samples/eu_driver_license_v1.txt

@@ -1,19 +0,0 @@
-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::EU::DriverLicense::DriverLicenseV1
-)
-
-# 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

data/docs/code_samples/expense_receipts_v4.txt

@@ -1,19 +0,0 @@
-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::Receipt::ReceiptV4
-)
-
-# 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

data/docs/code_samples/proof_of_address_v1.txt

@@ -1,19 +0,0 @@
-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::ProofOfAddress::ProofOfAddressV1
-)
-
-# 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

data/docs/code_samples/us_mail_v2_async.txt

@@ -1,19 +0,0 @@
-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.enqueue_and_parse(
-  input_source,
-  Mindee::Product::US::UsMail::UsMailV2
-)
-
-# 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

data/docs/code_samples/workflow_execution.txt

@@ -1,29 +0,0 @@
-require 'mindee'
-
-workflow_id = 'workflow-id'
-
-# 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')
-
-# Send the file to the workflow
-result = mindee_client.execute_workflow(
-  input_source,
-  workflow_id
-)
-
-# Alternatively, set an alias & a priority for the execution.
-# result = mindee_client.execute_workflow(
-#   input_source,
-#   workflow_id,
-#   document_alias: "my-alias",
-#   priority: Mindee::Parsing::Common::ExecutionPriority::LOW
-# )
-
-# Print the execution's ID to make sure it worked
-puts result.execution.id
-
-# Print the inference, if present
-# puts result.document.inference

data/docs/custom_v1.md

@@ -1,111 +0,0 @@
----
-title: Custom API Ruby (Deprecated)
-category: 622b805aaec68102ea7fcbc2
-slug: ruby-api-builder-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
----
-> 🚧 This product is still supported, but is considered to be deprecated. If you are looking for the docTI API documentation, you can find it [here](https://developers.mindee.com/docs/ruby-generated-ocr).
-
-# Quick-Start
-
-```rb
-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')
-
-# Initialize a custom endpoint for this product
-custom_endpoint = mindee_client.create_endpoint(
-  account_name: 'my-account',
-  endpoint_name: 'my-endpoint'
-)
-
-# Parse the file
-result = mindee_client.parse(
-  input_source,
-  Mindee::Product::Custom::CustomV1,
-  endpoint: custom_endpoint
-)
-
-# 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
-
-# Looping over all prediction values
-result.document.inference.prediction.fields.each do |field_name, field_data|
-  puts field_name
-  puts field_data.values
-  puts field_data.to_s
-end
-```
-
-# Custom Endpoints
-
-You may have noticed in the previous step that in order to access a custom build, you will need to provide an account and an endpoint name at the very least.
-
-Although it is optional, the version number should match the latest version of your build in most use-cases.
-If it is not set, it will default to "1".
-
-
-# Field Types
-
-## Custom Fields
-
-### List Field
-
-A `ListField` is a special type of custom list that implements the following:
-
-* **confidence** (`Float`): the confidence score of the field prediction.
-* **reconstructed** (`Boolean`): indicates whether or not an object was reconstructed (not extracted as the API gave it).
-* **values** (`Array<`[ListFieldItem](#list-field-item)`>`): list of value fields
-
-Since the inner contents can vary, the value isn't accessed through a property, but rather through the following functions:
-* **contents_list()** (`[Array, Hash, String, nil]`): returns a list of values for each element.
-* **contents_str(separator:' ')** (`String`): returns a list of concatenated values, with an optional **separator** `String` between them.
-* **to_s()**: returns a string representation of all values, with an empty space between each of them.
-
-#### List Field Item
-
-Values of `ListField`s are stored in a `ListFieldItem` structure, which is implemented as follows:
-* **content** (`String`): extracted content of the prediction
-* **confidence** (`Float`): the confidence score of the prediction
-* **bounding_box** (`Quadrilateral`): 4 relative vertices corrdinates of a rectangle containing the word in the document.
-* **polygon** (`Polygon`): vertices of a polygon containing the word.
-* **page_id** (`Integer`): the ID of the page, is `nil` when at document-level.
-
-### Classification Field
-
-A `ClassificationField` is a special type of custom classification that implements the following:
-
-* **value** (`String`): the value of the classification. Corresponds to one of the values specified during training.
-* **confidence** (`Float`): the confidence score of the field prediction.
-* **to_s()**: returns a string representation of all values, with an empty space between each of them.
-
-# Attributes
-
-Custom builds always have access to at least two attributes:
-
-## Fields
-
-**fields** ({`String`=> [ListField](#list-field)}): 
-
-```rb
-puts result.document.inference.prediction.fields[:my_field].value
-```
-
-## Classifications
-
-**classifications** ({`String` => [ClassificationField](#classification-field)}): The purchase category among predefined classes.
-
-```js
-console.log(result.document.inference.prediction.classifications["my-classification"].to_s);
-```
-
-# Questions?
-
-[Join our Slack](https://join.slack.com/t/mindee-community/shared_invite/zt-2d0ds7dtz-DPAF81ZqTy20chsYpQBW5g)