mindee 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bbe7fd9450d6e87f07b3b96c636ef8715200370503eb97d65db46225b6ccf8e
-  data.tar.gz: 36b67f8ca703982d40048e4d7e9a3b20e4204c7a36386028b3bd11da79560a20
+  metadata.gz: b3307b74c76a019147939c9d201adcf2d4b2557a9b773475f6b92407ee18f9bf
+  data.tar.gz: 4d5f9204fc983bf1e108d1feb04bb3abded3f2d4dad62eba86d714a608af4d48
 SHA512:
-  metadata.gz: '08dd6e3e40ea73f874647ab537f2539342aca107bb1d324c04fa8b8de1fa803f5893117bcaf0e840dd6210b55e6e7c163897bb6cba6a36389b44daeab6a886e2'
-  data.tar.gz: 6028ec9f0d38e9e7840c33c98a517d8db02aef34058b8ae517c560cdc0b88524a0e2ab4a472dfe4e1f12ef027fce5bd2153cebd628e2c66f29ac3c8733c1cec3
+  metadata.gz: 8e712d0f2cdf6926c50513c0bd499beca98de1774067d637a0aeb915071b18d5004ba214d07f6ebb861eb8ac76e56ad5c13e960f209363bcd6ff31459cfdcacb
+  data.tar.gz: f9b117e1087b5b89cc3d957fb150c243b2409a0fb40483df6f4279761a4cf1384905c375a973cb3d3c9d95ca7abdca49d6cc8613738ae5ae6a5374464b26e00f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Ruby API Library Changelog
 
+## v4.9.0 - 2025-12-02
+### Changes
+* :sparkles: add support for text_context parameter
+
+
 ## v4.8.0 - 2025-11-18
 ### Changes
 * :sparkles: add support for better errors

data/lib/mindee/http/mindee_api_v2.rb

@@ -111,8 +111,25 @@ module Mindee
         poll("#{@settings.base_url}/inferences/#{queue_id}")
       end
 
+      # Handle parameters for the enqueue form
+      # @param form_data [Array] Array of form fields
+      # @param params [Input::InferenceParameters] Inference options.
+      def enqueue_form_options(form_data, params)
+        # deal with optional features
+        form_data.push(['rag', params.rag.to_s]) unless params.rag.nil?
+        form_data.push(['raw_text', params.raw_text.to_s]) unless params.raw_text.nil?
+        form_data.push(['polygon', params.polygon.to_s]) unless params.polygon.nil?
+        form_data.push(['confidence', params.confidence.to_s]) unless params.confidence.nil?
+        form_data.push ['file_alias', params.file_alias] if params.file_alias
+        form_data.push ['text_context', params.text_context] if params.text_context
+        unless params.webhook_ids.nil? || params.webhook_ids.empty?
+          form_data.push ['webhook_ids', params.webhook_ids.join(',')]
+        end
+        form_data
+      end
+
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
-      # @param params [Input::InferenceParameters] Parse options.
+      # @param params [Input::InferenceParameters] Inference options.
       # @return [Net::HTTPResponse, nil]
       def enqueue(input_source, params)
         uri = URI("#{@settings.base_url}/inferences/enqueue")
@@ -125,16 +142,9 @@ module Mindee
                     end
         form_data.push(['model_id', params.model_id])
 
-        # deal with optional features
-        form_data.push(['rag', params.rag.to_s]) unless params.rag.nil?
-        form_data.push(['raw_text', params.raw_text.to_s]) unless params.raw_text.nil?
-        form_data.push(['polygon', params.polygon.to_s]) unless params.polygon.nil?
-        form_data.push(['confidence', params.confidence.to_s]) unless params.confidence.nil?
+        # deal with other parameters
+        form_data = enqueue_form_options(form_data, params)
 
-        form_data.push ['file_alias', params.file_alias] if params.file_alias
-        unless params.webhook_ids.nil? || params.webhook_ids.empty?
-          form_data.push ['webhook_ids', params.webhook_ids.join(',')]
-        end
         headers = {
           'Authorization' => @settings.api_key,
           'User-Agent' => @settings.user_agent,

data/lib/mindee/input/inference_parameters.rb

@@ -25,6 +25,10 @@ module Mindee
       # @return [String, nil] Optional alias for the file.
       attr_reader :file_alias
 
+      # @return [String, nil] Additional text context used by the model during inference.
+      #   Not recommended, for specific use only.
+      attr_reader :text_context
+
       # @return [Array<String>, nil] Optional list of Webhooks IDs to propagate the API response to.
       attr_reader :webhook_ids
 
@@ -52,6 +56,7 @@ module Mindee
         confidence: nil,
         file_alias: nil,
         webhook_ids: nil,
+        text_context: nil,
         polling_options: nil,
         close_file: true
       )
@@ -64,6 +69,7 @@ module Mindee
         @confidence = confidence
         @file_alias = file_alias
         @webhook_ids = webhook_ids || []
+        @text_context = text_context
         @polling_options = get_clean_polling_options(polling_options)
         @close_file = close_file.nil? || close_file
         # rubocop:enable Metrics/ParameterLists

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

@@ -13,6 +13,8 @@ module Mindee
         attr_reader :confidence
         # @return [Boolean] Whether the Retrieval-Augmented Generation feature was activated.
         attr_reader :rag
+        # @return [Boolean] Whether the text context feature was activated.
+        attr_reader :text_context
 
         # @param server_response [Hash] Raw JSON parsed into a Hash.
         def initialize(server_response)
@@ -20,6 +22,7 @@ module Mindee
           @polygon = server_response['polygon']
           @confidence = server_response['confidence']
           @rag = server_response['rag']
+          @text_context = server_response['text_context']
         end
 
         # String representation.

data/lib/mindee/version.rb

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

data/sig/mindee/http/mindee_api_v2.rbs

@@ -13,6 +13,10 @@ module Mindee
       def inference_job_req_get: (String) -> Net::HTTPResponse
       def inference_result_req_get: (String) -> Net::HTTPResponse
       def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::InferenceParameters) -> Net::HTTPResponse?
+
+      private
+
+      def enqueue_form_options: (Array[untyped], Input::InferenceParameters) -> Array[untyped]
     end
   end
 end

data/sig/mindee/input/inference_parameters.rbs

@@ -10,6 +10,7 @@ module Mindee
       attr_reader polygon: bool?
       attr_reader rag: bool?
       attr_reader raw_text: bool?
+      attr_reader text_context: String?
       attr_reader webhook_ids: Array[String]?
 
       def initialize: (
@@ -19,6 +20,7 @@ module Mindee
           ?polygon: bool?,
           ?confidence: bool?,
           ?file_alias: String?,
+          ?text_context: String?,
           ?webhook_ids: Array[String]?,
           ?polling_options: Hash[Symbol | String, untyped] | PollingOptions?,
           ?close_file: bool?

data/sig/mindee/input/local_response.rbs

@@ -3,7 +3,7 @@ module Mindee
   module Input
     class LocalResponse
       def file: -> StringIO
-      def initialize: (File | IO | StringIO | String | Pathname) -> void
+      def initialize: (File | IO | StringIO | String | Pathname | Tempfile) -> void
       def as_hash: -> Hash[String | Symbol, untyped]
       def self.process_secret_key: (String) -> String
       def get_hmac_signature: (String) -> String

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

@@ -6,6 +6,7 @@ module Mindee
         attr_reader polygon: bool
         attr_reader rag: bool
         attr_reader raw_text: bool
+        attr_reader text_context: bool
 
         def initialize: (Hash[String | Symbol, untyped]) -> void
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-18 00:00:00.000000000 Z
+date: 2025-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64