mindee 5.4.0 → 5.5.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-21 00:00:00.000000000 Z
+date: 2026-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.71'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
@@ -180,10 +194,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".git-hooks/pre_commit/gitleaks.rb"
 - ".gitattributes"
 - ".gitignore"
 - ".gitmodules"
-- ".pre-commit-config.yaml"
+- ".overcommit.yml"
 - ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -201,6 +216,7 @@ files:
 - bin/v1/products.rb
 - bin/v2/parser.rb
 - bin/v2/products.rb
+- bin/v2/search_commands.rb
 - docs/code_samples/bank_account_details_v1.txt
 - docs/code_samples/bank_account_details_v2.txt
 - docs/code_samples/bank_statement_fr_v2_async.txt
@@ -257,7 +273,6 @@ files:
 - lib/mindee/image/image_extractor.rb
 - lib/mindee/image/image_utils.rb
 - lib/mindee/input.rb
-- lib/mindee/input/base_parameters.rb
 - lib/mindee/input/local_response.rb
 - lib/mindee/input/polling_options.rb
 - lib/mindee/input/sources.rb
@@ -400,6 +415,9 @@ files:
 - lib/mindee/v1/product/universal/universal_prediction.rb
 - lib/mindee/v2.rb
 - lib/mindee/v2/client.rb
+- lib/mindee/v2/client_options.rb
+- lib/mindee/v2/client_options/base_product_parameters.rb
+- lib/mindee/v2/client_options/base_search_parameters.rb
 - lib/mindee/v2/file_operations.rb
 - lib/mindee/v2/file_operations/crop.rb
 - lib/mindee/v2/file_operations/split.rb
@@ -433,10 +451,13 @@ files:
 - lib/mindee/v2/parsing/raw_text.rb
 - lib/mindee/v2/parsing/raw_text_page.rb
 - lib/mindee/v2/parsing/search.rb
+- lib/mindee/v2/parsing/search/base_search_response.rb
 - lib/mindee/v2/parsing/search/model_webhook.rb
 - lib/mindee/v2/parsing/search/pagination_metadata.rb
 - lib/mindee/v2/parsing/search/search_model.rb
 - lib/mindee/v2/parsing/search/search_models.rb
+- lib/mindee/v2/parsing/search/search_rag_document.rb
+- lib/mindee/v2/parsing/search/search_rag_documents.rb
 - lib/mindee/v2/parsing/search/search_response.rb
 - lib/mindee/v2/product.rb
 - lib/mindee/v2/product/base_product.rb
@@ -473,6 +494,11 @@ files:
 - lib/mindee/v2/product/split/split_range.rb
 - lib/mindee/v2/product/split/split_response.rb
 - lib/mindee/v2/product/split/split_result.rb
+- lib/mindee/v2/search.rb
+- lib/mindee/v2/search/models/model_search_parameters.rb
+- lib/mindee/v2/search/models/model_search_response.rb
+- lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb
+- lib/mindee/v2/search/rag_documents/rag_document_search_response.rb
 - lib/mindee/version.rb
 - mindee-lite.gemspec
 - mindee.gemspec
@@ -500,7 +526,6 @@ files:
 - sig/mindee/image/image_compressor.rbs
 - sig/mindee/image/image_extractor.rbs
 - sig/mindee/image/image_utils.rbs
-- sig/mindee/input/base_parameters.rbs
 - sig/mindee/input/local_response.rbs
 - sig/mindee/input/polling_options.rbs
 - sig/mindee/input/sources/base64_input_source.rbs
@@ -627,6 +652,8 @@ files:
 - sig/mindee/v1/product/universal/universal_page.rbs
 - sig/mindee/v1/product/universal/universal_prediction.rbs
 - sig/mindee/v2/client.rbs
+- sig/mindee/v2/client_options/base_product_parameters.rbs
+- sig/mindee/v2/client_options/base_search_parameters.rbs
 - sig/mindee/v2/file_operation/crop.rbs
 - sig/mindee/v2/file_operation/split.rbs
 - sig/mindee/v2/http/api_v2_settings.rbs
@@ -654,10 +681,13 @@ files:
 - sig/mindee/v2/parsing/rag_metadata.rbs
 - sig/mindee/v2/parsing/raw_text.rbs
 - sig/mindee/v2/parsing/raw_text_page.rbs
+- sig/mindee/v2/parsing/search/base_search_response.rbs
 - sig/mindee/v2/parsing/search/model_webhook.rbs
 - sig/mindee/v2/parsing/search/pagination_metadata.rbs
 - sig/mindee/v2/parsing/search/search_model.rbs
 - sig/mindee/v2/parsing/search/search_models.rbs
+- sig/mindee/v2/parsing/search/search_rag_document.rbs
+- sig/mindee/v2/parsing/search/search_rag_documents.rbs
 - sig/mindee/v2/parsing/search/search_response.rbs
 - sig/mindee/v2/parsing/search_models.rbs
 - sig/mindee/v2/product/base_product.rbs
@@ -694,6 +724,10 @@ files:
 - sig/mindee/v2/product/split/split_range.rbs
 - sig/mindee/v2/product/split/split_response.rbs
 - sig/mindee/v2/product/split/split_result.rbs
+- sig/mindee/v2/search/models/model_search_parameters.rbs
+- sig/mindee/v2/search/models/model_search_response.rbs
+- sig/mindee/v2/search/rag_documents/rag_document_search_parameters.rbs
+- sig/mindee/v2/search/rag_documents/rag_document_search_response.rbs
 - sig/mindee/version.rbs
 homepage: https://github.com/mindee/mindee-api-ruby
 licenses:

data/.pre-commit-config.yaml

@@ -1,36 +0,0 @@
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v6.0.0
-    hooks:
-      - id: check-merge-conflict
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-      - id: check-added-large-files
-        args: ["--maxkb=1024"]
-
-  - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.30.0
-    hooks:
-      - id: gitleaks
-        exclude: ^(spec/data/|docs/code_samples/|local_test/)
-
-  - repo: local
-    hooks:
-      - id: rubocop
-        name: RuboCop
-        entry: bundle exec rubocop --force-exclusion --no-server
-        language: system
-        pass_filenames: false
-      - id: steep
-        name: Steep
-        entry: bundle exec steep check
-        language: system
-        pass_filenames: false
-        stages: [pre-commit, pre-push]
-      - id: bundle-audit
-        name: Bundle Audit
-        entry: bundle exec bundle-audit check
-        language: system
-        pass_filenames: false
-        stages: [pre-commit, pre-push]

data/lib/mindee/input/base_parameters.rb

@@ -1,156 +0,0 @@
-# frozen_string_literal: true
-
-module Mindee
-  module Input
-    # Base class for parameters accepted by all V2 endpoints.
-    class BaseParameters
-      # @return [String] ID of the model (required).
-      attr_reader :model_id
-
-      # @return [String, nil] Optional alias for the file.
-      attr_reader :file_alias
-
-      # @return [Array<String>, nil] Optional list of Webhooks IDs to propagate the API response to.
-      attr_reader :webhook_ids
-
-      # @return [PollingOptions] Options for polling. Set only if having timeout issues.
-      attr_reader :polling_options
-
-      # @return [Boolean, nil] Whether to close the file after parsing.
-      attr_reader :close_file
-
-      # @param [String] model_id ID of the model
-      # @param [String, nil] file_alias File alias, if applicable.
-      # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
-      # @param [Hash, PollingOptions, nil] polling_options Options for polling. Set only if having timeout issues.
-      # @param [Boolean, nil] close_file Whether to close the file after parsing.
-      def initialize(
-        model_id,
-        file_alias: nil,
-        webhook_ids: nil,
-        polling_options: nil,
-        close_file: true
-      )
-        raise Error::MindeeInputError, 'Model ID is required.' if model_id.empty? || model_id.nil?
-
-        @model_id = model_id
-        @file_alias = file_alias
-        @webhook_ids = webhook_ids || []
-        @polling_options = get_clean_polling_options(polling_options)
-        @close_file = close_file.nil? || close_file
-      end
-
-      # Sets polling options after normalizing hash inputs.
-      # @param [Hash, PollingOptions, nil] polling_options
-      # @return [PollingOptions]
-      def polling_options=(polling_options)
-        @polling_options = get_clean_polling_options(polling_options)
-      end
-
-      # @return [String] Slug for the endpoint.
-      def self.slug
-        if self == BaseParameters
-          raise NotImplementedError, 'Cannot access `slug` directly on the BaseParameters class.'
-        end
-
-        ''
-      end
-
-      # @return [String] Slug for the endpoint.
-      def slug
-        self.class.slug
-      end
-
-      # Load from a hash
-      # @param [Hash] params Parameters to provide as a hash.
-      # @return [BaseParameters]
-      def self.from_hash(params: {})
-        load_from_hash(params: params)
-        new(
-          params[:model_id],
-          file_alias: params[:file_alias],
-          webhook_ids: params[:webhook_ids],
-          polling_options: params[:polling_options],
-          close_file: params[:close_file]
-        )
-      end
-
-      # Loads a prediction from a Hash.
-      # @param [Hash] params Parameters to provide as a hash.
-      # @return [Hash]
-      def self.load_from_hash(params: {})
-        params.transform_keys!(&:to_sym)
-
-        if params.empty? || params[:model_id].nil? || params[:model_id].empty?
-          raise Error::MindeeInputError, 'Model ID is required.'
-        end
-
-        polling_options_input = params.fetch(:page_options, PollingOptions.new)
-        if polling_options_input.is_a?(Hash)
-          polling_options_input = polling_options_input.transform_keys(&:to_sym)
-          PollingOptions.new(
-            initial_delay_sec: polling_options_input.fetch(:initial_delay_sec, 2.0),
-            delay_sec: polling_options_input.fetch(:delay_sec, 1.5),
-            max_retries: polling_options_input.fetch(:max_retries, 80)
-          )
-        end
-        params
-      end
-
-      # Appends base form data to the provided array.
-      # @param [Array] form_data Array of form fields
-      # @return [Array]
-      def append_form_data(form_data)
-        form_data.push(['alias', @file_alias]) if @file_alias
-        webhook_ids = @webhook_ids || []
-        form_data.push(['webhook_ids', webhook_ids.join(',')]) unless @webhook_ids.nil? || webhook_ids.empty?
-        form_data
-      end
-
-      # Validates the parameters for async auto-polling
-      def validate_async_params
-        min_delay_sec = 1
-        min_initial_delay_sec = 1
-        min_retries = 2
-
-        if @polling_options.delay_sec < min_delay_sec
-          raise ArgumentError,
-                "Cannot set auto-poll delay to less than #{min_delay_sec} second(s)"
-        end
-        if @polling_options.initial_delay_sec < min_initial_delay_sec
-          raise ArgumentError,
-                "Cannot set initial parsing delay to less than #{min_initial_delay_sec} second(s)"
-        end
-        return unless @polling_options.max_retries < min_retries
-
-        raise ArgumentError,
-              "Cannot set auto-poll retries to less than #{min_retries}"
-      end
-
-      private
-
-      # Cleans a proper polling options object potentially from a hash.
-      # @param [Hash, PollingOptions, nil] polling_options Polling options.
-      # @return [PollingOptions] Valid polling options object.
-      def get_clean_polling_options(polling_options)
-        return PollingOptions.new if polling_options.is_a?(PollingOptions)
-
-        if polling_options.is_a?(Hash)
-          polling_options = polling_options.transform_keys(&:to_sym)
-          output_polling_options = PollingOptions.new(
-            initial_delay_sec: polling_options.fetch(:initial_delay_sec, 2.0),
-            delay_sec: polling_options.fetch(:delay_sec, 1.5),
-            max_retries: polling_options.fetch(:max_retries, 80)
-          )
-        else
-          output_polling_options = if polling_options.is_a?(PollingOptions)
-                                     polling_options || PollingOptions.new
-                                   else
-                                     PollingOptions.new
-                                   end
-        end
-        output_polling_options
-      end
-    end
-  end
-end

data/sig/mindee/input/base_parameters.rbs

@@ -1,36 +0,0 @@
-# lib/mindee/input/base_parameters.rb
-
-module Mindee
-  module Input
-    class BaseParameters
-      attr_reader self.slug: String
-
-      def self.from_hash: (params: Hash[String | Symbol, untyped]) -> BaseParameters
-      def self.load_from_hash: (params: Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
-
-      def slug: -> String
-
-      attr_reader model_id: String
-      attr_reader file_alias: String?
-      attr_reader webhook_ids: Array[String]?
-      attr_reader polling_options: PollingOptions
-      attr_reader close_file: bool
-
-      def initialize: (
-          String,
-          ?file_alias: String?,
-          ?webhook_ids: Array[String]?,
-          ?polling_options: Hash[Symbol | String, untyped] | PollingOptions | nil,
-          ?close_file: bool?
-        ) -> void
-
-      def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
-      def validate_async_params: () -> void
-      def polling_options=: (Hash[Symbol | String, untyped] | PollingOptions | nil) -> PollingOptions
-
-      private
-
-      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions | nil) -> PollingOptions
-    end
-  end
-end