retab 0.1.4 → 0.1.6

data/lib/retab/files.rb

@@ -88,6 +88,94 @@ module Retab
       )
     end
 
+    # 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 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,
+      background: nil,
+      request_options: {}
+    )
+      body = {
+        "file_id" => file_id,
+        "mode" => mode,
+        "intent" => intent,
+        "background" => background
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/v1/files/blueprints",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      result = Retab::FileBlueprint.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
+
+    # Get File Blueprint
+    # @param blueprint_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::FileBlueprint]
+    def get_blueprint(
+      blueprint_id:,
+      include_output: true,
+      request_options: {}
+    )
+      params = {
+        "include_output" => include_output
+      }.compact
+      response = @client.request(
+        method: :get,
+        path: "/v1/files/blueprints/#{Retab::Util.encode_path(blueprint_id)}",
+        auth: true,
+        params: params,
+        request_options: request_options
+      )
+      result = Retab::FileBlueprint.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
+
+    # Cancel File Blueprint
+    # @param blueprint_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::FileBlueprint]
+    def create_blueprint_cancel(
+      blueprint_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/files/blueprints/#{Retab::Util.encode_path(blueprint_id)}/cancel",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::FileBlueprint.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
+
     # Upload File
     # @param filename [String] Filename to store
     # @param content_type [String, nil] MIME type the client will upload

data/lib/retab/parses/parse.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
     }.freeze
@@ -25,6 +27,8 @@ module Retab
       :image_resolution_dpi,
       :instructions,
       :output,
+      :status,
+      :error,
       :usage,
       :created_at
     )
@@ -39,6 +43,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]
     end

data/lib/retab/parses/parse_request.rb

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

data/lib/retab/parses.rb

@@ -80,6 +80,7 @@ module Retab
     # @param image_resolution_dpi [Integer, nil] DPI used when rasterizing pages for the parser
     # @param instructions [String, nil] Free-form instructions appended to the system prompt to steer the parse.
     # @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::Parse]
     def create(
@@ -89,6 +90,7 @@ module Retab
       image_resolution_dpi: nil,
       instructions: nil,
       bust_cache: nil,
+      background: nil,
       request_options: {}
     )
       document = Retab::MimeData.coerce(document) unless document.nil?
@@ -98,7 +100,8 @@ module Retab
         "table_parsing_format" => table_parsing_format,
         "image_resolution_dpi" => image_resolution_dpi,
         "instructions" => instructions,
-        "bust_cache" => bust_cache
+        "bust_cache" => bust_cache,
+        "background" => background
       }.compact
       response = @client.request(
         method: :post,
@@ -118,16 +121,22 @@ module Retab
 
     # Get Parse
     # @param parse_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::Parse]
     def get(
       parse_id:,
+      include_output: true,
       request_options: {}
     )
+      params = {
+        "include_output" => include_output
+      }.compact
       response = @client.request(
         method: :get,
         path: "/v1/parses/#{Retab::Util.encode_path(parse_id)}",
         auth: true,
+        params: params,
         request_options: request_options
       )
       result = Retab::Parse.new(response.body)
@@ -155,5 +164,28 @@ module Retab
       )
       nil
     end
+
+    # Cancel Parse
+    # @param parse_id [String]
+    # @param request_options [Hash] (see Retab::Types::RequestOptions)
+    # @return [Retab::Parse]
+    def cancel(
+      parse_id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :post,
+        path: "/v1/parses/#{Retab::Util.encode_path(parse_id)}/cancel",
+        auth: true,
+        request_options: request_options
+      )
+      result = Retab::Parse.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/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/schemas/generate_schema_request.rb

@@ -10,7 +10,7 @@ module Retab
       model: :model,
       instructions: :instructions,
       image_resolution_dpi: :image_resolution_dpi,
-      stream: :stream
+      background: :background
     }.freeze
 
     attr_accessor(
@@ -18,7 +18,7 @@ module Retab
       :model,
       :instructions,
       :image_resolution_dpi,
-      :stream
+      :background
     )
 
     def initialize(json)
@@ -28,7 +28,7 @@ module Retab
       @model = hash[:model].nil? ? "retab-small" : hash[:model]
       @instructions = hash[:instructions]
       @image_resolution_dpi = hash[:image_resolution_dpi]
-      @stream = hash[:stream].nil? ? false : hash[:stream]
+      @background = hash[:background].nil? ? false : hash[:background]
     end
   end
 end

data/lib/retab/schemas/{partial_schema.rb → schema_generation.rb}

@@ -3,20 +3,26 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  class PartialSchema < Retab::Types::BaseModel
+  class SchemaGeneration < Retab::Types::BaseModel
 
     HASH_ATTRS = {
       object: :object,
       created_at: :created_at,
       json_schema: :json_schema,
-      strict: :strict
+      strict: :strict,
+      id: :id,
+      status: :status,
+      error: :error
     }.freeze
 
     attr_accessor(
       :object,
       :created_at,
       :json_schema,
-      :strict
+      :strict,
+      :id,
+      :status,
+      :error
     )
 
     def initialize(json)
@@ -26,6 +32,9 @@ module Retab
       @created_at = hash[:created_at]
       @json_schema = hash[:json_schema] || {}
       @strict = hash[:strict].nil? ? true : hash[:strict]
+      @id = hash[:id]
+      @status = hash[:status].nil? ? "pending" : hash[:status]
+      @error = hash[:error] ? Retab::PrimitiveError.new(hash[:error]) : nil
     end
   end
 end

data/lib/retab/schemas.rb

@@ -15,15 +15,15 @@ module Retab
     # @param model [String, nil]
     # @param instructions [String, nil]
     # @param image_resolution_dpi [Integer, nil] Resolution of the image sent to the LLM
-    # @param stream [Boolean, nil]
+    # @param background [Boolean, nil] If true, run asynchronously: returns immediately with status 'queued'. Poll GET /v1/schemas/generate/{schema_generation_id} until status is terminal.
     # @param request_options [Hash] (see Retab::Types::RequestOptions)
-    # @return [Retab::PartialSchema]
+    # @return [Retab::SchemaGeneration]
     def generate(
       documents:,
       model: nil,
       instructions: nil,
       image_resolution_dpi: nil,
-      stream: nil,
+      background: nil,
       request_options: {}
     )
       documents = documents.map { |d| Retab::MimeData.coerce(d) } unless documents.nil?
@@ -32,7 +32,7 @@ module Retab
         "model" => model,
         "instructions" => instructions,
         "image_resolution_dpi" => image_resolution_dpi,
-        "stream" => stream
+        "background" => background
       }.compact
       response = @client.request(
         method: :post,
@@ -41,7 +41,7 @@ module Retab
         body: body,
         request_options: request_options
       )
-      result = Retab::PartialSchema.new(response.body)
+      result = Retab::SchemaGeneration.new(response.body)
       result.last_response = Retab::Types::ApiResponse.new(
         http_status: response.code.to_i,
         http_headers: response.each_header.to_h,

data/lib/retab/{jobs/job_response.rb → secrets/create_secret_request.rb}

@@ -3,23 +3,23 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module Retab
-  class JobResponse < Retab::Types::BaseModel
+  class CreateSecretRequest < Retab::Types::BaseModel
 
     HASH_ATTRS = {
-      status_code: :status_code,
-      body: :body
+      name: :name,
+      value: :value
     }.freeze
 
     attr_accessor(
-      :status_code,
-      :body
+      :name,
+      :value
     )
 
     def initialize(json)
       super()
       hash = self.class.normalize(json)
-      @status_code = hash[:status_code]
-      @body = hash[:body] || {}
+      @name = hash[:name]
+      @value = hash[:value]
     end
   end
 end

data/lib/retab/secrets/secret.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class Secret < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      name: :name,
+      created_at: :created_at,
+      updated_at: :updated_at,
+      created_by: :created_by,
+      updated_by: :updated_by
+    }.freeze
+
+    attr_accessor(
+      :name,
+      :created_at,
+      :updated_at,
+      :created_by,
+      :updated_by
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @name = hash[:name]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @created_by = hash[:created_by]
+      @updated_by = hash[:updated_by]
+    end
+  end
+end

data/lib/retab/secrets/secret_list_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class SecretListResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      secrets: :secrets
+    }.freeze
+
+    attr_accessor :secrets
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @secrets = (hash[:secrets] || []).map { |item| item ? Retab::Secret.new(item) : nil }
+    end
+  end
+end

data/lib/retab/secrets/secret_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class SecretResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      secret: :secret
+    }.freeze
+
+    attr_accessor :secret
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @secret = hash[:secret] ? Retab::Secret.new(hash[:secret]) : nil
+    end
+  end
+end

data/lib/retab/secrets/secret_value.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class SecretValue < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      name: :name,
+      value: :value,
+      updated_at: :updated_at
+    }.freeze
+
+    attr_accessor(
+      :name,
+      :value,
+      :updated_at
+    )
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @name = hash[:name]
+      @value = hash[:value]
+      @updated_at = hash[:updated_at]
+    end
+  end
+end

data/lib/retab/secrets/secret_value_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class SecretValueResponse < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      secret: :secret
+    }.freeze
+
+    attr_accessor :secret
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @secret = hash[:secret] ? Retab::SecretValue.new(hash[:secret]) : nil
+    end
+  end
+end

data/lib/retab/secrets/set_secret_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module Retab
+  class SetSecretRequest < Retab::Types::BaseModel
+
+    HASH_ATTRS = {
+      value: :value
+    }.freeze
+
+    attr_accessor :value
+
+    def initialize(json)
+      super()
+      hash = self.class.normalize(json)
+      @value = hash[:value]
+    end
+  end
+end