mindee 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 729bb9b6e8643c95c194583c4c7e217f9cbdc68149a72125767a2191291142be
-  data.tar.gz: cc2233ca32e0fadaf445e731417238b0fa272865f949fd0c91ef61916f86dfb4
+  metadata.gz: 927e4d22c8f54feebaace71c40705a1e130d4737fce8487ae24b7c369f2aa3ea
+  data.tar.gz: 99101cdf1573be19a82ee0cd04bd54cc45edff95bac113902174f45c3ae4de4d
 SHA512:
-  metadata.gz: 162501228d7fed6ac0829aefcaae88390d43a91cd7b516a837471964b181fe084f9d200e6db447fb4c3b137c3f93ea801661e75ac151a087702143574b8ee9b6
-  data.tar.gz: 960d67e2a53626d3399628b9190972025df886efe50791dc72e5cb0d327f49c99352c66361ff952912b30288c562d3169d2f67ec49a0f8310ed47b40aeedb11d
+  metadata.gz: 38b335f5baf0b8a4757e31956472314f11e01d901c24e8e24990f48e90292d0bac7c4aba79a30ea4db27188c88d7957282fc19d08c653b3b7fce489a923f6c9a
+  data.tar.gz: 8f87a88fff6e4284a326c563f60e67c8a85e2516cb96f103ba648b5ac2366298e59fc1c60f120f4e797b738c71dc391dc881317bd1e9825d2a3f9513f9b63e5d

data/.gitignore

@@ -15,6 +15,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/vendor
 /mindee-*/
 
 # Used by dotenv library to load environment variables.

data/.yardopts

@@ -1,4 +1,3 @@
 --markup markdown
 --main README.md
---files docs/ruby-getting-started.md,docs/ruby-invoice-ocr.md,docs/ruby-passport-ocr.md,docs/ruby-receipt-ocr.md
 --output-dir docs/_build

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Mindee Ruby API Library Changelog
 
+## v2.1.1 - 2023-04-21
+### Changes
+* :memo: minor docstring improvements
+* :coffin: remove redundant local checks
+* :memo: publish documentation
+* :memo: add code samples
+
+
+## v2.1.0 - 2023-01-30
+### Changes
+* :sparkles: Add financial document v1 support (Co-authored-by: Oriol Gual)
+* :sparkles: Add Proof of Address v1 support
+
+
 ## v2.0.0 - 2023-01-13
 ### ¡Breaking Changes!
 * :sparkles: add improved PDF merge system
@@ -17,6 +31,7 @@
 * :white_check_mark: add testing on Ruby 3.2
 * :sparkles: allow setting the request timeout from env
 
+
 ## v1.2.0 - 2022-12-26
 ### Changes
 * :arrow_up: switch to origamindee => adds support for Ruby 3

data/README.md

@@ -52,7 +52,7 @@ result = mindee_client.doc_from_path('/path/to/the/file.ext')
   .parse(Mindee::Prediction::EU::LicensePlateV1)
 
 # Print a full summary of the parsed data in RST format
-puts result.document
+puts result
 ```
 
 ### Custom Document (API Builder)
@@ -61,13 +61,13 @@ require 'mindee'
 
 # Init a new client and configure your custom document
 mindee_client = Mindee::Client.new(api_key: 'my-api-key').add_endpoint(
-  'john',
-  'wnine'
+  'my-account',
+  'my-endpoint'
 )
 
 # Load a file from disk and parse it
 result = mindee_client.doc_from_path('/path/to/the/file.ext')
-  .parse(Mindee::Prediction::CustomV1, endpoint_name: 'wnine')
+  .parse(Mindee::Prediction::CustomV1, endpoint_name: 'my-endpoint')
 
 # Print a full summary of the parsed data in RST format
 puts result
@@ -84,11 +84,15 @@ end
 There's more to it than that for those that need more features, or want to
 customize the experience.
 
-- [Ruby Overview](https://developers.mindee.com/docs/ruby-getting-started)
-- [Ruby Custom APIs OCR](https://developers.mindee.com/docs/ruby-api-builder)
-- [Ruby invoices OCR](https://developers.mindee.com/docs/ruby-invoice-ocr)
-- [Ruby receipts OCR](https://developers.mindee.com/docs/ruby-receipt-ocr)
-- [Ruby passports OCR](https://developers.mindee.com/docs/ruby-passport-ocr)
+* [Ruby Overview](https://developers.mindee.com/docs/ruby-getting-started)
+* [Ruby Custom APIs OCR](https://developers.mindee.com/docs/ruby-api-builder)
+* [Ruby invoices OCR](https://developers.mindee.com/docs/ruby-invoice-ocr)
+* [Ruby receipts OCR](https://developers.mindee.com/docs/ruby-receipt-ocr)
+* [Ruby passports OCR](https://developers.mindee.com/docs/ruby-passport-ocr)
+
+You can also take a look at the
+[Reference Documentation](https://mindee.github.io/mindee-api-ruby/).
+
 
 ## License
 Copyright © Mindee, SA

data/Rakefile

@@ -15,6 +15,14 @@ task default: :spec
 
 RSpec::Core::RakeTask.new(:spec)
 
-YARD::Rake::YardocTask.new do |task|
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new(:doc) do |task|
   task.files = ['lib/**/*.rb']
 end
+
+Rake::Task[:doc].enhance do
+  FileUtils.cp_r(
+    File.join('docs', 'code_samples'),
+    File.join('docs', '_build')
+  )
+end

data/bin/mindee.rb

@@ -10,6 +10,14 @@ DOCUMENTS = {
     help: "Custom document type from API builder",
     prediction: Mindee::Prediction::CustomV1,
   },
+  "proof-of-address" => {
+    help: 'Proof of Address',
+    prediction: Mindee::Prediction::ProofOfAddressV1,
+  },
+  "financial-document" => {
+    help: 'Financial Document',
+    prediction: Mindee::Prediction::FinancialDocumentV1,
+  },
   "invoice" => {
     help: 'Invoice',
     prediction: Mindee::Prediction::InvoiceV4,

data/docs/code_samples/bank_account_details_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::FR::BankAccountDetailsV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/bank_check_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::US::BankCheckV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/carte_vitale_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::FR::CarteVitaleV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/custom_v1.txt

@@ -0,0 +1,24 @@
+require 'mindee'
+
+# Init a new client and configure your custom document
+mindee_client = Mindee::Client.new(api_key: 'my-api-key').add_endpoint(
+  'my-account',
+  'my-endpoint'
+)
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::CustomV1, endpoint_name: 'my-endpoint')
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction
+
+# Looping over all prediction values
+result.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/default.txt

@@ -0,0 +1,16 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+
+url = URI('https://api.mindee.net/v1/products/mindee/my-endpoint/my-version/predict')
+file = '/path/to/the/file.ext'
+
+http = Net::HTTP.new(url.host, url.port)
+http.use_ssl = true
+
+request = Net::HTTP::Post.new(url)
+request['Authorization'] = 'Token my-api-key'
+request.set_form([['document', File.open(file)]], 'multipart/form-data')
+
+response = http.request(request)
+puts response.read_body

data/docs/code_samples/expense_receipts_v4.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::ReceiptV4)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/financial_document_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::FinancialDocumentV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/idcard_fr_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::FR::IdCardV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/invoices_v4.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::InvoiceV4)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/license_plates_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::EU::LicensePlateV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/passport_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::PassportV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/proof_of_address_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::ProofOfAddressV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/code_samples/shipping_containers_v1.txt

@@ -0,0 +1,14 @@
+require 'mindee'
+
+# Init a new client
+mindee_client = Mindee::Client.new(api_key: 'my-api-key')
+
+# Load a file from disk and parse it
+result = mindee_client.doc_from_path('/path/to/the/file.ext')
+  .parse(Mindee::Prediction::ShippingContainerV1)
+
+# Print a full summary of the parsed data in RST format
+puts result
+
+# Print the document-level parsed data
+# puts result.inference.prediction

data/docs/ruby-api-builder.md

@@ -1,34 +1,32 @@
-The Ruby  OCR SDK supports [custom-built API](https://developers.mindee.com/docs/build-your-first-document-parsing-api)
-from the API Builder.
+The Ruby  OCR SDK supports [custom-built API](https://developers.mindee.com/docs/build-your-first-document-parsing-api) from the API Builder.
 
 If your document isn't covered by one of Mindee's Off-the-Shelf APIs, you can create your own API using the
 [API Builder](https://developers.mindee.com/docs/overview).
 
-For the following examples, we are using our own [W9s custom API](https://developers.mindee.com/docs/w9-forms-ocr)
+For the following examples, we are using our own [W9s custom API](https://developers.mindee.com/docs/w9-forms-ocr),
 created with the [API Builder](https://developers.mindee.com/docs/overview).
 
 > 📘 **Info**
 >
-> We used a data model that may be different from yours. To modify this to your own custom API,
-> change the `config_custom_doc` call with your own parameters.
+> We used a data model that will be different from yours.
+> To modify this to your own custom API, change the `add_endpoint` call with your own parameters.
 
 ```ruby
 require 'mindee'
 
 # Init a new client and configure your custom document
-mindee_client = Mindee::Client.new(
-  api_key: 'my-api-key', # optional, can be set in environment
-).config_custom_doc(
-  'wsnine',
+mindee_client = Mindee::Client.new(api_key: 'my-api-key').add_endpoint(
   'john',
+  'wnine',
   version: '1.1' # optional, if not set, use the latest version of the model
 )
 
 # Load a file from disk and parse it
-w9_data = mindee_client.doc_from_path('/path/to/file.pdf').parse('wsnine')
+result = mindee_client.doc_from_path('/path/to/file.ext')
+  .parse(Mindee::Prediction::CustomV1, endpoint_name: 'wnine')
 
-# Print a brief summary of the parsed data
-puts w9_data.document.to_s
+# Print a summary of the document prediction in RST format
+puts result
 ```
 
 If the `version` argument is set, you'll be required to update it every time a new model is trained.
@@ -39,7 +37,8 @@ The client calls the `parse` method when parsing your custom document, which wil
 The document type must be specified when calling the parse method.
 
 ```ruby
-result = mindee_client.doc_from_path('/path/to/custom_file').parse('wsnine')
+result = mindee_client.doc_from_path('/path/to/custom_file')
+  .parse(Mindee::Prediction::CustomV1, endpoint_name: 'wnine')
 puts result
 ```
 
@@ -49,13 +48,13 @@ puts result
 > you **must** specify your account name when calling the `parse` method:
 
 ```ruby
-mindee_client = Mindee::Client.new.config_custom_doc(
+mindee_client = Mindee::Client.new.add_endpoint(
   'receipt',
   'john'
 )
 
 result = mindee_client.doc_from_path('/path/to/receipt.jpg')
-  .parse('receipt', username: 'john')
+  .parse(Mindee::Prediction::CustomV1, account_name: 'john')
 ```
 
 ## Document Fields
@@ -64,64 +63,58 @@ All the fields defined in the API builder when creating your custom document are
 In custom documents, each field will hold an array of all the words in the document which are related to that field.
 Each word is an object that has the text content, geometry information, and confidence score.
 
-Value fields can be accessed either via the `fields` attribute, or as their own attributes set at run-time.
+Value fields can be accessed via the `fields` attribute.
 
-Classification fields can be accessed either via the `classifications` attribute, or as their own attributes set at run-time.
+Classification fields can be accessed via the `classifications` attribute.
 
 > 📘 **Info**
 >
 > Both document level and page level objects work in the same way.
 
-### Run-time Attributes
-Individual field values can be accessed simply by using the field's API name, in the examples below we'll use the `address` field.
+### Fields Attribute
+The `fields` attribute is a hashmap with the following structure:
+
+* key: the API name of the field, as a `symbol`
+* value: a `ListField` object which has a `values` attribute, containing a list of all values found for the field.
+
+Individual field values can be accessed by using the field's API name, in the examples below we'll use the `address` field.
 
 ```ruby
 # raw data, list of each word object
-puts w9_data.document.address.values
+pp result.inference.prediction.fields[:address].values
 
 # list of all values
-puts w9_data.document.address.contents_list
+puts result.inference.prediction.fields[:address].contents_list
 
 # default string representation
-puts w9_data.document.address.to_s
+puts result.inference.prediction.fields[:address].to_s
 
 # custom string representation
-puts w9_data.document.address.contents_str(separator: '_')
+puts result.inference.prediction.fields[:address].contents_str(separator: '_')
 ```
 
-### Fields property
-In addition to accessing a value field directly, it's possible to access it through the `fields` attribute.
-It's a hashmap with the following structure:
-* key: the API name of the field, as a `symbol`
-* value: a `ListField` object which has a `values` attribute, containing a list of all values found for the field.
-
-```ruby
-# raw data, list of each word object
-puts w9_data.document.fields[:address].values
-```
-
-This makes it simple to iterate over all the fields:
+To iterate over all the fields:
 ```ruby
-w9_data.document.fields.each do |name, info|
+result.inference.prediction.fields.each do |name, info|
   puts name
   puts info.values
 end
 ```
 
-### Classifications property
-In addition to accessing a classification field directly, it's possible to access it through the `classifications` attribute.
-It's a hashmap with the following structure:
+### Classifications Attribute
+The `classifications` attribute is a hashmap with the following structure:
+
 * key: the API name of the field, as a `symbol`
 * value: a `ClassificationField` object which has a `value` attribute, containing a string representation of the detected classification.
 
 ```ruby
 # raw data, list of each word object
-puts w9_data.document.classifications[:doc_type].value
+puts result.document.classifications[:doc_type].value
 ```
 
-This makes it simple to iterate over all the fields:
+To iterate over all the classifications:
 ```ruby
-w9_data.document.classifications.each do |name, info|
+result.document.classifications.each do |name, info|
   puts name
   puts info.value
 end

data/docs/ruby-getting-started.md

@@ -45,7 +45,7 @@ cd mindee-api-ruby
 bundle install
 ```
 
-## Updating the Library
+### Updating the Library
 It is important to always check the version of the Mindee OCR SDK you are using, as new and updated
 features won’t work on older versions.
 
@@ -64,7 +64,7 @@ gem install mindee@<version>
 ## Usage
 Using Mindee's APIs can be broken down into the following steps:
 
-1. [Initialize a `Client`](#initializing-the-client)
+1. [Initialize a Client](#initializing-the-client)
 2. [Load a File](#loading-a-document-file)
 3. [Send the File](#sending-a-file) to Mindee's API
 4. [Process the Result](#process-the-result) in some way

data/docs/ruby-invoice-ocr.md

@@ -19,7 +19,7 @@ puts result.inference.prediction
 ```
 
 Output:
-```shell
+```
 :Locale: en; en; CAD;
 :Document type: INVOICE
 :Invoice number: 14
@@ -48,8 +48,10 @@ Code                   QTY      Price     Amount     Tax (Rate)         Descript
 ====================== ======== ========= ========== ================== ====================================
 ```
 
-**Note:** Line item descriptions are truncated here only for display purposes.
-The full text is available in the [details](#line-items).
+> 📘 **Info**
+>
+> Line item descriptions are truncated here only for display purposes.
+> The full text is available in the [details](#line-items).
 
 ## Fields
 Each prediction object contains a set of different fields.
@@ -91,11 +93,12 @@ puts result.inference.prediction.customer_name.value
 puts result.inference.prediction.customer_address.value
 ```
 
-**`customer_company_registration`** (Array<CompanyRegistration>): Customer's company registration
+**`customer_company_registrations`** (Array<CompanyRegistration>): Customer's company registration
 
 ```ruby
 result.inference.prediction.customer_company_registrations.each do |registration|
-  puts registration
+  puts registration.value
+  puts registration.type
 end
 ```
 
@@ -184,14 +187,10 @@ Each object in the list contains an extra attribute:
 
 * `type` (String): Type of company registration number among predefined categories.
 ```ruby
-# Show the type of the first registration
-puts result.inference.prediction.supplier_company_registrations[0].type
-```
-
-* `value` (String): Value of the company identifier
-```ruby
-# Show the value of the first registration
-puts result.inference.prediction.supplier_company_registrations[0].value
+result.inference.prediction.supplier_company_registrations.each do |registration|
+  puts registration.value
+  puts registration.type
+end
 ```
 
 ### Taxes

data/docs/ruby-passport-ocr.md

@@ -19,7 +19,7 @@ puts result.inference.prediction
 ```
 
 Output:
-```shell
+```
 :Full name: HENERT PUDARSAN
 :Given names: HENERT
 :Surname: PUDARSAN

data/docs/ruby-receipt-ocr.md

@@ -19,7 +19,7 @@ puts result.inference.prediction
 ```
 
 Output:
-```shell
+```
 :Locale: en-US; en; US; USD;
 :Date: 2014-07-07
 :Category: food