mindee 5.4.0 → 5.6.0

data/docs/code_samples/bank_account_details_v1.txt

@@ -1,24 +0,0 @@
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-require 'mindee'
-
-# Init a new client
-mindee_client = Mindee::V1::Client.new(api_key: 'my-api-key')
-
-# Load a file from disk
-input_source = mindee_client.source_from_path('/path/to/the/file.ext')
-
-# Parse the file
-result = mindee_client.parse(
-  input_source,
-  Mindee::V1::Product::FR::BankAccountDetails::BankAccountDetailsV1
-)
-
-# Print a full summary of the parsed data in RST format
-puts result.document
-
-# Print the document-level parsed data
-# puts result.document.inference.prediction

data/docs/code_samples/barcode_reader_v1.txt

@@ -1,24 +0,0 @@
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-require 'mindee'
-
-# Init a new client
-mindee_client = Mindee::V1::Client.new(api_key: 'my-api-key')
-
-# Load a file from disk
-input_source = mindee_client.source_from_path('/path/to/the/file.ext')
-
-# Parse the file
-result = mindee_client.parse(
-  input_source,
-  Mindee::V1::Product::BarcodeReader::BarcodeReaderV1
-)
-
-# Print a full summary of the parsed data in RST format
-puts result.document
-
-# Print the document-level parsed data
-# puts result.document.inference.prediction

data/docs/code_samples/idcard_fr_v1.txt

@@ -1,24 +0,0 @@
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-require 'mindee'
-
-# Init a new client
-mindee_client = Mindee::V1::Client.new(api_key: 'my-api-key')
-
-# Load a file from disk
-input_source = mindee_client.source_from_path('/path/to/the/file.ext')
-
-# Parse the file
-result = mindee_client.parse(
-  input_source,
-  Mindee::V1::Product::FR::IdCard::IdCardV1
-)
-
-# Print a full summary of the parsed data in RST format
-puts result.document
-
-# Print the document-level parsed data
-# puts result.document.inference.prediction

data/docs/code_samples/workflow_execution.txt

@@ -1,28 +0,0 @@
-#
-# Install the Ruby client library by running:
-# gem install mindee
-#
-
-require 'mindee'
-
-workflow_id = 'workflow-id'
-
-# Init a new client
-mindee_client = Mindee::V1::Client.new
-
-# Load a file from disk
-input_source = mindee_client.source_from_path('path/to/my/file.ext')
-
-# Send the file to the workflow
-result = mindee_client.execute_workflow(
-  input_source,
-  workflow_id,
-# options: { # Optionally, you can provide the following parameters:
-#   document_alias: 'my-document-alias', # Potential alias for the document
-#   priority: Mindee::V1::Parsing::Common::ExecutionPriority::LOW, # Priority of the execution
-#   rag: true # Whether to enable Retrieval-Augmented Generation
-# }
-)
-
-# Print the execution's ID to make sure it worked
-puts result.execution.id

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/lib/mindee/v1/http/workflow_endpoint.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'net/http'
-require_relative '../../http/http_error_handler'
-
-module Mindee
-  module V1
-    module HTTP
-      # Handles the routing for workflow calls.
-      class WorkflowEndpoint
-        # @return [String]
-        attr_reader :api_key
-        # @return [Integer]
-        attr_reader :request_timeout
-        # @return [String]
-        attr_reader :url
-
-        def initialize(workflow_id, api_key: '')
-          @request_timeout = ENV.fetch(REQUEST_TIMEOUT_ENV_NAME, TIMEOUT_DEFAULT).to_i
-          @api_key = api_key.nil? || api_key.empty? ? ENV.fetch(API_KEY_ENV_NAME, API_KEY_DEFAULT) : api_key
-          base_url = ENV.fetch(BASE_URL_ENV_NAME, BASE_URL_DEFAULT)
-          @url = "#{base_url.chomp('/')}/workflows/#{workflow_id}/executions"
-        end
-
-        # Sends a document to the workflow.
-        # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
-        # @param opts [WorkflowOptions] Options to configure workflow execution behavior.
-        # @return [Array]
-        def execute_workflow(input_source, opts)
-          check_api_key
-          response = workflow_execution_req_post(input_source, opts)
-          if response.nil?
-            raise Mindee::Error::MindeeHTTPError.new(
-              { code: 0, details: 'Server response was nil.', message: 'Unknown error.' }, @url, 0
-            )
-          end
-
-          hashed_response = JSON.parse(response.body, object_class: Hash)
-          return [hashed_response, response.body] if Mindee::HTTP::ResponseValidation.valid_async_response?(response)
-
-          Mindee::HTTP::ResponseValidation.clean_request!(response)
-          error = Mindee::HTTP::ErrorHandler.handle_error(@url_name, response)
-          raise error
-        end
-
-        # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
-        # @param opts [WorkflowOptions] Options to configure workflow execution behavior.
-        # @return [Net::HTTPResponse, nil]
-        def workflow_execution_req_post(input_source, opts)
-          uri = URI(@url)
-          params = {} # : Hash[String | Symbol, untyped]
-          params[:full_text_ocr] = 'true' if opts.full_text
-          params[:rag] = 'true' if opts.rag
-          uri.query = URI.encode_www_form(params) if params.any?
-
-          headers = {
-            'Authorization' => "Token #{@api_key}",
-            'User-Agent' => USER_AGENT,
-          }
-          req = Net::HTTP::Post.new(uri, headers)
-          form_data = [] # : Array[untyped]
-          if input_source.is_a?(Mindee::Input::Source::URLInputSource)
-            form_data.push ['document', input_source.url]
-          else
-            form_data.push ['document', *input_source.read_contents(close: opts.close_file)]
-          end
-          form_data.push ['alias', opts.document_alias] if opts.document_alias
-          form_data.push ['public_url', opts.public_url] if opts.public_url
-          form_data.push ['priority', opts.priority.to_s] if opts.priority
-
-          req.set_form(form_data, 'multipart/form-data')
-          req['Transfer-Encoding'] = 'chunked'
-
-          response = nil
-          Net::HTTP.start(uri.hostname, uri.port, use_ssl: true, read_timeout: @request_timeout) do |http|
-            response = http.request(req)
-          end
-          response
-        end
-
-        # Checks API key
-        def check_api_key
-          return unless @api_key.nil? || @api_key.empty?
-
-          raise Error::MindeeConfigurationError, "Missing API key. Check your Client Configuration.\n" \
-                                                 "You can set this using the '#{HTTP::API_KEY_ENV_NAME}'" \
-                                                 'environment variable.'
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/barcode_reader/barcode_reader_v1.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'barcode_reader_v1_document'
-require_relative 'barcode_reader_v1_page'
-
-module Mindee
-  module V1
-    module Product
-      # Barcode Reader module.
-      module BarcodeReader
-        # Barcode Reader API version 1 inference prediction.
-        class BarcodeReaderV1 < Mindee::V1::Parsing::Common::Inference
-          @endpoint_name = 'barcode_reader'
-          @endpoint_version = '1'
-          @has_async = false
-          @has_sync = true
-
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = BarcodeReaderV1Document.new(prediction['prediction'], nil)
-            @pages = []
-            prediction['pages'].each do |page|
-              @pages.push(BarcodeReaderV1Page.new(page))
-            end
-          end
-
-          class << self
-            # Name of the endpoint for this product.
-            # @return [String]
-            attr_reader :endpoint_name
-            # Version for this product.
-            # @return [String]
-            attr_reader :endpoint_version
-            # Whether this product has access to an asynchronous endpoint.
-            # @return [bool]
-            attr_reader :has_async
-            # Whether this product has access to synchronous endpoint.
-            # @return [bool]
-            attr_reader :has_sync
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/barcode_reader/barcode_reader_v1_document.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-
-module Mindee
-  module V1
-    module Product
-      module BarcodeReader
-        # Barcode Reader API version 1.0 document data.
-        class BarcodeReaderV1Document < Mindee::V1::Parsing::Common::Prediction
-          include Mindee::V1::Parsing::Standard
-
-          # List of decoded 1D barcodes.
-          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
-          attr_reader :codes_1d
-          # List of decoded 2D barcodes.
-          # @return [Array<Mindee::V1::Parsing::Standard::StringField>]
-          attr_reader :codes_2d
-
-          # @param prediction [Hash]
-          # @param page_id [Integer, nil]
-          def initialize(prediction, page_id)
-            super
-            @codes_1d = [] # : Array[Parsing::Standard::StringField]
-            prediction['codes_1d'].each do |item|
-              @codes_1d.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-            @codes_2d = [] # : Array[Parsing::Standard::StringField]
-            prediction['codes_2d'].each do |item|
-              @codes_2d.push(Parsing::Standard::StringField.new(item, page_id))
-            end
-          end
-
-          # @return [String]
-          def to_s
-            codes_1d = @codes_1d.join("\n #{' ' * 13}")
-            codes_2d = @codes_2d.join("\n #{' ' * 13}")
-            out_str = String.new
-            out_str << "\n:Barcodes 1D: #{codes_1d}".rstrip
-            out_str << "\n:Barcodes 2D: #{codes_2d}".rstrip
-            out_str[1..].to_s
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/barcode_reader/barcode_reader_v1_page.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../parsing'
-require_relative 'barcode_reader_v1_document'
-
-module Mindee
-  module V1
-    module Product
-      module BarcodeReader
-        # Barcode Reader API version 1.0 page data.
-        class BarcodeReaderV1Page < Mindee::V1::Parsing::Common::Page
-          # @param prediction [Hash]
-          def initialize(prediction)
-            super
-            @prediction = if prediction['prediction'].empty?
-                            nil
-                          else
-                            BarcodeReaderV1PagePrediction.new(
-                              prediction['prediction'],
-                              prediction['id']
-                            )
-                          end
-          end
-        end
-
-        # Barcode Reader V1 page prediction.
-        class BarcodeReaderV1PagePrediction < BarcodeReaderV1Document
-          # @return [String]
-          def to_s
-            out_str = String.new
-            out_str << "\n#{super}"
-            out_str
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_account_details_v1_document'
-require_relative 'bank_account_details_v1_page'
-
-module Mindee
-  module V1
-    module Product
-      module FR
-        # Bank Account Details module.
-        module BankAccountDetails
-          # Bank Account Details API version 1 inference prediction.
-          class BankAccountDetailsV1 < Mindee::V1::Parsing::Common::Inference
-            @endpoint_name = 'bank_account_details'
-            @endpoint_version = '1'
-            @has_async = false
-            @has_sync = true
-
-            # @param prediction [Hash]
-            def initialize(prediction)
-              super
-              @prediction = BankAccountDetailsV1Document.new(prediction['prediction'], nil)
-              @pages = []
-              prediction['pages'].each do |page|
-                @pages.push(BankAccountDetailsV1Page.new(page))
-              end
-            end
-
-            class << self
-              # Name of the endpoint for this product.
-              # @return [String]
-              attr_reader :endpoint_name
-              # Version for this product.
-              # @return [String]
-              attr_reader :endpoint_version
-              # Whether this product has access to an asynchronous endpoint.
-              # @return [bool]
-              attr_reader :has_async
-              # Whether this product has access to synchronous endpoint.
-              # @return [bool]
-              attr_reader :has_sync
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_document.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-
-module Mindee
-  module V1
-    module Product
-      module FR
-        module BankAccountDetails
-          # Bank Account Details API version 1.0 document data.
-          class BankAccountDetailsV1Document < Mindee::V1::Parsing::Common::Prediction
-            include Mindee::V1::Parsing::Standard
-
-            # The name of the account holder as seen on the document.
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :account_holder_name
-            # The International Bank Account Number (IBAN).
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :iban
-            # The bank's SWIFT Business Identifier Code (BIC).
-            # @return [Mindee::V1::Parsing::Standard::StringField]
-            attr_reader :swift
-
-            # @param prediction [Hash]
-            # @param page_id [Integer, nil]
-            def initialize(prediction, page_id)
-              super
-              @account_holder_name = Parsing::Standard::StringField.new(
-                prediction['account_holder_name'],
-                page_id
-              )
-              @iban = Parsing::Standard::StringField.new(prediction['iban'], page_id)
-              @swift = Parsing::Standard::StringField.new(prediction['swift'], page_id)
-            end
-
-            # @return [String]
-            def to_s
-              out_str = String.new
-              out_str << "\n:IBAN: #{@iban}".rstrip
-              out_str << "\n:Account Holder's Name: #{@account_holder_name}".rstrip
-              out_str << "\n:SWIFT Code: #{@swift}".rstrip
-              out_str[1..].to_s
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_page.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'bank_account_details_v1_document'
-
-module Mindee
-  module V1
-    module Product
-      module FR
-        module BankAccountDetails
-          # Bank Account Details API version 1.0 page data.
-          class BankAccountDetailsV1Page < Mindee::V1::Parsing::Common::Page
-            # @param prediction [Hash]
-            def initialize(prediction)
-              super
-              @prediction = if prediction['prediction'].empty?
-                              nil
-                            else
-                              BankAccountDetailsV1PagePrediction.new(
-                                prediction['prediction'],
-                                prediction['id']
-                              )
-                            end
-            end
-          end
-
-          # Bank Account Details V1 page prediction.
-          class BankAccountDetailsV1PagePrediction < BankAccountDetailsV1Document
-            # @return [String]
-            def to_s
-              out_str = String.new
-              out_str << "\n#{super}"
-              out_str
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mindee/v1/product/fr/id_card/id_card_v1.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../parsing'
-require_relative 'id_card_v1_document'
-require_relative 'id_card_v1_page'
-
-module Mindee
-  module V1
-    module Product
-      module FR
-        # Carte Nationale d'Identité module.
-        module IdCard
-          # Carte Nationale d'Identité API version 1 inference prediction.
-          class IdCardV1 < Mindee::V1::Parsing::Common::Inference
-            @endpoint_name = 'idcard_fr'
-            @endpoint_version = '1'
-            @has_async = false
-            @has_sync = true
-
-            # @param prediction [Hash]
-            def initialize(prediction)
-              super
-              @prediction = IdCardV1Document.new(prediction['prediction'], nil)
-              @pages = []
-              prediction['pages'].each do |page|
-                @pages.push(IdCardV1Page.new(page))
-              end
-            end
-
-            class << self
-              # Name of the endpoint for this product.
-              # @return [String]
-              attr_reader :endpoint_name
-              # Version for this product.
-              # @return [String]
-              attr_reader :endpoint_version
-              # Whether this product has access to an asynchronous endpoint.
-              # @return [bool]
-              attr_reader :has_async
-              # Whether this product has access to synchronous endpoint.
-              # @return [bool]
-              attr_reader :has_sync
-            end
-          end
-        end
-      end
-    end
-  end
-end