mindee-lite 5.3.1 → 5.5.0

data/lib/mindee/v2/product/classification/params/classification_parameters.rb

@@ -7,7 +7,7 @@ module Mindee
         # Classification parameters.
         module Params
           # Parameters accepted by the classification utility v2 endpoint.
-          class ClassificationParameters < Mindee::Input::BaseParameters
+          class ClassificationParameters < Mindee::V2::ClientOptions::BaseProductParameters
             # @return [String] Slug for the endpoint.
             def self.slug
               'classification'

data/lib/mindee/v2/product/crop/crop_item.rb

@@ -16,11 +16,10 @@ module Mindee
           def initialize(server_response)
             @object_type = server_response['object_type']
             @location = Mindee::V2::Parsing::Field::FieldLocation.new(server_response['location'])
-            # rubocop:disable Style/GuardClause
+            # rubocop:disable-next Style/GuardClause
             unless server_response['extraction_response'].nil?
               @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
             end
-            # rubocop:enable Style/GuardClause
           end
 
           # String representation.

data/lib/mindee/v2/product/crop/params/crop_parameters.rb

@@ -7,7 +7,7 @@ module Mindee
         # Crop parameters.
         module Params
           # Parameters accepted by the crop utility v2 endpoint.
-          class CropParameters < Mindee::Input::BaseParameters
+          class CropParameters < Mindee::V2::ClientOptions::BaseProductParameters
             # @return [String] Slug for the endpoint.
             def self.slug
               'crop'

data/lib/mindee/v2/product/extraction/params/extraction_parameters.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../../../input/base_parameters'
+require_relative '../../../client_options/base_product_parameters'
 require_relative 'data_schema'
 
 module Mindee
@@ -9,7 +9,7 @@ module Mindee
       module Extraction
         module Params
           # Parameters accepted by the extraction v2 endpoint.
-          class ExtractionParameters < Mindee::Input::BaseParameters
+          class ExtractionParameters < Mindee::V2::ClientOptions::BaseProductParameters
             # @return [Boolean, nil] Enhance extraction accuracy with Retrieval-Augmented Generation.
             attr_reader :rag
 

data/lib/mindee/v2/product/ocr/params/ocr_parameters.rb

@@ -7,7 +7,7 @@ module Mindee
         # OCR Parameters.
         module Params
           # Parameters accepted by the ocr utility v2 endpoint.
-          class OCRParameters < Mindee::Input::BaseParameters
+          class OCRParameters < Mindee::V2::ClientOptions::BaseProductParameters
             # @return [String] Slug for the endpoint.
             def self.slug
               'ocr'

data/lib/mindee/v2/product/split/params/split_parameters.rb

@@ -8,7 +8,7 @@ module Mindee
         # Split parameters.
         module Params
           # Parameters accepted by the split utility v2 endpoint.
-          class SplitParameters < Mindee::Input::BaseParameters
+          class SplitParameters < Mindee::V2::ClientOptions::BaseProductParameters
             # @return [String] Slug for the endpoint.
             def self.slug
               'split'

data/lib/mindee/v2/product/split/split_range.rb

@@ -17,11 +17,10 @@ module Mindee
           def initialize(server_response)
             @page_range = server_response['page_range']
             @document_type = server_response['document_type']
-            # rubocop:disable Style/GuardClause
+            # rubocop:disable-next Style/GuardClause
             unless server_response['extraction_response'].nil?
               @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
             end
-            # rubocop:enable Style/GuardClause
           end
 
           # String representation.

data/lib/mindee/v2/search/models/model_search_parameters.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Search
+      module Models
+        # Search parameters for models.
+        class ModelSearchParameters < Mindee::V2::ClientOptions::BaseSearchParameters
+          # @return [String, nil] Case-insensitive search term for the model name.
+          attr_reader :name
+
+          # @return [String, nil] Case-insensitive search term for the model type.
+          attr_reader :model_type
+
+          # @param name [String, nil] Case-insensitive search term for the model name.
+          # @param model_type [String, nil] Case-insensitive search term for the model type.
+          # @param page [Integer, nil] 1-based page index.
+          # @param per_page [Integer, nil] Number of items per page.
+          def initialize(name: nil, model_type: nil, page: nil, per_page: nil)
+            super(page: page, per_page: per_page)
+            @name = name
+            @model_type = model_type
+          end
+
+          # @return [String] Slug of searchable resources.
+          def self.slug
+            'models'
+          end
+
+          # @return [Class<Mindee::V2::Search::Models::ModelSearchResponse>] Response class for the search.
+          def self.response_class
+            ModelSearchResponse
+          end
+
+          # Gets the request parameters for the search request.
+          # @return [Hash{String => String, Array<String>}]
+          def request_parameters
+            params = super
+
+            name = @name
+            model_type = @model_type
+            params['name'] = name unless name.nil?
+            params['model_type'] = model_type unless model_type.nil?
+
+            params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/search/models/model_search_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Search
+      module Models
+        # Models search response.
+        class ModelSearchResponse < Mindee::V2::Parsing::Search::BaseSearchResponse
+          # @return [Mindee::V2::Parsing::Search::SearchModels] Paginated list of matching models.
+          attr_reader :models
+
+          # @param raw_response [Hash] The parsed JSON payload from the API.
+          def initialize(raw_response)
+            super
+
+            @models = Mindee::V2::Parsing::Search::SearchModels.new(raw_response['models'])
+          end
+
+          # Lines composing the response-specific body (header + items).
+          # @return [Array<String>]
+          def body_lines
+            ['Models', '######', @models.to_s]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/search/rag_documents/rag_document_search_parameters.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Search
+      module RAGDocuments
+        # Search parameters for RAG Documents.
+        class RAGDocumentSearchParameters < Mindee::V2::ClientOptions::BaseSearchParameters
+          # @return [String] Model identifier to search in.
+          attr_reader :model_id
+
+          # @return [String, nil] Case-insensitive substring search on filename.
+          attr_reader :filename
+
+          # @param model_id [String] Model identifier to search in.
+          # @param filename [String, nil] Case-insensitive substring search on filename.
+          # @param page [Integer, nil] 1-based page index.
+          # @param per_page [Integer, nil] Number of items per page.
+          def initialize(model_id:, filename: nil, page: nil, per_page: nil)
+            super(page: page, per_page: per_page)
+            raise Error::MindeeInputError, 'Model ID is required.' if model_id.nil? || model_id.empty?
+
+            @model_id = model_id
+            @filename = filename
+          end
+
+          # @return [String] Slug of searchable resources.
+          def self.slug
+            'rag-documents'
+          end
+
+          # @return [Class<Mindee::V2::Search::RAGDocuments::RAGDocumentSearchResponse>] Response class for the search.
+          def self.response_class
+            RAGDocumentSearchResponse
+          end
+
+          # Gets the request parameters for the search request.
+          # @return [Hash{String => String, Array<String>}]
+          def request_parameters
+            params = super
+
+            params['model_id'] = @model_id
+            filename = @filename
+            params['filename'] = filename unless filename.nil?
+
+            params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/search/rag_documents/rag_document_search_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Search
+      module RAGDocuments
+        # RAG Documents search response.
+        class RAGDocumentSearchResponse < Mindee::V2::Parsing::Search::BaseSearchResponse
+          # @return [Mindee::V2::Parsing::Search::SearchRAGDocuments] Paginated list of matching RAG documents.
+          attr_reader :rag_documents
+
+          # @param raw_response [Hash] The parsed JSON payload from the API.
+          def initialize(raw_response)
+            super
+
+            @rag_documents = Mindee::V2::Parsing::Search::SearchRAGDocuments.new(raw_response['rag_documents'])
+          end
+
+          # Lines composing the response-specific body (header + items).
+          # @return [Array<String>]
+          def body_lines
+            ['RAG Documents', '#############', @rag_documents.to_s]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/search.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'search/models/model_search_response'
+require_relative 'search/models/model_search_parameters'
+require_relative 'search/rag_documents/rag_document_search_response'
+require_relative 'search/rag_documents/rag_document_search_parameters'

data/lib/mindee/v2.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require_relative 'v2/client_options'
 require_relative 'v2/client'
 require_relative 'v2/http'
 require_relative 'v2/file_operations' if Mindee::Dependencies.all_deps_available?
 require_relative 'v2/parsing'
+require_relative 'v2/search'
 require_relative 'v2/product'

data/lib/mindee/version.rb

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

data/mindee.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'pdf-reader', '~> 2.15'
 
   spec.add_development_dependency 'bundle-audit', '~> 0.2.0'
+  spec.add_development_dependency 'overcommit', '~> 0.71'
   spec.add_development_dependency 'rbs', '~> 3.10'
   spec.add_development_dependency 'rubocop', '~> 1.86'
   spec.add_development_dependency 'steep', '~> 1.10'

data/sig/custom/net_http.rbs

@@ -6,7 +6,7 @@ module Net
   class BufferedIO
   end
   class HTTP
-    def self.start: [T] (String?, Integer?, use_ssl: bool?, ?read_timeout: Integer) { (HTTP) -> T } -> T
+    def self.start: [T] (String?, Integer?, use_ssl: bool?, ?open_timeout: Integer, ?read_timeout: Integer) { (HTTP) -> T } -> T
 
     def request: (untyped) -> untyped
 

data/sig/mindee/http/cancellation_token.rbs

@@ -0,0 +1,15 @@
+# lib/http/cancellation_token.rb
+
+module Mindee
+  module HTTP
+    class CancellationToken
+      @is_cancelled: bool
+
+      attr_reader is_canceled: bool
+
+      def canceled?: -> bool
+      def initialize: -> void
+      def cancel: -> void
+    end
+  end
+end

data/sig/mindee/v2/client.rbs

@@ -15,15 +15,18 @@ module Mindee
 
       def get_job: (String job_id) -> V2::Parsing::JobResponse
 
-      def enqueue: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> V2::Parsing::JobResponse
+      def enqueue: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | ClientOptions::BaseProductParameters params) -> V2::Parsing::JobResponse
 
-      def enqueue_and_get_result: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> T
+      def enqueue_and_get_result: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | ClientOptions::BaseProductParameters params, ?Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> T
 
-      def search_models: (String?, String?) -> Mindee::V2::Parsing::Search::SearchResponse
+      def search: [T] (HTTP::_SearchParameters[T] params) -> T
+
+      # Deprecated: use `search` instead.
+      def search_models: (String?, String?) -> Mindee::V2::Search::Models::ModelSearchResponse
 
       def validate_async_params: (Integer | Float, Integer | Float, Integer) -> void
 
-      def normalize_parameters: (singleton(Input::BaseParameters) param_class, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?polling_options: Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> Input::BaseParameters
+      def normalize_parameters: (singleton(ClientOptions::BaseProductParameters) param_class, Hash[String | Symbol, untyped] | ClientOptions::BaseProductParameters params, ?polling_options: Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> ClientOptions::BaseProductParameters
     end
   end
 end

data/sig/mindee/v2/client_options/base_product_parameters.rbs

@@ -0,0 +1,41 @@
+# lib/mindee/v2/client_options/base_product_parameters.rb
+
+module Mindee
+  module V2
+    module ClientOptions
+      class BaseProductParameters
+        attr_reader self.slug: String
+
+        def self.from_hash: (params: Hash[String | Symbol, untyped]) -> BaseProductParameters
+
+        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: Input::PollingOptions
+        attr_reader close_file: bool
+
+        def initialize: (
+            String,
+            ?file_alias: String?,
+            ?webhook_ids: Array[String]?,
+            ?polling_options: Hash[Symbol | String, untyped] | Input::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] | Input::PollingOptions | nil) -> Input::PollingOptions
+
+        private
+
+        def get_clean_polling_options: (Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> Input::PollingOptions
+      end
+    end
+  end
+end

data/sig/mindee/v2/client_options/base_search_parameters.rbs

@@ -0,0 +1,19 @@
+module Mindee
+  module V2
+    module ClientOptions
+      class BaseSearchParameters
+        attr_reader page: Integer?
+        attr_reader per_page: Integer?
+
+        def initialize: (?page: Integer?, ?per_page: Integer?) -> void
+
+        def request_parameters: -> Hash[String, String | Array[String]]
+
+        def slug: -> String
+        def self.slug: -> String
+        def response_class: -> singleton(V2::Parsing::Search::BaseSearchResponse)
+        def self.response_class: -> singleton(V2::Parsing::Search::BaseSearchResponse)
+      end
+    end
+  end
+end

data/sig/mindee/v2/http/mindee_api_v2.rbs

@@ -11,7 +11,15 @@ module Mindee
 
         def response_type: () -> _ResponseFactory[T]
 
-        def params_type: () -> singleton(Input::BaseParameters)
+        def params_type: () -> singleton(ClientOptions::BaseProductParameters)
+      end
+
+      interface _SearchParameters[T]
+        def slug: () -> String
+
+        def response_class: () -> _ResponseFactory[T]
+
+        def request_parameters: () -> Hash[String, String | Array[String]]
       end
 
       class MindeeApiV2
@@ -21,7 +29,7 @@ module Mindee
 
         def req_get_result: [T] (_ProductClass[T] product, String resource) -> T
 
-        def req_post_enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::BaseParameters) -> V2::Parsing::JobResponse
+        def req_post_product_enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ClientOptions::BaseProductParameters) -> V2::Parsing::JobResponse
 
         def req_get_job: (String) -> V2::Parsing::JobResponse
 
@@ -31,9 +39,9 @@ module Mindee
 
         def result_req_get: [T] (String, _ProductClass[T] product) -> Net::HTTPResponse
 
-        def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::BaseParameters) -> Net::HTTPResponse?
+        def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ClientOptions::BaseProductParameters) -> Net::HTTPResponse?
 
-        def search_models: (String?, String?) -> Mindee::V2::Parsing::Search::SearchResponse
+        def req_get_search: [T] (_SearchParameters[T] params) -> T
 
         private
 
@@ -43,8 +51,6 @@ module Mindee
 
         def req_get_result_url: [T] (_ResponseFactory[T] result_class, String url) -> T
 
-        def req_get_search_models: (String?, String?) -> Net::HTTPResponse
-
         def uri?: (String) -> bool
       end
     end

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

@@ -20,6 +20,15 @@ module Mindee
           def lteql? : (String | Integer | FieldConfidence) -> bool
           def >=: (String | Integer | FieldConfidence) -> bool
           def gteql?: (String | Integer | FieldConfidence) -> bool
+          def greater_than_or_equal?: (String | Integer | FieldConfidence) -> bool
+          def >: (String | Integer | FieldConfidence) -> bool
+          def gt?: (String | Integer | FieldConfidence) -> bool
+          def greater_than?: (String | Integer | FieldConfidence) -> bool
+          def <: (String | Integer | FieldConfidence) -> bool
+          def lt?: (String | Integer | FieldConfidence) -> bool
+          def less_than?: (String | Integer | FieldConfidence) -> bool
+          def less_than_or_equal?: (String | Integer | FieldConfidence) -> bool
+          def equal?: (String | Integer | FieldConfidence) -> bool
           def inspect: -> String
 
           def val_to_i: (String) -> Integer

data/sig/mindee/v2/parsing/search/base_search_response.rbs

@@ -0,0 +1,19 @@
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        class BaseSearchResponse < CommonResponse
+          attr_reader pagination: PaginationMetadata
+
+          def initialize: (Hash[String|Symbol, untyped]) -> void
+
+          def body_lines: -> Array[String]
+
+          def pagination_metadata: -> PaginationMetadata
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/parsing/search/search_rag_document.rbs

@@ -0,0 +1,23 @@
+# lib/mindee/v2/parsing/search/search_rag_document.rb
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        class SearchRAGDocument
+          attr_reader created_at: Time
+          attr_reader filename: String
+          attr_reader id: String
+          attr_reader last_match_at: Time?
+          attr_reader model_id: String
+          attr_reader status: String
+          attr_reader total_matches: Integer
+
+          def initialize: (Hash[String|Symbol, untyped]) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/parsing/search/search_rag_documents.rbs

@@ -0,0 +1,16 @@
+# lib/mindee/v2/parsing/search/search_rag_documents.rb
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # List of RAG documents.
+        class SearchRAGDocuments < Array[SearchRAGDocument]
+          def initialize: (Array[Hash[String|Symbol, untyped]]) -> void
+
+          def to_s: -> String
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/parsing/search/search_response.rbs

@@ -1,16 +1,11 @@
-# lib/mindee/v2/search/search_response.rb
+# lib/mindee/v2/parsing/search/search_response.rb
+
 module Mindee
   module V2
     module Parsing
       module Search
-        class SearchResponse
-          attr_reader models: Array[SearchResponse]
-          attr_reader pagination: PaginationMetadata
-          attr_reader pagination_metadata: PaginationMetadata
-
-          def initialize: (Hash[String|Symbol, untyped]) -> void
-
-          def to_s: -> String
+        # Deprecated: use `Mindee::V2::Search::Models::ModelSearchResponse` instead.
+        class SearchResponse < V2::Search::Models::ModelSearchResponse
         end
       end
     end

data/sig/mindee/v2/product/base_product.rbs

@@ -3,13 +3,13 @@ module Mindee
     module Product
       class BaseProduct
         self.@slug: String
-        self.@params_type: singleton(Input::BaseParameters)
+        self.@params_type: singleton(ClientOptions::BaseProductParameters)
         self.@response_type: singleton(Parsing::BaseResponse)
 
-        def self._params_type: () -> singleton(Input::BaseParameters)
+        def self._params_type: () -> singleton(ClientOptions::BaseProductParameters)
 
         attr_reader self.slug: String
-        attr_reader self.params_type: singleton(Input::BaseParameters)
+        attr_reader self.params_type: singleton(ClientOptions::BaseProductParameters)
         attr_reader self.response_type: singleton(Parsing::BaseResponse)
 
         def initialize: -> void

data/sig/mindee/v2/product/classification/params/classification_parameters/classification_parameters.rbs

@@ -3,7 +3,7 @@ module Mindee
     module Product
       module Classification
         module Params
-          class ClassificationParameters
+          class ClassificationParameters < ClientOptions::BaseProductParameters
             def self.slug: -> String
 
             def self.from_hash: (params: Hash[String | Symbol, untyped]) -> ClassificationParameters

data/sig/mindee/v2/product/crop/params/crop_parameters/crop_parameters.rbs

@@ -3,7 +3,7 @@ module Mindee
     module Product
       module Crop
         module Params
-          class CropParameters
+          class CropParameters < ClientOptions::BaseProductParameters
             def self.slug: -> String
 
             def self.from_hash: (params: Hash[String | Symbol, untyped]) -> CropParameters

data/sig/mindee/v2/product/extraction/params/extraction_parameters.rbs

@@ -3,7 +3,7 @@ module Mindee
     module Product
       module Extraction
         module Params
-          class ExtractionParameters < Input::BaseParameters
+          class ExtractionParameters < ClientOptions::BaseProductParameters
 
             def self.slug: -> String
 

data/sig/mindee/v2/product/ocr/params/ocr_parameters/ocr_parameters.rbs

@@ -3,7 +3,7 @@ module Mindee
     module Product
       module OCR
         module Params
-          class OCRParameters
+          class OCRParameters < ClientOptions::BaseProductParameters
             def self.slug: -> String
 
             def self.from_hash: (params: Hash[String | Symbol, untyped]) -> OCRParameters

data/sig/mindee/v2/product/split/params/split_parameters/split_parameters.rbs

@@ -3,7 +3,7 @@ module Mindee
     module Product
       module Split
         module Params
-          class SplitParameters
+          class SplitParameters < ClientOptions::BaseProductParameters
             def self.slug: -> String
 
             def self.from_hash: (params: Hash[String | Symbol, untyped]) -> SplitParameters

data/sig/mindee/v2/search/models/model_search_parameters.rbs

@@ -0,0 +1,22 @@
+# lib/mindee/v2/search/models/model_search_parameters.rb
+
+module Mindee
+  module V2
+    module Search
+      module Models
+        class ModelSearchParameters < ClientOptions::BaseSearchParameters
+          attr_reader model_type: String?
+          attr_reader name: String?
+
+          def initialize: (?name: String?, ?model_type: String?, ?page: Integer?, ?per_page: Integer?) -> void
+
+          def self.slug: -> String
+          def self.response_class: -> singleton(ModelSearchResponse)
+          def response_class: -> singleton(ModelSearchResponse)
+
+          def request_parameters: -> Hash[String, String | Array[String]]
+        end
+      end
+    end
+  end
+end