♻️ update options and raw text to latest response format. (#202)

Author: ianardee

lib/mindee/parsing/v2.rb

@@ -8,8 +8,9 @@
 require_relative 'v2/inference_model'
 require_relative 'v2/inference_response'
 require_relative 'v2/inference_result'
-require_relative 'v2/inference_result_options'
+require_relative 'v2/inference_active_options'
 require_relative 'v2/job'
 require_relative 'v2/job_response'
 require_relative 'v2/job_webhook'
 require_relative 'v2/raw_text'
+require_relative 'v2/raw_text_page'

lib/mindee/parsing/v2/inference.rb

@@ -3,27 +3,31 @@
 require_relative 'inference_model'
 require_relative 'inference_file'
 require_relative 'inference_result'
+require_relative 'inference_active_options'
 
 module Mindee
   module Parsing
     module V2
       # Complete data returned by an inference request.
       class Inference
+        # @return [String] Identifier of the inference (when provided by API).
+        attr_reader :id
         # @return [InferenceModel] Information about the model used.
         attr_reader :model
         # @return [InferenceFile] Information about the processed file.
         attr_reader :file
+        # @return [InferenceActiveOptions] Options which were activated during the inference.
+        attr_reader :active_options
         # @return [InferenceResult] Result contents.
         attr_reader :result
-        # @return [String] Identifier of the inference (when provided by API).
-        attr_reader :id
 
         # @param server_response [Hash] Hash representation of the JSON returned by the service.
         def initialize(server_response)
           raise ArgumentError, 'server_response must be a Hash' unless server_response.is_a?(Hash)
 
           @model  = InferenceModel.new(server_response['model'])
           @file   = InferenceFile.new(server_response['file'])
+          @active_options = InferenceActiveOptions.new(server_response['active_options'])
           @result = InferenceResult.new(server_response['result'])
 
           @id = server_response['id']
@@ -35,11 +39,9 @@ def to_s
           [
             'Inference',
             '#########',
-            'Model',
-            '=====',
-            ":ID: #{@model.id}",
-            '',
+            @model.to_s,
             @file.to_s,
+            @active_options.to_s,
             @result.to_s,
             '',
           ].join("\n")

lib/mindee/parsing/v2/inference_active_options.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mindee
+  module Parsing
+    module V2
+      # Options which were activated during the inference.
+      class InferenceActiveOptions
+        # @return [Boolean] Whether the Raw Text feature was activated.
+        attr_reader :raw_text
+        # @return [Boolean] Whether the polygon feature was activated.
+        attr_reader :polygon
+        # @return [Boolean] Whether the confidence feature was activated.
+        attr_reader :confidence
+        # @return [Boolean] Whether the Retrieval-Augmented Generation feature was activated.
+        attr_reader :rag
+
+        # @param server_response [Hash] Raw JSON parsed into a Hash.
+        def initialize(server_response)
+          @raw_text = server_response['raw_text']
+          @polygon = server_response['polygon']
+          @confidence = server_response['confidence']
+          @rag = server_response['rag']
+        end
+
+        # String representation.
+        # @return [String]
+        def to_s
+          parts = [
+            'Active Options',
+            '==============',
+            ":Raw Text: #{@raw_text ? 'True' : 'False'}",
+            ":Polygon: #{@polygon ? 'True' : 'False'}",
+            ":Confidence: #{@confidence ? 'True' : 'False'}",
+            ":RAG: #{@rag ? 'True' : 'False'}",
+            '',
+          ]
+          parts.join("\n")
+        end
+      end
+    end
+  end
+end

lib/mindee/parsing/v2/inference_model.rb

@@ -12,6 +12,18 @@ class InferenceModel
         def initialize(server_response)
           @id = server_response['id']
         end
+
+        # String representation.
+        # @return [String]
+        def to_s
+          parts = [
+            'Model',
+            '=====',
+            ":ID: #{@id}",
+            '',
+          ]
+          parts.join("\n")
+        end
       end
     end
   end

lib/mindee/parsing/v2/inference_result.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'field/inference_fields'
-require_relative 'inference_result_options'
+require_relative 'raw_text'
 
 module Mindee
   module Parsing
@@ -10,18 +10,16 @@ module V2
       class InferenceResult
         # @return [Mindee::Parsing::V2::Field::InferenceFields] Fields produced by the model.
         attr_reader :fields
-        # @return [Mindee::Parsing::V2::InferenceResultOptions, nil] Optional extra data.
-        attr_reader :options
+        # @return [Mindee::Parsing::V2::RawText, nil] Optional extra data.
+        attr_reader :raw_text
 
         # @param server_response [Hash] Hash version of the JSON returned by the API.
         def initialize(server_response)
           raise ArgumentError, 'server_response must be a Hash' unless server_response.is_a?(Hash)
 
           @fields = Field::InferenceFields.new(server_response['fields'])
 
-          return unless server_response.key?('options') && server_response['options']
-
-          @options = InferenceResultOptions.new(server_response['options'])
+          @raw_text = server_response['raw_text'] ? RawText.new(server_response['raw_text']) : nil
         end
 
         # String representation.
@@ -32,15 +30,6 @@ def to_s
             '======',
             @fields.to_s,
           ]
-
-          if @options
-            parts += [
-              'Options',
-              '=======',
-              @options.to_s,
-            ]
-          end
-
           parts.join("\n")
         end
       end

lib/mindee/parsing/v2/inference_result_options.rb

@@ -3,17 +3,17 @@
 module Mindee
   module Parsing
     module V2
-      # Raw text extracted from a given page.
+      # Raw text extracted from all pages in the document.
       class RawText
-        # @return [Integer] Page number where the text was found.
-        attr_reader :page
-        # @return [String] Text content.
-        attr_reader :content
+        # @return [Array[Mindee::Parsing::V2::RawTextPage]] List of pages with their extracted text content.
+        attr_reader :pages
 
         # @param server_response [Hash] Raw JSON parsed into a Hash.
         def initialize(server_response)
-          @page = server_response['page']
-          @content = server_response['content']
+          @pages = []
+          server_response.fetch('pages', []).each do |page|
+            @pages.push RawTextPage.new(page)
+          end
         end
       end
     end

lib/mindee/parsing/v2/raw_text.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mindee
+  module Parsing
+    module V2
+      # Raw text extracted from a single page.
+      class RawTextPage
+        # @return [Boolean] Text content of the page as a single string. '\n' is used to separate lines.
+        attr_reader :content
+
+        # @param server_response [Hash] Raw JSON parsed into a Hash.
+        def initialize(server_response)
+          @content = server_response['content']
+        end
+      end
+    end
+  end
+end

lib/mindee/parsing/v2/raw_text_page.rb

@@ -3,9 +3,10 @@ module Mindee
   module Parsing
     module V2
       class Inference
-        attr_reader file: InferenceFile
         attr_reader id: String
         attr_reader model: InferenceModel
+        attr_reader file: InferenceFile
+        attr_reader active_options: InferenceActiveOptions
         attr_reader result: InferenceResult
 
         def initialize: (Hash[String | Symbol, untyped]) -> void

sig/mindee/parsing/v2/inference.rbs

@@ -0,0 +1,14 @@
+module Mindee
+  module Parsing
+    module V2
+      class InferenceActiveOptions
+        attr_reader confidence: bool
+        attr_reader polygon: bool
+        attr_reader rag: bool
+        attr_reader raw_text: bool
+
+        def initialize: (Hash[String | Symbol, untyped]) -> void
+      end
+    end
+  end
+end