retab 0.1.4 → 0.1.5

data/lib/retab/partitions/partition.rb

@@ -14,6 +14,8 @@ module Retab
       n_consensus: :n_consensus,
       allow_overlap: :allow_overlap,
       output: :output,
+      status: :status,
+      error: :error,
       consensus: :consensus,
       usage: :usage,
       created_at: :created_at
@@ -28,6 +30,8 @@ module Retab
       :n_consensus,
       :allow_overlap,
       :output,
+      :status,
+      :error,
       :consensus,
       :usage,
       :created_at
@@ -44,6 +48,8 @@ module Retab
       @n_consensus = hash[:n_consensus]
       @allow_overlap = hash[:allow_overlap].nil? ? true : hash[:allow_overlap]
       @output = (hash[:output] || []).map { |item| item ? Retab::PartitionChunk.new(item) : nil }
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
       @consensus = hash[:consensus] ? Retab::PartitionConsensus.new(hash[:consensus]) : nil
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
       @created_at = hash[:created_at]

data/lib/retab/partitions/partition_request.rb

@@ -12,7 +12,8 @@ module Retab
       model: :model,
       n_consensus: :n_consensus,
       allow_overlap: :allow_overlap,
-      bust_cache: :bust_cache
+      bust_cache: :bust_cache,
+      background: :background
     }.freeze
 
     attr_accessor(
@@ -22,7 +23,8 @@ module Retab
       :model,
       :n_consensus,
       :allow_overlap,
-      :bust_cache
+      :bust_cache,
+      :background
     )
 
     def initialize(json)
@@ -35,6 +37,7 @@ module Retab
       @n_consensus = hash[:n_consensus]
       @allow_overlap = hash[:allow_overlap].nil? ? true : hash[:allow_overlap]
       @bust_cache = hash[:bust_cache].nil? ? false : hash[:bust_cache]
+      @background = hash[:background].nil? ? false : hash[:background]
     end
   end
 end

data/lib/retab/partitions.rb

@@ -16,6 +16,7 @@ module Retab
     # @param limit [Integer, nil]
     # @param order [Retab::Types::PartitionsOrder, nil]
     # @param filename [String, nil]
+    # @param status [Retab::Types::PartitionsStatus, nil]
     # @param from_date [String, nil]
     # @param to_date [String, nil]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
@@ -26,6 +27,7 @@ module Retab
       limit: 10,
       order: "desc",
       filename: nil,
+      status: nil,
       from_date: nil,
       to_date: nil,
       request_options: {}
@@ -36,6 +38,7 @@ module Retab
         "limit" => limit,
         "order" => order,
         "filename" => filename,
+        "status" => status,
         "from_date" => from_date,
         "to_date" => to_date
       }.compact
@@ -53,6 +56,7 @@ module Retab
           limit: limit,
           order: order,
           filename: filename,
+          status: status,
           from_date: from_date,
           to_date: to_date,
           request_options: request_options
@@ -66,6 +70,7 @@ module Retab
           limit: limit,
           order: order,
           filename: filename,
+          status: status,
           from_date: from_date,
           to_date: to_date
         },
@@ -81,6 +86,7 @@ module Retab
     # @param n_consensus [Integer, nil] Number of partitioning runs to use for consensus voting. Uses deterministic single-pass when set to 1.
     # @param allow_overlap [Boolean, nil] If true, allow a page to appear in more than one partition chunk
     # @param bust_cache [Boolean, nil] If true, skip the LLM cache and force a fresh completion
+    # @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::Partition]
     def create(
@@ -91,6 +97,7 @@ module Retab
       n_consensus: nil,
       allow_overlap: nil,
       bust_cache: nil,
+      background: nil,
       request_options: {}
     )
       document = Retab::MimeData.coerce(document) unless document.nil?
@@ -101,7 +108,8 @@ module Retab
         "model" => model,
         "n_consensus" => n_consensus,
         "allow_overlap" => allow_overlap,
-        "bust_cache" => bust_cache
+        "bust_cache" => bust_cache,
+        "background" => background
       }.compact
       response = @client.request(
         method: :post,
@@ -121,16 +129,22 @@ module Retab
 
     # Get Partition
     # @param partition_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.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::Partition]
     def get(
       partition_id:,
+      include_output: true,
       request_options: {}
     )
+      params = {
+        "include_output" => include_output
+      }.compact
       response = @client.request(
         method: :get,
         path: "/v1/partitions/#{Retab::Util.encode_path(partition_id)}",
         auth: true,
+        params: params,
         request_options: request_options
       )
       result = Retab::Partition.new(response.body)
@@ -158,5 +172,28 @@ module Retab
       )
       nil
     end
+
+    # Cancel Partition
+    # @param partition_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Partition]
+    def create_partition_cancel(
+      partition_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/partitions/#{Retab::Util.encode_path(partition_id)}/cancel",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::Partition.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
   end
 end

data/lib/retab/splits/split.rb

@@ -13,6 +13,8 @@ module Retab
       n_consensus: :n_consensus,
       instructions: :instructions,
       output: :output,
+      status: :status,
+      error: :error,
       consensus: :consensus,
       usage: :usage,
       created_at: :created_at
@@ -26,6 +28,8 @@ module Retab
       :n_consensus,
       :instructions,
       :output,
+      :status,
+      :error,
       :consensus,
       :usage,
       :created_at
@@ -41,6 +45,8 @@ module Retab
       @n_consensus = hash[:n_consensus]
       @instructions = hash[:instructions]
       @output = (hash[:output] || []).map { |item| item ? Retab::SplitResult.new(item) : nil }
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
       @consensus = hash[:consensus] ? Retab::SplitConsensus.new(hash[:consensus]) : nil
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
       @created_at = hash[:created_at]

data/lib/retab/splits/split_request.rb

@@ -11,7 +11,8 @@ module Retab
       model: :model,
       instructions: :instructions,
       n_consensus: :n_consensus,
-      bust_cache: :bust_cache
+      bust_cache: :bust_cache,
+      background: :background
     }.freeze
 
     attr_accessor(
@@ -20,7 +21,8 @@ module Retab
       :model,
       :instructions,
       :n_consensus,
-      :bust_cache
+      :bust_cache,
+      :background
     )
 
     def initialize(json)
@@ -32,6 +34,7 @@ module Retab
       @instructions = hash[:instructions]
       @n_consensus = hash[:n_consensus]
       @bust_cache = hash[:bust_cache].nil? ? false : hash[:bust_cache]
+      @background = hash[:background].nil? ? false : hash[:background]
     end
   end
 end

data/lib/retab/splits.rb

@@ -16,6 +16,7 @@ module Retab
     # @param limit [Integer, nil]
     # @param order [Retab::Types::SplitsOrder, nil]
     # @param filename [String, nil]
+    # @param status [Retab::Types::SplitsStatus, nil]
     # @param from_date [String, nil]
     # @param to_date [String, nil]
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
@@ -26,6 +27,7 @@ module Retab
       limit: 10,
       order: "desc",
       filename: nil,
+      status: nil,
       from_date: nil,
       to_date: nil,
       request_options: {}
@@ -36,6 +38,7 @@ module Retab
         "limit" => limit,
         "order" => order,
         "filename" => filename,
+        "status" => status,
         "from_date" => from_date,
         "to_date" => to_date
       }.compact
@@ -53,6 +56,7 @@ module Retab
           limit: limit,
           order: order,
           filename: filename,
+          status: status,
           from_date: from_date,
           to_date: to_date,
           request_options: request_options
@@ -66,6 +70,7 @@ module Retab
           limit: limit,
           order: order,
           filename: filename,
+          status: status,
           from_date: from_date,
           to_date: to_date
         },
@@ -80,6 +85,7 @@ module Retab
     # @param instructions [String, nil] Free-form instructions appended to the system prompt to steer the split.
     # @param n_consensus [Integer, nil] Number of consensus split runs to perform. Uses deterministic single-pass when set to 1.
     # @param bust_cache [Boolean, nil] If true, skip the LLM cache and force a fresh completion
+    # @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::Split]
     def create(
@@ -89,6 +95,7 @@ module Retab
       instructions: nil,
       n_consensus: nil,
       bust_cache: nil,
+      background: nil,
       request_options: {}
     )
       document = Retab::MimeData.coerce(document) unless document.nil?
@@ -98,7 +105,8 @@ module Retab
         "model" => model,
         "instructions" => instructions,
         "n_consensus" => n_consensus,
-        "bust_cache" => bust_cache
+        "bust_cache" => bust_cache,
+        "background" => background
       }.compact
       response = @client.request(
         method: :post,
@@ -118,16 +126,22 @@ module Retab
 
     # Get Split
     # @param split_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.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
     # @return [Retab::Split]
     def get(
       split_id:,
+      include_output: true,
       request_options: {}
     )
+      params = {
+        "include_output" => include_output
+      }.compact
       response = @client.request(
         method: :get,
         path: "/v1/splits/#{Retab::Util.encode_path(split_id)}",
         auth: true,
+        params: params,
         request_options: request_options
       )
       result = Retab::Split.new(response.body)
@@ -155,5 +169,28 @@ module Retab
       )
       nil
     end
+
+    # Cancel Split
+    # @param split_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Split]
+    def create_split_cancel(
+      split_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/splits/#{Retab::Util.encode_path(split_id)}/cancel",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::Split.new(response.body)
+      result.last_response = Retab::Types::ApiResponse.new(
+        http_status: response.code.to_i,
+        http_headers: response.each_header.to_h,
+        request_id: response["x-request-id"]
+      )
+      result
+    end
   end
 end

data/lib/retab/types/{job_status.rb → classification_status.rb}

@@ -4,15 +4,14 @@
 
 module Retab
   module Types
-    class JobStatus
-      VALIDATING = "validating"
+    class ClassificationStatus
+      PENDING = "pending"
       QUEUED = "queued"
       IN_PROGRESS = "in_progress"
       COMPLETED = "completed"
       FAILED = "failed"
       CANCELLED = "cancelled"
-      EXPIRED = "expired"
-      ALL = [VALIDATING, QUEUED, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, EXPIRED].freeze
+      ALL = [PENDING, QUEUED, IN_PROGRESS, COMPLETED, FAILED, CANCELLED].freeze
     end
   end
 end

data/lib/retab/types/classification_workflow_artifact_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    ClassificationWorkflowArtifactStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/{supported_endpoint.rb → classifications_status.rb}

@@ -4,6 +4,6 @@
 
 module Retab
   module Types
-    SupportedEndpoint = CreateJobRequestEndpoint
+    ClassificationsStatus = ClassificationStatus
   end
 end

data/lib/retab/types/{jobs_order.rb → edit_status.rb}

@@ -4,6 +4,6 @@
 
 module Retab
   module Types
-    JobsOrder = ClassificationsOrder
+    EditStatus = ClassificationStatus
   end
 end

data/lib/retab/types/edit_workflow_artifact_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    EditWorkflowArtifactStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/{jobs_status.rb → edits_status.rb}

@@ -4,6 +4,6 @@
 
 module Retab
   module Types
-    JobsStatus = JobStatus
+    EditsStatus = ClassificationStatus
   end
 end

data/lib/retab/types/{jobs_endpoint.rb → extraction_status.rb}

@@ -4,6 +4,6 @@
 
 module Retab
   module Types
-    JobsEndpoint = CreateJobRequestEndpoint
+    ExtractionStatus = ClassificationStatus
   end
 end

data/lib/retab/types/extraction_workflow_artifact_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    ExtractionWorkflowArtifactStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/extractions_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    ExtractionsStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/parse_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    ParseStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/parse_workflow_artifact_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    ParseWorkflowArtifactStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/partition_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    PartitionStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/partition_workflow_artifact_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    PartitionWorkflowArtifactStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/partitions_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    PartitionsStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/split_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    SplitStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/split_workflow_artifact_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    SplitWorkflowArtifactStatus = ClassificationStatus
+  end
+end

data/lib/retab/types/splits_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    SplitsStatus = ClassificationStatus
+  end
+end

data/lib/retab/workflow_artifacts/classification_workflow_artifact.rb

@@ -13,6 +13,8 @@ module Retab
       n_consensus: :n_consensus,
       instructions: :instructions,
       output: :output,
+      status: :status,
+      error: :error,
       consensus: :consensus,
       usage: :usage,
       created_at: :created_at,
@@ -27,6 +29,8 @@ module Retab
       :n_consensus,
       :instructions,
       :output,
+      :status,
+      :error,
       :consensus,
       :usage,
       :created_at,
@@ -43,6 +47,8 @@ module Retab
       @n_consensus = hash[:n_consensus]
       @instructions = hash[:instructions]
       @output = hash[:output] ? Retab::ClassificationDecision.new(hash[:output]) : nil
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
       @consensus = hash[:consensus] ? Retab::ClassificationConsensus.new(hash[:consensus]) : nil
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
       @created_at = hash[:created_at]

data/lib/retab/workflow_artifacts/edit_workflow_artifact.rb

@@ -13,6 +13,8 @@ module Retab
       config: :config,
       template_id: :template_id,
       output: :output,
+      status: :status,
+      error: :error,
       filled_document_ref: :filled_document_ref,
       usage: :usage,
       created_at: :created_at,
@@ -27,6 +29,8 @@ module Retab
       :config,
       :template_id,
       :output,
+      :status,
+      :error,
       :filled_document_ref,
       :usage,
       :created_at,
@@ -43,6 +47,8 @@ module Retab
       @config = hash[:config] ? Retab::EditConfig.new(hash[:config]) : nil
       @template_id = hash[:template_id]
       @output = hash[:output] ? Retab::EditResult.new(hash[:output]) : nil
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
       @filled_document_ref = hash[:filled_document_ref] ? Retab::FileRef.new(hash[:filled_document_ref]) : nil
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
       @created_at = hash[:created_at]

data/lib/retab/workflow_artifacts/extraction_workflow_artifact.rb

@@ -14,6 +14,8 @@ module Retab
       image_resolution_dpi: :image_resolution_dpi,
       instructions: :instructions,
       output: :output,
+      status: :status,
+      error: :error,
       consensus: :consensus,
       metadata: :metadata,
       usage: :usage,
@@ -30,6 +32,8 @@ module Retab
       :image_resolution_dpi,
       :instructions,
       :output,
+      :status,
+      :error,
       :consensus,
       :metadata,
       :usage,
@@ -48,6 +52,8 @@ module Retab
       @image_resolution_dpi = hash[:image_resolution_dpi]
       @instructions = hash[:instructions]
       @output = hash[:output] || {}
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
       @consensus = hash[:consensus] ? Retab::ExtractionConsensus.new(hash[:consensus]) : nil
       @metadata = hash[:metadata] || {}
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil

data/lib/retab/workflow_artifacts/parse_workflow_artifact.rb

@@ -13,6 +13,8 @@ module Retab
       image_resolution_dpi: :image_resolution_dpi,
       instructions: :instructions,
       output: :output,
+      status: :status,
+      error: :error,
       usage: :usage,
       created_at: :created_at,
       operation: :operation
@@ -26,6 +28,8 @@ module Retab
       :image_resolution_dpi,
       :instructions,
       :output,
+      :status,
+      :error,
       :usage,
       :created_at,
       :operation
@@ -41,6 +45,8 @@ module Retab
       @image_resolution_dpi = hash[:image_resolution_dpi]
       @instructions = hash[:instructions]
       @output = hash[:output] ? Retab::ParseOutput.new(hash[:output]) : nil
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
       @created_at = hash[:created_at]
       @operation = hash[:operation].nil? ? "parse" : hash[:operation]

data/lib/retab/workflow_artifacts/partition_workflow_artifact.rb

@@ -14,6 +14,8 @@ module Retab
       n_consensus: :n_consensus,
       allow_overlap: :allow_overlap,
       output: :output,
+      status: :status,
+      error: :error,
       consensus: :consensus,
       usage: :usage,
       created_at: :created_at,
@@ -29,6 +31,8 @@ module Retab
       :n_consensus,
       :allow_overlap,
       :output,
+      :status,
+      :error,
       :consensus,
       :usage,
       :created_at,
@@ -46,6 +50,8 @@ module Retab
       @n_consensus = hash[:n_consensus]
       @allow_overlap = hash[:allow_overlap].nil? ? true : hash[:allow_overlap]
       @output = (hash[:output] || []).map { |item| item ? Retab::PartitionChunk.new(item) : nil }
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
       @consensus = hash[:consensus] ? Retab::PartitionConsensus.new(hash[:consensus]) : nil
       @usage = hash[:usage] ? Retab::RetabUsage.new(hash[:usage]) : nil
       @created_at = hash[:created_at]