mindee 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cdb0922b8ea540511c91a760d0b9d76dd5ba87f5e85b88b6008511077fe852b
-  data.tar.gz: 01a40229234d445a1838d71e945e7eacff7c8afdba2da09bb20fbf14670b21da
+  metadata.gz: d4d5ce164f9e839b743150857ad81fabdcaa4e9659c67ad96a21ecebae30fbf9
+  data.tar.gz: b15a4ebd4162152b8a931bcea424a33f42ea77a04d8f1857da888b5bdff02739
 SHA512:
-  metadata.gz: cfecb4fc1da99567aa086e2af214544b294e6be7525984fab2775ff19877116203b0739bd1d8b9c66ef23205dbe8dcd277e89a149884cffd8bd10e133d3f8e46
-  data.tar.gz: f5f389e634f5c8ec8637b9d3a051f44248500f7553bad550da0dc0f3d8e49a2f68c2d0251868f89b37f2d465efce92b55a4bdd65422f64a36cedf8e3e0932667
+  metadata.gz: 71252859a8e99d7da7d6eae65020cb0b5652224c00ff9c0b251f971017c95534bb1268f03e9c1612cc22a0ec4c47d6751017de8730fc49155750bc19c00ee42d
+  data.tar.gz: 383864204ffd86207eeb97d0bc48d8d88be9e3112cf68f06c47641ff509d314c4cc1ec2fd6237c9686ec44a87fd4a60b381e20810ef3ec6a3130bf118ca25068

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # Mindee Ruby API Library Changelog
 
-## v1.0.0 (2022-07-28)
+## v1.1.0 - 2022-08-04
+### Changes
+* :sparkles: Add support for custom API classification field (#5)
+
+## v1.0.0 - 2022-07-28
 * :tada: First release!

data/lib/mindee/documents/custom.rb

@@ -6,9 +6,12 @@ require_relative 'base'
 module Mindee
   # Custom document object.
   class CustomDocument < Document
-    # All fields in the document
+    # All value fields in the document
     # @return [Hash<Symbol, Mindee::ListField>]
     attr_reader :fields
+    # All classifications in the document
+    # @return [Hash<Symbol, Mindee::ClassificationField>]
+    attr_reader :classifications
 
     # @param document_type [String]
     # @param prediction [Hash]
@@ -17,12 +20,10 @@ module Mindee
     def initialize(document_type, prediction, input_file: nil, page_id: nil)
       super(document_type, input_file: input_file)
       @fields = {}
+      @classifications = {}
       prediction.each do |field_name, field_prediction|
         field_sym = field_name.to_sym
-        complete_field = ListField.new(field_prediction, page_id)
-
-        # Add the field to the `fields` array
-        @fields[field_sym] = complete_field
+        complete_field = set_field(field_sym, field_prediction, page_id)
 
         # Create a dynamic accessor function for the field
         singleton_class.module_eval { attr_accessor field_sym }
@@ -34,11 +35,31 @@ module Mindee
       out_str = String.new
       out_str << "----- #{@document_type} -----"
       out_str << "\nFilename: #{@filename}".rstrip
+      @classifications.each do |name, info|
+        out_str << "\n#{name}: #{info}".rstrip
+      end
       @fields.each do |name, info|
         out_str << "\n#{name}: #{info}".rstrip
       end
       out_str << "\n----------------------"
       out_str
     end
+
+    private
+
+    # @param field_prediction [Hash]
+    def set_field(field_sym, field_prediction, page_id)
+      # Currently two types of fields possible in a custom API response:
+      # fields having a list of values, and classification fields.
+      # Here we use the fact that only value lists have the 'values' attribute.
+
+      if field_prediction.key? 'values'
+        @fields[field_sym] = ListField.new(field_prediction, page_id)
+      elsif field_prediction.key? 'value'
+        @classifications[field_sym] = ClassificationField.new(field_prediction)
+      else
+        throw 'Unknown API field type'
+      end
+    end
   end
 end

data/lib/mindee/fields/{list_field.rb → custom_docs.rb}

@@ -1,6 +1,19 @@
 # frozen_string_literal: true
 
 module Mindee
+  # Document classification (custom docs)
+  class ClassificationField
+    # @param prediction [Hash]
+    def initialize(prediction)
+      @value = prediction['value']
+      @confidence = prediction['confidence']
+    end
+
+    def to_s
+      @value
+    end
+  end
+
   # Field in a list.
   class ListFieldItem
     # The confidence score, value will be between 0.0 and 1.0

data/lib/mindee/fields.rb

@@ -8,4 +8,4 @@ require_relative 'fields/locale'
 require_relative 'fields/orientation'
 require_relative 'fields/payment_details'
 require_relative 'fields/tax'
-require_relative 'fields/list_field'
+require_relative 'fields/custom_docs'

data/lib/mindee/version.rb

@@ -2,7 +2,7 @@
 
 # Mindee
 module Mindee
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   def self.find_platform
     host = RbConfig::CONFIG['host_os']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mindee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -87,8 +87,8 @@ files:
 - lib/mindee/fields/amount.rb
 - lib/mindee/fields/base.rb
 - lib/mindee/fields/company_registration.rb
+- lib/mindee/fields/custom_docs.rb
 - lib/mindee/fields/datefield.rb
-- lib/mindee/fields/list_field.rb
 - lib/mindee/fields/locale.rb
 - lib/mindee/fields/orientation.rb
 - lib/mindee/fields/payment_details.rb