mindee 3.20.0 → 4.0.0

data/docs/{resume_v1.md → global_products/resume_v1.md}

@@ -1,16 +1,42 @@
 ---
-title: Resume OCR Ruby
+title: Ruby Client Library - Resume
 category: 622b805aaec68102ea7fcbc2
 slug: ruby-resume-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports the [Resume API](https://platform.mindee.com/mindee/resume).
-
-Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/resume/default_sample.jpg), we are going to illustrate how to extract the data that we want using the OCR SDK.
+The Ruby Client Library supports the [Resume API](https://platform.mindee.com/mindee/resume).
+
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                            |
+> | ------------------------------ | -------------------------------------------------- |
+> | Endpoint Name                  | `resume`                                           |
+> | Recommended Version            | `v1.2`                                             |
+> | Supports Polling/Webhooks      | ✔️ Yes                                             |
+> | Support Synchronous HTTP Calls | ❌ No                                              |
+> | Geography                      | 🌐 Global                                          |
+
+> 🔐 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    |
+
+
+Using the [sample below](https://github.com/mindee/client-lib-test-data/blob/main/products/resume/default_sample.jpg),
+we are going to illustrate how to extract the data that we want using the Ruby Client Library.
 ![Resume sample](https://github.com/mindee/client-lib-test-data/blob/main/products/resume/default_sample.jpg?raw=true)
 
 # Quick-Start
 ```rb
+#
+# Install the Ruby client library by running:
+# gem install mindee
+#
+
 require 'mindee'
 
 # Init a new client
@@ -20,7 +46,7 @@ mindee_client = Mindee::Client.new(api_key: 'my-api-key')
 input_source = mindee_client.source_from_path('/path/to/the/file.ext')
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
   Mindee::Product::Resume::ResumeV1
 )
@@ -30,7 +56,6 @@ puts result.document
 
 # Print the document-level parsed data
 # puts result.document.inference.prediction
-
 ```
 
 **Output (RST):**
@@ -114,19 +139,20 @@ These fields are generic and used in several products.
 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.
+* **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** (`Boolean`): indicates whether an object was reconstructed (not extracted as the API gave it).
+* **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.
 
 
 ### Classification Field
-The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements **value**, **confidence** and **page_id**.
+The classification field `ClassificationField` does not implement all the basic `Field` attributes. It only implements
+**value**, **confidence** and **page_id**.
 
 > Note: a classification field's `value is always a `String`.
 
@@ -136,29 +162,13 @@ The text field `StringField` only has one constraint: it's **value** is a `Strin
 ## Specific Fields
 Fields which are specific to this product; they are not used in any other product.
 
-### Certificates Field
-The list of certificates obtained by the candidate.
-
-A `ResumeV1Certificate` implements the following attributes:
-
-* `grade` (String): The grade obtained for the certificate.
-* `name` (String): The name of certification.
-* `provider` (String): The organization or institution that issued the certificate.
-* `year` (String): The year when a certificate was issued or received.
-Fields which are specific to this product; they are not used in any other product.
-
-### Education Field
-The list of the candidate's educational background.
+### Social Networks Field
+The list of social network profiles of the candidate.
 
-A `ResumeV1Education` implements the following attributes:
+A `ResumeV1SocialNetworksUrl` implements the following attributes:
 
-* `degree_domain` (String): The area of study or specialization.
-* `degree_type` (String): The type of degree obtained, such as Bachelor's, Master's, or Doctorate.
-* `end_month` (String): The month when the education program or course was completed.
-* `end_year` (String): The year when the education program or course was completed.
-* `school` (String): The name of the school.
-* `start_month` (String): The month when the education program or course began.
-* `start_year` (String): The year when the education program or course began.
+* `name` (String): The name of the social network.
+* `url` (String): The URL of the social network.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Languages Field
@@ -175,7 +185,21 @@ A `ResumeV1Language` implements the following attributes:
  - Proficient
  - Intermediate
  - Beginner
+        
+Fields which are specific to this product; they are not used in any other product.
+
+### Education Field
+The list of the candidate's educational background.
+
+A `ResumeV1Education` implements the following attributes:
 
+* `degree_domain` (String): The area of study or specialization.
+* `degree_type` (String): The type of degree obtained, such as Bachelor's, Master's, or Doctorate.
+* `end_month` (String): The month when the education program or course was completed.
+* `end_year` (String): The year when the education program or course was completed.
+* `school` (String): The name of the school.
+* `start_month` (String): The month when the education program or course began.
+* `start_year` (String): The year when the education program or course began.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Professional Experiences Field
@@ -190,7 +214,7 @@ A `ResumeV1ProfessionalExperience` implements the following attributes:
  - Part-Time
  - Internship
  - Freelance
-
+        
 * `department` (String): The specific department or division within the company.
 * `description` (String): The description of the professional experience as written in the document.
 * `employer` (String): The name of the company or organization.
@@ -201,13 +225,15 @@ A `ResumeV1ProfessionalExperience` implements the following attributes:
 * `start_year` (String): The year when the professional experience began.
 Fields which are specific to this product; they are not used in any other product.
 
-### Social Networks Field
-The list of social network profiles of the candidate.
+### Certificates Field
+The list of certificates obtained by the candidate.
 
-A `ResumeV1SocialNetworksUrl` implements the following attributes:
+A `ResumeV1Certificate` implements the following attributes:
 
-* `name` (String): The name of the social network.
-* `url` (String): The URL of the social network.
+* `grade` (String): The grade obtained for the certificate.
+* `name` (String): The name of certification.
+* `provider` (String): The organization or institution that issued the certificate.
+* `year` (String): The year when a certificate was issued or received.
 
 # Attributes
 The following fields are extracted for Resume V1:
@@ -223,7 +249,7 @@ puts result.document.inference.prediction.address.value
 **certificates** (Array<[ResumeV1Certificate](#certificates-field)>): The list of certificates obtained by the candidate.
 
 ```rb
-for certificates_elem in result.document.inference.prediction.certificates do
+result.document.inference.prediction.certificates do |certificates_elem|
   puts certificates_elem.value
 end
 ```
@@ -251,7 +277,7 @@ puts result.document.inference.prediction.document_type.value
 **education** (Array<[ResumeV1Education](#education-field)>): The list of the candidate's educational background.
 
 ```rb
-for education_elem in result.document.inference.prediction.education do
+result.document.inference.prediction.education do |education_elem|
   puts education_elem.value
 end
 ```
@@ -267,7 +293,7 @@ puts result.document.inference.prediction.email_address.value
 **given_names** (Array<[StringField](#string-field)>): The candidate's first or given names.
 
 ```rb
-for given_names_elem in result.document.inference.prediction.given_names do
+result.document.inference.prediction.given_names do |given_names_elem|
   puts given_names_elem.value
 end
 ```
@@ -276,7 +302,7 @@ end
 **hard_skills** (Array<[StringField](#string-field)>): The list of the candidate's technical abilities and knowledge.
 
 ```rb
-for hard_skills_elem in result.document.inference.prediction.hard_skills do
+result.document.inference.prediction.hard_skills do |hard_skills_elem|
   puts hard_skills_elem.value
 end
 ```
@@ -292,7 +318,7 @@ puts result.document.inference.prediction.job_applied.value
 **languages** (Array<[ResumeV1Language](#languages-field)>): The list of languages that the candidate is proficient in.
 
 ```rb
-for languages_elem in result.document.inference.prediction.languages do
+result.document.inference.prediction.languages do |languages_elem|
   puts languages_elem.value
 end
 ```
@@ -322,7 +348,7 @@ puts result.document.inference.prediction.profession.value
 **professional_experiences** (Array<[ResumeV1ProfessionalExperience](#professional-experiences-field)>): The list of the candidate's professional experiences.
 
 ```rb
-for professional_experiences_elem in result.document.inference.prediction.professional_experiences do
+result.document.inference.prediction.professional_experiences do |professional_experiences_elem|
   puts professional_experiences_elem.value
 end
 ```
@@ -331,7 +357,7 @@ end
 **social_networks_urls** (Array<[ResumeV1SocialNetworksUrl](#social-networks-field)>): The list of social network profiles of the candidate.
 
 ```rb
-for social_networks_urls_elem in result.document.inference.prediction.social_networks_urls do
+result.document.inference.prediction.social_networks_urls do |social_networks_urls_elem|
   puts social_networks_urls_elem.value
 end
 ```
@@ -340,7 +366,7 @@ end
 **soft_skills** (Array<[StringField](#string-field)>): The list of the candidate's interpersonal and communication abilities.
 
 ```rb
-for soft_skills_elem in result.document.inference.prediction.soft_skills do
+result.document.inference.prediction.soft_skills do |soft_skills_elem|
   puts soft_skills_elem.value
 end
 ```
@@ -349,7 +375,7 @@ end
 **surnames** (Array<[StringField](#string-field)>): The candidate's last names.
 
 ```rb
-for surnames_elem in result.document.inference.prediction.surnames do
+result.document.inference.prediction.surnames do |surnames_elem|
   puts surnames_elem.value
 end
 ```

data/docs/{generated_v1.md → global_products/universal.md}

@@ -1,15 +1,34 @@
 ---
-title: Generated API Ruby
+title: Universal API Ruby
 category: 622b805aaec68102ea7fcbc2
-slug: ruby-generated-ocr
-parentDoc: 6294d97ee723f1008d2ab28e
+slug: ruby-universal-ocr
+parentDoc: 67b49df15b843f3fa9cd622b
 ---
-The Ruby OCR SDK supports generated APIs.
-Generated APIs can theoretically support all APIs in a catch-all generic format.
+The Ruby Client Library implements a universal wrapper class for all products.
+
+> 📝 Product Specs
+>
+> | Specification                  | Details                                                         |
+> | ------------------------------ |-----------------------------------------------------------------|
+> | Endpoint Name                  | `<name_of_the_endpoint>`                                        |
+> | Recommended Version            | `v<version_of_the_endpoint>` Defaults to 1 for custom products. |
+> | Supports Polling/Webhooks      | ❓️ Variable                                                     |
+> | Support Synchronous HTTP Calls | ❓ Variable                                                      |
+> | Geography                      | ❓ Variable                                                     |
+
+> 🔐 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 `Universal` product supports all products in a catch-all generic format, and can be used in the following manner:
 
 # Quick-Start
 
-```ruby
+```rb
 require 'mindee'
 
 # Init a new client
@@ -26,32 +45,33 @@ custom_endpoint = mindee_client.create_endpoint(
 )
 
 # Parse the file
-result = mindee_client.enqueue_and_parse(
+result = mindee_client.parse(
   input_source,
-  Mindee::Product::Generated::GeneratedV1,
+  Mindee::Product::Universal::Universal,
   endpoint: custom_endpoint
+  # Note: On compatible APIs, you can run this HTTP call synchronously by setting `enqueue: false`
 )
 
 # Print a full summary of the parsed data in RST format
 puts result.document
 ```
 
-# Generated Endpoints
+# Universal 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.
+You may have noticed in the previous step that in order to access a universal 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
 
-## Generated Fields
+## Universal Fields
 
-### Generated List Field
+### Universal List Field
 
-A `GeneratedListField` is a special type of custom list that implements the following:
+A `UniversalListField` is a special type of custom list that implements the following:
 
-- **values** (`Array<StringField`[GeneratedObjectField](#Generated-object-field)`>`): the confidence score of the field prediction.
+- **values** (`Array<StringField`[UniversalObjectField](#universal-object-field)`>`): the confidence score of the field prediction.
 - **page_id** (`Integer`): only available for some documents ATM.
 
 Since the inner contents can vary, the value isn't accessed through a property, but rather through the following functions:
@@ -60,9 +80,9 @@ Since the inner contents can vary, the value isn't accessed through a property,
 - **contents_string(separator=" ")** (`-> String`): returns a list of concatenated values, with an optional **separator** `String` between them.
 > **Note:** the `to_s` method returns a string representation of all values of this object, with an empty space between each of them.
 
-### Generated Object Field
+### Universal Object Field
 
-Unrecognized structures and sometimes values of `ListField`s are stored in a `GeneratedObjectField` structure, which is implemented dynamically depending on the object's structure.
+Unrecognized structures and sometimes values of `ListField`s are stored in a `UniversalObjectField` structure, which is implemented dynamically depending on the object's structure.
 
 - **page_id** (`[Integer, nil]`): the ID of the page, is `nil` when at document-level.
 - **raw_value** (`[String, nil]`): an optional field for when some post-processing has been done on fields (e.g. amounts). `nil` in most instances.
@@ -78,13 +98,13 @@ The text field `StringField` only has one constraint: its **value** is an `Optio
 
 # Attributes
 
-Generated builds always have access to at least two attributes:
+Universal builds always have access to at least two attributes:
 
 ## Fields
 
-**fields** (`Hash<String, Array<`[GeneratedListField](#generated-list-field),[GeneratedObjectField](#generated-object-field), `(#stringfield)[StringField]>>`):
+**fields** (`Hash<String, Array<`[UniversalListField](#universal-list-field),[UniversalObjectField](#universal-object-field), `(#stringfield)[StringField]>>`):
 
-```ruby
+```rb
 puts result.document.inference.prediction.fields["my-field"].to_s
 ```
 

data/docs/global_products.md

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