mindee 5.4.0 → 5.6.0

data/lib/mindee/v2/parsing/search/search_models.rb

@@ -4,8 +4,9 @@ module Mindee
   module V2
     module Parsing
       module Search
-        # Array of search models.
+        # List of search models.
         class SearchModels < Array
+          # @param prediction [Array<Hash>] The parsed JSON payload mapping to the search models.
           def initialize(prediction)
             super(prediction.map { |entry| SearchModel.new(entry) })
           end

data/lib/mindee/v2/parsing/search/search_rag_document.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # Individual RAG document information.
+        class SearchRAGDocument
+          # @return [String] Unique identifier of the RAG document.
+          attr_reader :id
+
+          # @return [String] Model identifier linked to the RAG document.
+          attr_reader :model_id
+
+          # @return [String] Original filename of the uploaded document.
+          attr_reader :filename
+
+          # @return [Time] Date and time of the document creation.
+          attr_reader :created_at
+
+          # @return [Integer] Number of times this document was used in an inference.
+          attr_reader :total_matches
+
+          # @return [Time, nil] Date and time of the latest matching inference, if any.
+          attr_reader :last_match_at
+
+          # @return [String] Current status of the RAG document.
+          attr_reader :status
+
+          # @param server_response [Hash] The parsed JSON payload mapping to the RAG document.
+          def initialize(server_response)
+            @id = server_response['id']
+            @model_id = server_response['model_id']
+            @filename = server_response['filename']
+            @created_at = Time.iso8601(server_response['created_at'])
+            @total_matches = server_response['total_matches']
+            @last_match_at = (Time.iso8601(server_response['last_match_at']) if server_response['last_match_at'])
+            @status = server_response['status']
+          end
+
+          # String representation of the RAG document.
+          # @return [String]
+          def to_s
+            [
+              ":ID: #{@id}",
+              ":Model ID: #{@model_id}",
+              ":Filename: #{@filename}",
+              ":Created At: #{@created_at}",
+              ":Total Matches: #{@total_matches}",
+              ":Last Match At: #{@last_match_at}",
+              ":Status: #{@status}",
+            ].join("\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/parsing/search/search_rag_documents.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'search_rag_document'
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # List of RAG documents.
+        class SearchRAGDocuments < Array
+          # @param raw_response [Array<Hash>] The parsed JSON payload mapping to the RAG documents.
+          def initialize(raw_response)
+            super(raw_response.map { |entry| SearchRAGDocument.new(entry) })
+          end
+
+          # Default string representation.
+          # @return [String]
+          def to_s
+            return "\n" if empty?
+
+            lines = flat_map do |rag_document|
+              [
+                "* :ID: #{rag_document.id}",
+                "  :Model ID: #{rag_document.model_id}",
+                "  :Filename: #{rag_document.filename}",
+                "  :Created At: #{rag_document.created_at}",
+                "  :Total Matches: #{rag_document.total_matches}",
+                "  :Last Match At: #{rag_document.last_match_at}",
+                "  :Status: #{rag_document.status}",
+              ]
+            end
+
+            "#{lines.join("\n")}\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mindee/v2/parsing/search/search_response.rb

@@ -5,35 +5,8 @@ module Mindee
     module Parsing
       module Search
         # Models search response.
-        class SearchResponse < CommonResponse
-          # @return [Search::SearchModels] Parsed search payload.
-          attr_reader :models
-          # @return [Search::PaginationMetadata] Pagination metadata.
-          attr_reader :pagination
-          # @return [Search::PaginationMetadata] Pagination metadata.
-          attr_reader :pagination_metadata
-
-          def initialize(server_response)
-            super
-
-            @models = SearchModels.new(server_response['models'])
-            @pagination = PaginationMetadata.new(server_response['pagination'])
-            @pagination_metadata = @pagination
-          end
-
-          # String representation.
-          # @return [String]
-          def to_s
-            [
-              'Models',
-              '######',
-              @models.to_s,
-              'Pagination Metadata',
-              '###################',
-              @pagination.to_s,
-              '',
-            ].join("\n")
-          end
+        # @deprecated Use {Mindee::V2::Search::Models::ModelSearchResponse} instead.
+        class SearchResponse < Mindee::V2::Search::Models::ModelSearchResponse
         end
       end
     end

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

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 require_relative 'search/pagination_metadata'
+require_relative 'search/model_webhook'
 require_relative 'search/search_model'
 require_relative 'search/search_models'
+require_relative 'search/search_rag_document'
+require_relative 'search/search_rag_documents'
+require_relative 'search/base_search_response'
+require_relative '../search/models/model_search_response'
 require_relative 'search/search_response'
-require_relative 'search/model_webhook'

data/lib/mindee/v2/product/base_product.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../parsing/base_response'
-require_relative '../../input/base_parameters'
+require_relative '../client_options/base_product_parameters'
 
 module Mindee
   module V2
@@ -11,7 +11,7 @@ module Mindee
         # @return [String] The slug of the endpoint used for this response
         @slug = ''
         # @return [Class<BaseParameters>] The class of the parameters used for this response
-        @params_type = Mindee::Input::BaseParameters
+        @params_type = Mindee::V2::ClientOptions::BaseProductParameters
         # @return [Class<BaseResponse>] The class of the response used for this product
         @response_type = Mindee::V2::Parsing::BaseResponse
 

data/lib/mindee/v2/product/classification/classification_classifier.rb

@@ -13,11 +13,11 @@ module Mindee
           # @param server_response [Hash] Hash representation of the JSON returned by the service.
           def initialize(server_response)
             @document_type = server_response['document_type']
-            # rubocop:disable Style/GuardClause
-            unless server_response['extraction_response'].nil?
-              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
-            end
-            # rubocop:enable Style/GuardClause
+            @extraction_response = if server_response['extraction_response'].nil?
+                                     nil
+                                   else
+                                     V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+                                   end
           end
 
           # @return [String] String representation.

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,11 @@ 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
-            unless server_response['extraction_response'].nil?
-              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
-            end
-            # rubocop:enable Style/GuardClause
+            @extraction_response = if server_response['extraction_response'].nil?
+                                     nil
+                                   else
+                                     V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+                                   end
           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,11 @@ module Mindee
           def initialize(server_response)
             @page_range = server_response['page_range']
             @document_type = server_response['document_type']
-            # rubocop:disable Style/GuardClause
-            unless server_response['extraction_response'].nil?
-              @extraction_response = V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
-            end
-            # rubocop:enable Style/GuardClause
+            @extraction_response = if server_response['extraction_response'].nil?
+                                     nil
+                                   else
+                                     V2::Product::Extraction::ExtractionResponse.new(server_response['extraction_response'])
+                                   end
           end
 
           # String representation.

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Mindee
+  module V2
+    module Search
+      module Models
+        # Search for models within the organization linked to the API key.
+        # All search filters are optional.
+        # If no search filters are given, all models belonging to the organization are returned.
+        # Results are paginated.
+        class ModelSearchParameters < Mindee::V2::ClientOptions::BaseSearchParameters
+          # @return [String, nil] Filter models by partial name match, case-insensitive.
+          attr_reader :name
+
+          # @return [String, nil] Filter by an exact model type.
+          attr_reader :model_type
+
+          # @param name [String, nil] Filter models by partial name match, case-insensitive.
+          # @param model_type [String, nil] Filter by an exact 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.4.0'
+  VERSION = '5.6.0'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[String | Symbol, Regexp], Nil?]

data/mindee.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundle-audit', '~> 0.2.0'
   spec.add_development_dependency 'rbs', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.86'
+  spec.add_development_dependency 'rubocop', '~> 1.91.0'
   spec.add_development_dependency 'steep', '~> 1.10'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

data/prek.toml

@@ -0,0 +1,45 @@
+# Configuration file for `prek`, a git hook framework written in Rust.
+# See https://prek.j178.dev for more information.
+#:schema https://www.schemastore.org/prek.json
+
+[[repos]]
+repo = "builtin"
+hooks = [
+  { id = "trailing-whitespace" },
+  { id = "check-yaml" },
+  { id = "check-merge-conflict" },
+  { id = "check-added-large-files", args = ["--maxkb=1024"] },
+]
+
+[[repos]]
+repo = "https://github.com/betterleaks/betterleaks"
+rev = "v1.9.0"
+hooks = [
+  { id = "betterleaks" },
+]
+
+[[repos]]
+repo = "local"
+hooks = [
+  {
+    id = "rubocop",
+    name = "RuboCop",
+    entry = "bundle exec rubocop --force-exclusion --no-server",
+    language = "system",
+    types = ["ruby"]
+  },
+  {
+    id = "steep-check",
+    name = "Run Steep type checking",
+    entry = "bundle exec steep check",
+    language = "system",
+    pass_filenames = false
+  },
+  {
+    id = "bundle-audit",
+    name = "bundle-audit",
+    entry = "bundle exec bundle-audit check",
+    language = "system",
+    pass_filenames = false
+  },
+]

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/v1/client.rbs

@@ -19,18 +19,6 @@ module Mindee
       def initialize: (params: Hash[String | Symbol, untyped]) -> void
     end
 
-    class WorkflowOptions
-      attr_accessor document_alias: (String?)
-      attr_accessor priority: (Symbol?)
-      attr_accessor full_text: bool
-      attr_accessor rag: bool?
-      attr_accessor public_url: (String?)
-      attr_accessor page_options: (PageOptions)
-      attr_accessor close_file: bool
-
-      def initialize: (params: Hash[String | Symbol, untyped]) -> void
-    end
-
     class Client
       @api_key: String?
 
@@ -48,8 +36,6 @@ module Mindee
 
       def enqueue_and_parse: (Input::Source::URLInputSource | Input::Source::LocalInputSource, singleton(V1::Parsing::Common::Inference), V1::HTTP::Endpoint, ParseOptions) -> V1::Parsing::Common::ApiResponse
 
-      def execute_workflow: (Input::Source::URLInputSource | Input::Source::LocalInputSource, String, options: (Hash[String | Symbol, untyped] | WorkflowOptions)) -> V1::Parsing::Common::WorkflowResponse
-
       def load_prediction: (singleton(V1::Parsing::Common::Inference), Input::LocalResponse) -> V1::Parsing::Common::ApiResponse
 
       def source_from_path: (String, ?repair_pdf: bool) -> Input::Source::PathInputSource
@@ -68,7 +54,7 @@ module Mindee
 
       def normalize_parse_options: ((Hash[String | Symbol, untyped] | ParseOptions)) -> ParseOptions
 
-      def process_pdf_if_required: (Input::Source::LocalInputSource, ParseOptions | WorkflowOptions) -> void
+      def process_pdf_if_required: (Input::Source::LocalInputSource, ParseOptions ) -> void
 
       def initialize_endpoint: (singleton(V1::Parsing::Common::Inference), ?endpoint_name: String, ?account_name: String, ?version: String) -> V1::HTTP::Endpoint
 

data/sig/mindee/v2/client.rbs

@@ -15,15 +15,22 @@ 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 get_result_by_url: [T] (HTTP::_ProductClass[T] product, String url) -> T
 
-      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 get_job_by_url: (String url) -> V2::Parsing::JobResponse
 
-      def search_models: (String?, String?) -> Mindee::V2::Parsing::Search::SearchResponse
+      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] | ClientOptions::BaseProductParameters params, ?Hash[String | Symbol, untyped] | Input::PollingOptions | nil) -> T
+
+      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