retab 0.1.3 → 0.1.5

data/lib/retab/schemas.rb

@@ -13,7 +13,6 @@ module Retab
     # Generate Schema From Examples
     # @param documents [Array<Retab::MimeData, Pathname, IO, String, Hash>]
     # @param model [String, nil]
-    # @param reasoning_effort [Retab::Types::GenerateSchemaRequestReasoningEffort, nil]
     # @param instructions [String, nil]
     # @param image_resolution_dpi [Integer, nil] Resolution of the image sent to the LLM
     # @param stream [Boolean, nil]
@@ -22,7 +21,6 @@ module Retab
     def generate(
       documents:,
       model: nil,
-      reasoning_effort: nil,
       instructions: nil,
       image_resolution_dpi: nil,
       stream: nil,
@@ -32,7 +30,6 @@ module Retab
       body = {
         "documents" => documents,
         "model" => model,
-        "reasoning_effort" => reasoning_effort,
         "instructions" => instructions,
         "image_resolution_dpi" => image_resolution_dpi,
         "stream" => stream

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)
@@ -28,10 +30,11 @@ module Retab
       hash = self.class.normalize(json)
       @document = hash[:document] ? Retab::MimeData.new(hash[:document]) : nil
       @subdocuments = (hash[:subdocuments] || []).map { |item| item ? Retab::Subdocument.new(item) : nil }
-      @model = hash[:model]
+      @model = hash[:model].nil? ? "retab-small" : hash[:model]
       @instructions = hash[:instructions]
       @n_consensus = hash[:n_consensus]
-      @bust_cache = hash[:bust_cache]
+      @bust_cache = hash[:bust_cache].nil? ? false : hash[:bust_cache]
+      @background = hash[:background].nil? ? false : hash[:background]
     end
   end
 end

data/lib/retab/splits/subdocument.rb

@@ -21,8 +21,8 @@ module Retab
       super()
       hash = self.class.normalize(json)
       @name = hash[:name]
-      @description = hash[:description]
-      @allow_multiple_instances = hash[:allow_multiple_instances]
+      @description = hash[:description].nil? ? "" : hash[:description]
+      @allow_multiple_instances = hash[:allow_multiple_instances].nil? ? false : hash[:allow_multiple_instances]
     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/types/trigger_info_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  module Types
+    class TriggerInfoType
+      MANUAL = "manual"
+      API = "api"
+      SCHEDULE = "schedule"
+      WEBHOOK = "webhook"
+      EMAIL = "email"
+      CUSTOM = "custom"
+      RESTART = "restart"
+      ALL = [MANUAL, API, SCHEDULE, WEBHOOK, EMAIL, CUSTOM, RESTART].freeze
+    end
+  end
+end

data/lib/retab/types/{workflow_export_payload_request_trigger_types.rb → workflow_export_payload_request_trigger_type.rb}

@@ -4,7 +4,7 @@
 
 module Retab
   module Types
-    class WorkflowExportPayloadRequestTriggerTypes
+    class WorkflowExportPayloadRequestTriggerType
       MANUAL = "manual"
       API = "api"
       SCHEDULE = "schedule"

data/lib/retab/types/workflow_runs_trigger_type.rb

@@ -4,6 +4,6 @@
 
 module Retab
   module Types
-    WorkflowRunsTriggerType = WorkflowExportPayloadRequestTriggerTypes
+    WorkflowRunsTriggerType = WorkflowExportPayloadRequestTriggerType
   end
 end

data/lib/retab/workflow_artifacts/api_call_invocation.rb

@@ -8,7 +8,7 @@ module Retab
     HASH_ATTRS = {
       operation: :operation,
       id: :id,
-      workflow_run_id: :workflow_run_id,
+      run_id: :run_id,
       step_id: :step_id,
       attempts: :attempts,
       error: :error,
@@ -18,7 +18,7 @@ module Retab
     attr_accessor(
       :operation,
       :id,
-      :workflow_run_id,
+      :run_id,
       :step_id,
       :attempts,
       :error,
@@ -28,9 +28,9 @@ module Retab
     def initialize(json)
       super()
       hash = self.class.normalize(json)
-      @operation = hash[:operation]
+      @operation = hash[:operation].nil? ? "api_call_invocation" : hash[:operation]
       @id = hash[:id]
-      @workflow_run_id = hash[:workflow_run_id]
+      @run_id = hash[:run_id]
       @step_id = hash[:step_id]
       @attempts = (hash[:attempts] || []).map { |item| item ? Retab::ApiCallAttempt.new(item) : nil }
       @error = hash[:error] ? Retab::ErrorDetails.new(hash[:error]) : nil

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,10 +47,12 @@ 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]
-      @operation = hash[:operation]
+      @operation = hash[:operation].nil? ? "classification" : hash[:operation]
     end
   end
 end

data/lib/retab/workflow_artifacts/condition_evaluation_details.rb

@@ -11,7 +11,7 @@ module Retab
       expected: :expected,
       actual: :actual,
       matched: :matched,
-      per_item: :per_item,
+      items: :items,
       sub_conditions: :sub_conditions,
       logical_operator: :logical_operator
     }.freeze
@@ -22,7 +22,7 @@ module Retab
       :expected,
       :actual,
       :matched,
-      :per_item,
+      :items,
       :sub_conditions,
       :logical_operator
     )
@@ -30,12 +30,12 @@ module Retab
     def initialize(json)
       super()
       hash = self.class.normalize(json)
-      @path = hash[:path]
-      @operator = hash[:operator]
+      @path = hash[:path].nil? ? "" : hash[:path]
+      @operator = hash[:operator].nil? ? "" : hash[:operator]
       @expected = hash[:expected]
       @actual = hash[:actual]
-      @matched = hash[:matched]
-      @per_item = (hash[:per_item] || []).map { |item| item ? Retab::ConditionEvaluationPerItem.new(item) : nil }
+      @matched = hash[:matched].nil? ? false : hash[:matched]
+      @items = (hash[:items] || []).map { |item| item ? Retab::ConditionEvaluationPerItem.new(item) : nil }
       @sub_conditions = (hash[:sub_conditions] || []).map { |item|
         item ? Retab::ConditionEvaluationSubCondition.new(item) : nil
       }

data/lib/retab/workflow_artifacts/condition_evaluation_per_item.rb

@@ -25,7 +25,7 @@ module Retab
       @index = hash[:index]
       @indices = (hash[:indices] || [])
       @actual = hash[:actual]
-      @matched = hash[:matched]
+      @matched = hash[:matched].nil? ? false : hash[:matched]
     end
   end
 end

data/lib/retab/workflow_artifacts/condition_evaluation_result.rb

@@ -14,7 +14,7 @@ module Retab
       matched: :matched,
       branch_name: :branch_name,
       logical_operator: :logical_operator,
-      per_item: :per_item,
+      items: :items,
       sub_evaluations: :sub_evaluations,
       details: :details
     }.freeze
@@ -28,7 +28,7 @@ module Retab
       :matched,
       :branch_name,
       :logical_operator,
-      :per_item,
+      :items,
       :sub_evaluations,
       :details
     )
@@ -37,14 +37,14 @@ module Retab
       super()
       hash = self.class.normalize(json)
       @condition_id = hash[:condition_id]
-      @path = hash[:path]
-      @operator = hash[:operator]
+      @path = hash[:path].nil? ? "" : hash[:path]
+      @operator = hash[:operator].nil? ? "" : hash[:operator]
       @expected = hash[:expected]
       @actual = hash[:actual]
-      @matched = hash[:matched]
-      @branch_name = hash[:branch_name]
+      @matched = hash[:matched].nil? ? false : hash[:matched]
+      @branch_name = hash[:branch_name].nil? ? "exit" : hash[:branch_name]
       @logical_operator = hash[:logical_operator]
-      @per_item = (hash[:per_item] || []).map { |item| item ? Retab::ConditionEvaluationPerItem.new(item) : nil }
+      @items = (hash[:items] || []).map { |item| item ? Retab::ConditionEvaluationPerItem.new(item) : nil }
       @sub_evaluations = (hash[:sub_evaluations] || []).map { |item|
         item ? Retab::ConditionEvaluationSubCondition.new(item) : nil
       }

data/lib/retab/workflow_artifacts/condition_evaluation_sub_condition.rb

@@ -12,7 +12,7 @@ module Retab
       expected: :expected,
       actual: :actual,
       matched: :matched,
-      per_item: :per_item
+      items: :items
     }.freeze
 
     attr_accessor(
@@ -22,19 +22,19 @@ module Retab
       :expected,
       :actual,
       :matched,
-      :per_item
+      :items
     )
 
     def initialize(json)
       super()
       hash = self.class.normalize(json)
       @sub_condition_id = hash[:sub_condition_id]
-      @path = hash[:path]
-      @operator = hash[:operator]
+      @path = hash[:path].nil? ? "" : hash[:path]
+      @operator = hash[:operator].nil? ? "" : hash[:operator]
       @expected = hash[:expected]
       @actual = hash[:actual]
-      @matched = hash[:matched]
-      @per_item = (hash[:per_item] || []).map { |item| item ? Retab::ConditionEvaluationPerItem.new(item) : nil }
+      @matched = hash[:matched].nil? ? false : hash[:matched]
+      @items = (hash[:items] || []).map { |item| item ? Retab::ConditionEvaluationPerItem.new(item) : nil }
     end
   end
 end

data/lib/retab/workflow_artifacts/conditional_evaluation.rb

@@ -8,7 +8,7 @@ module Retab
     HASH_ATTRS = {
       operation: :operation,
       id: :id,
-      workflow_run_id: :workflow_run_id,
+      run_id: :run_id,
       step_id: :step_id,
       evaluations: :evaluations,
       selected_handles: :selected_handles,
@@ -20,7 +20,7 @@ module Retab
     attr_accessor(
       :operation,
       :id,
-      :workflow_run_id,
+      :run_id,
       :step_id,
       :evaluations,
       :selected_handles,
@@ -32,9 +32,9 @@ module Retab
     def initialize(json)
       super()
       hash = self.class.normalize(json)
-      @operation = hash[:operation]
+      @operation = hash[:operation].nil? ? "conditional_evaluation" : hash[:operation]
       @id = hash[:id]
-      @workflow_run_id = hash[:workflow_run_id]
+      @run_id = hash[:run_id]
       @step_id = hash[:step_id]
       @evaluations = (hash[:evaluations] || []).map { |item| item ? Retab::ConditionEvaluationResult.new(item) : nil }
       @selected_handles = (hash[:selected_handles] || [])