retab 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d9fd0fbbfdf5fc2c58b483cc5d2fd0981d97d5f41f68d77f1c333944a2fc6dd
-  data.tar.gz: b6984aca8ca57f563be3d839707c5846dcac45bbdfc03cf9888173a69df88383
+  metadata.gz: 6d8f00bc26ed73aa5d559ff12a8903bc8e0902d16aa47ee5bacdc174face30ad
+  data.tar.gz: c152d02486ec700e26c0a59c1ff51e07f15567516bfd06e19899ce1619771e30
 SHA512:
-  metadata.gz: 9ac7596123c9d5073186740e0bb2e542f50d88c538cc478691fb28882f6d87a98477fd533eaf2c26b133c5efc18f9eeae536b844316d3a7aef30618dcfb22dec
-  data.tar.gz: 40dae270f0ea4862db0bddd44fe79fc9f737c99c64d72f206e6ba9c85eabc067573a49f68f46b8dcbf727a3ef37c8b7fce27da802c74841848d9e7b5f4ab8ac9
+  metadata.gz: b89d753a806f26903c1f1bd3c005a80f92d8b7d940eba048d6f78de16e5241a27a628505eb2c320144dc1eed41579eefd750488007a345ced2368d4e24dec5fa
+  data.tar.gz: 4472ad621a070d8e80e703f3f4f4740d212ff7481966ce3094cb082361f74c648a8f0712bd43a1c34997d91ed8205c5146149b614252b4b607124ab33dba6054

data/lib/retab/base_client.rb

@@ -72,11 +72,7 @@ module Retab
       req["User-Agent"] = @configuration.user_agent
       if auth
         key = (request_options[:api_key] || request_options["api_key"] || api_key)
-        # Retab's API expects the raw key in `Api-Key` (not `Authorization: Bearer ...`).
-        # Confirmed against the Python SDK's `client.py` and the server response on
-        # /v1/files: "Provide a valid Bearer token, API Key, ..." — the API Key path
-        # is the `Api-Key` header.
-        req["Api-Key"] = key if key
+        req["Authorization"] = "Bearer #{key}" if key
       end
 
       if (idem = request_options[:idempotency_key] || request_options["idempotency_key"])

data/lib/retab/classifications/file_ref.rb

@@ -3,26 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  class FileRef < Retab::Types::BaseModel
-
-    HASH_ATTRS = {
-      id: :id,
-      filename: :filename,
-      mime_type: :mime_type
-    }.freeze
-
-    attr_accessor(
-      :id,
-      :filename,
-      :mime_type
-    )
-
-    def initialize(json)
-      super()
-      hash = self.class.normalize(json)
-      @id = hash[:id]
-      @filename = hash[:filename]
-      @mime_type = hash[:mime_type]
-    end
-  end
+  FileRef = BlockExecFileRef
 end

data/lib/retab/classifications.rb

@@ -100,7 +100,7 @@ module Retab
       background: nil,
       request_options: {}
     )
-      document = Retab::MimeData.coerce(document) unless document.nil?
+      document = Retab::MimeData.coerce(document, client: @client) unless document.nil?
       body = {
         "document" => document,
         "categories" => categories,

data/lib/retab/edit_templates.rb

@@ -74,7 +74,7 @@ module Retab
       form_fields:,
       request_options: {}
     )
-      document = Retab::MimeData.coerce(document) unless document.nil?
+      document = Retab::MimeData.coerce(document, client: @client) unless document.nil?
       body = {
         "name" => name,
         "document" => document,

data/lib/retab/edits.rb

@@ -107,7 +107,7 @@ module Retab
       background: nil,
       request_options: {}
     )
-      document = Retab::MimeData.coerce(document) unless document.nil?
+      document = Retab::MimeData.coerce(document, client: @client) unless document.nil?
       body = {
         "instructions" => instructions,
         "document" => document,

data/lib/retab/experiment_run_metrics/experiment_metrics_stale_error.rb

@@ -11,7 +11,7 @@ module Retab
       experiment_id: :experiment_id,
       stale_reasons: :stale_reasons,
       last_run: :last_run,
-      current_config_fingerprint: :current_config_fingerprint,
+      current_block_execution_fingerprint: :current_block_execution_fingerprint,
       message: :message
     }.freeze
 
@@ -21,7 +21,7 @@ module Retab
       :experiment_id,
       :stale_reasons,
       :last_run,
-      :current_config_fingerprint,
+      :current_block_execution_fingerprint,
       :message
     )
 
@@ -33,7 +33,7 @@ module Retab
       @experiment_id = hash[:experiment_id]
       @stale_reasons = (hash[:stale_reasons] || [])
       @last_run = hash[:last_run] ? Retab::MetricsStaleErrorLastRun.new(hash[:last_run]) : nil
-      @current_config_fingerprint = hash[:current_config_fingerprint]
+      @current_block_execution_fingerprint = hash[:current_block_execution_fingerprint]
       @message = hash[:message]
     end
   end

data/lib/retab/experiment_run_metrics/experiment_summary_metrics_response.rb

@@ -10,7 +10,7 @@ module Retab
       run_id: :run_id,
       kind: :kind,
       view: :view,
-      definition_fingerprint: :definition_fingerprint,
+      block_execution_fingerprint: :block_execution_fingerprint,
       block_type: :block_type,
       score: :score,
       prior_score: :prior_score,
@@ -24,7 +24,7 @@ module Retab
       :run_id,
       :kind,
       :view,
-      :definition_fingerprint,
+      :block_execution_fingerprint,
       :block_type,
       :score,
       :prior_score,
@@ -40,7 +40,7 @@ module Retab
       @run_id = hash[:run_id]
       @kind = hash[:kind].nil? ? "summary" : hash[:kind]
       @view = hash[:view].nil? ? "summary" : hash[:view]
-      @definition_fingerprint = hash[:definition_fingerprint]
+      @block_execution_fingerprint = hash[:block_execution_fingerprint]
       @block_type = hash[:block_type]
       @score = hash[:score]
       @prior_score = hash[:prior_score]

data/lib/retab/experiment_run_metrics/metrics_stale_error_last_run.rb

@@ -7,14 +7,14 @@ module Retab
 
     HASH_ATTRS = {
       run_id: :run_id,
-      definition_fingerprint: :definition_fingerprint,
+      block_execution_fingerprint: :block_execution_fingerprint,
       score: :score,
       created_at: :created_at
     }.freeze
 
     attr_accessor(
       :run_id,
-      :definition_fingerprint,
+      :block_execution_fingerprint,
       :score,
       :created_at
     )
@@ -23,7 +23,7 @@ module Retab
       super()
       hash = self.class.normalize(json)
       @run_id = hash[:run_id]
-      @definition_fingerprint = hash[:definition_fingerprint]
+      @block_execution_fingerprint = hash[:block_execution_fingerprint]
       @score = hash[:score]
       @created_at = hash[:created_at]
     end

data/lib/retab/experiment_run_results/error_workflow_experiment_result.rb

@@ -3,26 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  class ErrorWorkflowExperimentResult < Retab::Types::BaseModel
-
-    HASH_ATTRS = {
-      status: :status,
-      message: :message,
-      details: :details
-    }.freeze
-
-    attr_accessor(
-      :status,
-      :message,
-      :details
-    )
-
-    def initialize(json)
-      super()
-      hash = self.class.normalize(json)
-      @status = hash[:status].nil? ? "error" : hash[:status]
-      @message = hash[:message].nil? ? "(no message)" : hash[:message]
-      @details = hash[:details] ? Retab::ErrorDetails.new(hash[:details]) : nil
-    end
-  end
+  ErrorWorkflowExperimentResult = ErrorWorkflowEvalRun
 end

data/lib/retab/experiment_run_results/pending_workflow_experiment_result.rb

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  PendingWorkflowExperimentResult = PendingRun
+  PendingWorkflowExperimentResult = PendingBlockExecutionLifecycle
 end

data/lib/retab/experiment_run_results/queued_workflow_experiment_result.rb

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  QueuedWorkflowExperimentResult = QueuedStepLifecycle
+  QueuedWorkflowExperimentResult = QueuedBlockExecutionLifecycle
 end

data/lib/retab/experiment_run_results/running_workflow_experiment_result.rb

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  RunningWorkflowExperimentResult = RunningRun
+  RunningWorkflowExperimentResult = RunningBlockExecutionLifecycle
 end

data/lib/retab/experiment_runs/create_experiment_run_request.rb

@@ -7,12 +7,14 @@ module Retab
 
     HASH_ATTRS = {
       experiment_id: :experiment_id,
-      workflow_id: :workflow_id
+      workflow_id: :workflow_id,
+      plan_token: :plan_token
     }.freeze
 
     attr_accessor(
       :experiment_id,
-      :workflow_id
+      :workflow_id,
+      :plan_token
     )
 
     def initialize(json)
@@ -20,6 +22,7 @@ module Retab
       hash = self.class.normalize(json)
       @experiment_id = hash[:experiment_id]
       @workflow_id = hash[:workflow_id]
+      @plan_token = hash[:plan_token]
     end
   end
 end

data/lib/retab/experiment_runs/error_workflow_experiment_run.rb

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  ErrorWorkflowExperimentRun = ErrorWorkflowExperimentResult
+  ErrorWorkflowExperimentRun = ErrorWorkflowEvalRun
 end

data/lib/retab/experiment_runs/experiment_run.rb

@@ -20,7 +20,7 @@ module Retab
       block_version_id: :block_version_id,
       metrics_validity_fingerprint: :metrics_validity_fingerprint,
       metrics_validity_fingerprint_version: :metrics_validity_fingerprint_version,
-      definition_fingerprint: :definition_fingerprint,
+      block_execution_fingerprint: :block_execution_fingerprint,
       documents_fingerprint: :documents_fingerprint,
       score: :score,
       total_document_count: :total_document_count,
@@ -44,7 +44,7 @@ module Retab
       :block_version_id,
       :metrics_validity_fingerprint,
       :metrics_validity_fingerprint_version,
-      :definition_fingerprint,
+      :block_execution_fingerprint,
       :documents_fingerprint,
       :score,
       :total_document_count,
@@ -87,7 +87,7 @@ module Retab
       @block_version_id = hash[:block_version_id]
       @metrics_validity_fingerprint = hash[:metrics_validity_fingerprint]
       @metrics_validity_fingerprint_version = hash[:metrics_validity_fingerprint_version]
-      @definition_fingerprint = hash[:definition_fingerprint]
+      @block_execution_fingerprint = hash[:block_execution_fingerprint]
       @documents_fingerprint = hash[:documents_fingerprint]
       @score = hash[:score]
       @total_document_count = hash[:total_document_count]

data/lib/retab/experiment_runs/pending_workflow_experiment_run.rb

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  PendingWorkflowExperimentRun = PendingRun
+  PendingWorkflowExperimentRun = PendingBlockExecutionLifecycle
 end

data/lib/retab/experiment_runs/queued_workflow_experiment_run.rb

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  QueuedWorkflowExperimentRun = QueuedStepLifecycle
+  QueuedWorkflowExperimentRun = QueuedBlockExecutionLifecycle
 end

data/lib/retab/experiment_runs/running_workflow_experiment_run.rb

@@ -3,5 +3,5 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  RunningWorkflowExperimentRun = RunningRun
+  RunningWorkflowExperimentRun = RunningBlockExecutionLifecycle
 end

data/lib/retab/experiment_runs.rb

@@ -106,16 +106,19 @@ module Retab
     # Create Experiment Run Flat
     # @param experiment_id [String] The experiment to create a run for.
     # @param workflow_id [String, nil] Optional. When omitted, the workflow is derived from the experiment record. When supplied, must match the experiment's workflow_id (404 otherwise).
+    # @param plan_token [String, nil] Optional short-lived token returned by the run-plan preview. When supplied, run creation rejects if the current plan no longer matches the preview.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::ExperimentRun]
     def create(
       experiment_id:,
       workflow_id: nil,
+      plan_token: nil,
       request_options: {}
     )
       body = {
         "experiment_id" => experiment_id,
-        "workflow_id" => workflow_id
+        "workflow_id" => workflow_id,
+        "plan_token" => plan_token
       }.compact
       response = @client.request(
         method: :post,

data/lib/retab/extractions/extraction.rb

@@ -11,7 +11,6 @@ module Retab
       model: :model,
       json_schema: :json_schema,
       n_consensus: :n_consensus,
-      image_resolution_dpi: :image_resolution_dpi,
       instructions: :instructions,
       output: :output,
       status: :status,
@@ -28,7 +27,6 @@ module Retab
       :model,
       :json_schema,
       :n_consensus,
-      :image_resolution_dpi,
       :instructions,
       :output,
       :status,
@@ -47,7 +45,6 @@ module Retab
       @model = hash[:model]
       @json_schema = hash[:json_schema] || {}
       @n_consensus = hash[:n_consensus]
-      @image_resolution_dpi = hash[:image_resolution_dpi]
       @instructions = hash[:instructions]
       @output = hash[:output] || {}
       @status = hash[:status].nil? ? "pending" : hash[:status]

data/lib/retab/extractions/extraction_request.rb

@@ -9,7 +9,6 @@ module Retab
       document: :document,
       json_schema: :json_schema,
       model: :model,
-      image_resolution_dpi: :image_resolution_dpi,
       instructions: :instructions,
       n_consensus: :n_consensus,
       metadata: :metadata,
@@ -24,7 +23,6 @@ module Retab
       :document,
       :json_schema,
       :model,
-      :image_resolution_dpi,
       :instructions,
       :n_consensus,
       :metadata,
@@ -41,7 +39,6 @@ module Retab
       @document = hash[:document] ? Retab::MimeData.new(hash[:document]) : nil
       @json_schema = hash[:json_schema] || {}
       @model = hash[:model].nil? ? "retab-small" : hash[:model]
-      @image_resolution_dpi = hash[:image_resolution_dpi]
       @instructions = hash[:instructions]
       @n_consensus = hash[:n_consensus]
       @metadata = hash[:metadata] || {}

data/lib/retab/extractions.rb

@@ -102,7 +102,6 @@ module Retab
     # @param document [Retab::MimeData, Pathname, IO, String, Hash]
     # @param json_schema [Hash{String => Object}] JSON schema describing the structured output
     # @param model [String, nil] The model to use for the extraction
-    # @param image_resolution_dpi [Integer, nil] Resolution of the image sent to the LLM
     # @param instructions [String, nil] Free-form instructions appended to the system prompt to steer the extraction.
     # @param n_consensus [Integer, nil] Number of consensus extraction runs to perform. Uses deterministic single-pass when set to 1.
     # @param metadata [Hash{String => String}, nil] User-defined metadata to associate with this extraction
@@ -117,7 +116,6 @@ module Retab
       document:,
       json_schema:,
       model: nil,
-      image_resolution_dpi: nil,
       instructions: nil,
       n_consensus: nil,
       metadata: nil,
@@ -128,12 +126,11 @@ module Retab
       chunking_keys: nil,
       request_options: {}
     )
-      document = Retab::MimeData.coerce(document) unless document.nil?
+      document = Retab::MimeData.coerce(document, client: @client) unless document.nil?
       body = {
         "document" => document,
         "json_schema" => json_schema,
         "model" => model,
-        "image_resolution_dpi" => image_resolution_dpi,
         "instructions" => instructions,
         "n_consensus" => n_consensus,
         "metadata" => metadata,
@@ -159,6 +156,58 @@ module Retab
       result
     end
 
+    # Create Extraction Stream
+    # @param document [Retab::MimeData, Pathname, IO, String, Hash]
+    # @param json_schema [Hash{String => Object}] JSON schema describing the structured output
+    # @param model [String, nil] The model to use for the extraction
+    # @param instructions [String, nil] Free-form instructions appended to the system prompt to steer the extraction.
+    # @param n_consensus [Integer, nil] Number of consensus extraction runs to perform. Uses deterministic single-pass when set to 1.
+    # @param metadata [Hash{String => String}, nil] User-defined metadata to associate with this extraction
+    # @param additional_messages [Array<Hash{String => Object}>, nil] Additional chat messages forwarded to the extraction model.
+    # @param bust_cache [Boolean, nil] If true, skip the LLM cache and force a fresh completion
+    # @param stream [Boolean, nil]
+    # @param background [Boolean, nil] If true, run asynchronously: returns immediately with status 'queued' and an empty output. Poll GET /v1/<primitive>/{id} until status is terminal. Mutually exclusive with stream.
+    # @param chunking_keys [Hash{String => String}, nil]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [void]
+    def create_stream(
+      document:,
+      json_schema:,
+      model: nil,
+      instructions: nil,
+      n_consensus: nil,
+      metadata: nil,
+      additional_messages: nil,
+      bust_cache: nil,
+      stream: nil,
+      background: nil,
+      chunking_keys: nil,
+      request_options: {}
+    )
+      document = Retab::MimeData.coerce(document, client: @client) unless document.nil?
+      body = {
+        "document" => document,
+        "json_schema" => json_schema,
+        "model" => model,
+        "instructions" => instructions,
+        "n_consensus" => n_consensus,
+        "metadata" => metadata,
+        "additional_messages" => additional_messages,
+        "bust_cache" => bust_cache,
+        "stream" => stream,
+        "background" => background,
+        "chunking_keys" => chunking_keys
+      }.compact
+      @client.request(
+        method: :post,
+        path: "/v1/extractions/stream",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      nil
+    end
+
     # Get Extraction
     # @param extraction_id [String]
     # @param include_output [Boolean, nil] When false, returns a cheap status-only projection (no output), served from cache for in-flight background runs.

data/lib/retab/files/create_file_blueprint_request.rb

@@ -7,15 +7,15 @@ module Retab
 
     HASH_ATTRS = {
       file_id: :file_id,
-      mode: :mode,
       intent: :intent,
+      mode: :mode,
       background: :background
     }.freeze
 
     attr_accessor(
       :file_id,
-      :mode,
       :intent,
+      :mode,
       :background
     )
 
@@ -23,8 +23,8 @@ module Retab
       super()
       hash = self.class.normalize(json)
       @file_id = hash[:file_id]
-      @mode = hash[:mode]
       @intent = hash[:intent]
+      @mode = hash[:mode]
       @background = hash[:background].nil? ? false : hash[:background]
     end
   end

data/lib/retab/files/file_blueprint.rb

@@ -9,28 +9,28 @@ module Retab
       object: :object,
       id: :id,
       file: :file,
-      mode: :mode,
       intent: :intent,
       output: :output,
       status: :status,
       error: :error,
       created_at: :created_at,
       started_at: :started_at,
-      completed_at: :completed_at
+      completed_at: :completed_at,
+      mode: :mode
     }.freeze
 
     attr_accessor(
       :object,
       :id,
       :file,
-      :mode,
       :intent,
       :output,
       :status,
       :error,
       :created_at,
       :started_at,
-      :completed_at
+      :completed_at,
+      :mode
     )
 
     def initialize(json)
@@ -39,7 +39,6 @@ module Retab
       @object = hash[:object].nil? ? "file.blueprint" : hash[:object]
       @id = hash[:id]
       @file = hash[:file] ? Retab::FileRef.new(hash[:file]) : nil
-      @mode = hash[:mode]
       @intent = hash[:intent]
       @output = hash[:output] || {}
       @status = hash[:status].nil? ? "pending" : hash[:status]
@@ -47,6 +46,7 @@ module Retab
       @created_at = hash[:created_at]
       @started_at = hash[:started_at]
       @completed_at = hash[:completed_at]
+      @mode = hash[:mode]
     end
   end
 end

data/lib/retab/files.rb

@@ -90,22 +90,22 @@ module Retab
 
     # Create File Blueprint
     # @param file_id [String] File id to analyze.
-    # @param mode [Retab::Types::CreateFileBlueprintRequestMode, nil] Optional analysis depth override. Omit to let Retab choose.
     # @param intent [String, nil] Optional user intent used to guide the blueprint analysis.
+    # @param mode [Retab::Types::CreateFileBlueprintRequestMode, nil] Legacy compatibility field. Blueprint analysis always runs a single pass.
     # @param background [Boolean, nil] If true, run asynchronously: returns immediately with status 'queued' and an empty output. Poll GET /v1/<primitive>/{id} until status is terminal. Mutually exclusive with stream.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::FileBlueprint]
     def create_blueprint(
       file_id:,
-      mode: nil,
       intent: nil,
+      mode: nil,
       background: nil,
       request_options: {}
     )
       body = {
         "file_id" => file_id,
-        "mode" => mode,
         "intent" => intent,
+        "mode" => mode,
         "background" => background
       }.compact
       response = @client.request(