mindee 4.10.1 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0acff570cd3c1b3528696ce80e37acd582cd1ca6947ec1683c74c1896af9fb9
-  data.tar.gz: 88cc394a27c17e14bf7b5c348a3db59117e1e1508f89429e5f2b6c090155175c
+  metadata.gz: 4ec6f37e83f30ed06cca64a016ea4936211726fe0e4e6281f6e9eec42f32bfdc
+  data.tar.gz: 780f641de505dcb64842c73b2597d389894522f38c345d92c2b28fd52db61749
 SHA512:
-  metadata.gz: c961bb98da8ef3bd701810eae1ec1a98a9fb7111142e4d40eee1add7bc959d55d66076e287e7c050aa594ee5fb900594c6bf24010a85564d0e38282c76aa6a93
-  data.tar.gz: a4b802f0a7c8312baa55eef7635063eb395f5251420770468e0e59f8ba3cae57a0ffd6ac63eff9e6a3fdc2d24acf577d8dbf990f9b71c22386d8bc326093e011
+  metadata.gz: f0909570d17dfcc54d8d95671ec323c733a98be640bd71c837708759a623d16896133998f2e5af67aa845420f92ef7c6c875d9890c6e8e9dbe97db0069529f73
+  data.tar.gz: '0975d445b49f5e22805baec50eebbaf2e8127fd85ab22fe5970167eeb3d31217be2db50ddc6a56155580d70f5fbce888f4b491d58343d7fc3fea806ed5de0d33'

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Mindee Ruby API Library Changelog
 
+## v4.12.0 - 2026-02-25
+### Changes
+* :sparkles: add job information to inference
+* :sparkles: add more inference info
+
+
+## v4.11.0 - 2026-02-11
+### Changes
+* :sparkles: add complementary accessors for ObjectField
+
+
 ## v4.10.1 - 2026-02-05
 ### Fixes
 * :bug: fix NoMethodError in JobWebhook when error is nil (#222) (Co-authored-by: haris_delalic <haris.delalic@datamolino.com>)

data/lib/mindee/parsing/v2/field/object_field.rb

@@ -85,6 +85,49 @@ module Mindee
           def get_simple_field(key)
             @fields.get_simple_field(key)
           end
+
+          # Get a field by key and ensure it is a ListField.
+          # @param key [String] Field key to retrieve.
+          # @return [ListField] The ListField.
+          # @raise [TypeError] If the field is not a ListField.
+          def get_list_field(key)
+            field = @fields.get_list_field(key)
+            raise TypeError, "Field #{key} is not a ListField" unless field.is_a?(ListField)
+
+            field
+          end
+
+          # Get a field by key and ensure it is an ObjectField.
+          # @param key [String] Field key to retrieve.
+          # @return [ObjectField] The ObjectField.
+          # @raise [TypeError] If the field is not an ObjectField.
+          def get_object_field(key)
+            field = @fields.get_object_field(key)
+            raise TypeError, "Field #{key} is not an ObjectField" unless field.is_a?(ObjectField)
+
+            field
+          end
+
+          # Get all simple fields.
+          # @return [Hash<String, SimpleField>] Simple fields contained in the object.
+          def simple_fields
+            # @type var fields: Hash<String, SimpleField>
+            @fields.select { |_, value| value.is_a?(SimpleField) }
+          end
+
+          # Get all list fields.
+          # @return [Hash<String, ListField>] List fields contained in the object.
+          def list_fields
+            # @type var fields: Hash<String, ListField>
+            @fields.select { |_, value| value.is_a?(ListField) }
+          end
+
+          # Get all object fields.
+          # @return [Hash<String, ObjectField>] Object fields contained in the object.
+          def object_fields
+            # @type var fields: Hash<String, ObjectField>
+            @fields.select { |_, value| value.is_a?(ObjectField) }
+          end
         end
       end
     end

data/lib/mindee/parsing/v2/inference.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'inference_job'
 require_relative 'inference_model'
 require_relative 'inference_file'
 require_relative 'inference_result'
@@ -12,6 +13,8 @@ module Mindee
       class Inference
         # @return [String] Identifier of the inference (when provided by API).
         attr_reader :id
+        # @return [InferenceJob] Metadata about the job.
+        attr_reader :job
         # @return [InferenceModel] Information about the model used.
         attr_reader :model
         # @return [InferenceFile] Information about the processed file.
@@ -26,6 +29,7 @@ module Mindee
           raise ArgumentError, 'server_response must be a Hash' unless server_response.is_a?(Hash)
 
           @model  = InferenceModel.new(server_response['model'])
+          @job    = InferenceJob.new(server_response['job']) if server_response.key?('job')
           @file   = InferenceFile.new(server_response['file'])
           @active_options = InferenceActiveOptions.new(server_response['active_options'])
           @result = InferenceResult.new(server_response['result'])
@@ -39,6 +43,7 @@ module Mindee
           [
             'Inference',
             '#########',
+            @job.to_s,
             @model.to_s,
             @file.to_s,
             @active_options.to_s,

data/lib/mindee/parsing/v2/inference_job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'common_response'
+require_relative 'job'
+
+module Mindee
+  module Parsing
+    module V2
+      # HTTP response wrapper that embeds a V2 job.
+      class InferenceJob
+        # @return [String] UUID of the Job.
+        attr_reader :id
+
+        def initialize(server_response)
+          @id = server_response['id']
+        end
+
+        # @return [String] String representation of the job.
+        def to_s
+          "Job\n===\n:ID: #{@id}\n"
+        end
+      end
+    end
+  end
+end

data/lib/mindee/parsing/v2/job.rb

@@ -11,8 +11,10 @@ module Mindee
       class Job
         # @return [String] Unique job identifier.
         attr_reader :id
-        # @return [DateTime, nil] Timestamp of creation.
+        # @return [Time] Date and time of the Job creation.
         attr_reader :created_at
+        # @return [Time, nil] Date and time of the Job completion. Filled once processing is finished.
+        attr_reader :completed_at
         # @return [String] Identifier of the model used.
         attr_reader :model_id
         # @return [String] Name of the processed file.
@@ -30,6 +32,7 @@ module Mindee
         # @return [ErrorResponse, nil] Error details when the job failed.
         attr_reader :error
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         # @param server_response [Hash] Parsed JSON payload from the API.
         def initialize(server_response)
           raise ArgumentError, 'server_response must be a Hash' unless server_response.is_a?(Hash)
@@ -39,7 +42,10 @@ module Mindee
           unless server_response['error'].nil? || server_response['error'].empty?
             @error = ErrorResponse.new(server_response['error'])
           end
-          @created_at  = Time.iso8601(server_response['created_at'])
+          @created_at = Time.iso8601(server_response['created_at'])
+          if server_response.key?('completed_at') && !server_response['completed_at'].nil?
+            @completed_at = Time.iso8601(server_response['completed_at'])
+          end
           @model_id    = server_response['model_id']
           @polling_url = server_response['polling_url']
           @filename    = server_response['filename']
@@ -50,6 +56,7 @@ module Mindee
             @webhooks.push JobWebhook.new(webhook)
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         # String representation.
         # @return [String]

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '4.10.1'
+  VERSION = '4.12.0'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[String | Symbol, Regexp], Nil?]

data/sig/mindee/parsing/v2/field/object_field.rbs

@@ -1,5 +1,4 @@
-# TypeProf 0.30.1
-
+# lib/mindee/parsing/v2/field/object_field.rb
 module Mindee
   module Parsing
     module V2
@@ -8,7 +7,15 @@ module Mindee
         class ObjectField < BaseField
           attr_reader fields: InferenceFields
           def initialize: (Hash[String | Symbol, untyped], ?Integer) -> void
+
           def get_simple_field: (String) -> SimpleField
+          def get_list_field: (String) -> ListField
+          def get_object_field: (String) -> ObjectField
+
+          def simple_fields: () -> Hash[String, SimpleField]
+          def list_fields: () -> Hash[String, ListField]
+          def object_fields: () -> Hash[String, ObjectField]
+
           def multi_str: -> String
           def single_str: -> String
           def to_s: -> String

data/sig/mindee/parsing/v2/inference.rbs

@@ -3,7 +3,9 @@ module Mindee
   module Parsing
     module V2
       class Inference
+
         attr_reader id: String
+        attr_reader job: InferenceJob
         attr_reader model: InferenceModel
         attr_reader file: InferenceFile
         attr_reader active_options: InferenceActiveOptions

data/sig/mindee/parsing/v2/inference_job.rbs

@@ -0,0 +1,12 @@
+module Mindee
+  module Parsing
+    module V2
+      class InferenceJob
+        attr_reader id: String
+
+        def initialize: (Hash[String | Symbol, untyped]) -> void
+        def to_s: -> String
+      end
+    end
+  end
+end

data/sig/mindee/parsing/v2/job.rbs

@@ -4,7 +4,8 @@ module Mindee
     module V2
       class Job
         attr_reader alias: String
-        attr_reader created_at: DateTime?
+        attr_reader created_at: Time
+        attr_reader completed_at: Time?
         attr_reader error: ErrorResponse?
         attr_reader filename: String
         attr_reader id: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 4.10.1
+  version: 4.12.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-05 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -363,6 +363,7 @@ files:
 - lib/mindee/parsing/v2/inference.rb
 - lib/mindee/parsing/v2/inference_active_options.rb
 - lib/mindee/parsing/v2/inference_file.rb
+- lib/mindee/parsing/v2/inference_job.rb
 - lib/mindee/parsing/v2/inference_model.rb
 - lib/mindee/parsing/v2/inference_response.rb
 - lib/mindee/parsing/v2/inference_result.rb
@@ -635,6 +636,7 @@ files:
 - sig/mindee/parsing/v2/inference.rbs
 - sig/mindee/parsing/v2/inference_active_options.rbs
 - sig/mindee/parsing/v2/inference_file.rbs
+- sig/mindee/parsing/v2/inference_job.rbs
 - sig/mindee/parsing/v2/inference_model.rbs
 - sig/mindee/parsing/v2/inference_response.rbs
 - sig/mindee/parsing/v2/inference_result.rbs